Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Architecture]: Capture high-level as-is class diagram #1130

Closed
joshbruce opened this issue Mar 4, 2018 · 5 comments
Closed

[Architecture]: Capture high-level as-is class diagram #1130

joshbruce opened this issue Mar 4, 2018 · 5 comments
Assignees
Labels
good first issue Something easy to get started with help wanted

Comments

@joshbruce
Copy link
Member

joshbruce commented Mar 4, 2018

Marked version: 0.3.17

Markdown flavor: n/a

Proposal type: other

What pain point are you perceiving?

  1. The code is difficult to read per 🚧[Experimenting]: Refactoring marked js🚧 #1102.
  2. Feature deprecation strategy #1114 comment from @UziTech recommends "best way" (sorry, knee-jerk reaction whenever someone says "best way" 😆) related to a possible to-be architecture.
  3. Related to vision alignment: [Vision alignment]: Comparative benchmarking - low-level #965
  4. And more...wasn't planning to spend this long writing this... 😝

#1089, #1096, #1097

What solution are you suggesting?

Capture at least a basic (no members or functions necessary) class diagram (like??) model illustrating Marked's current architecture.

Think @intcreator should get first refusal since he seems most passionate about needing an architecture (and architect) to be able to get up to speed in understanding the code easier. I know you said you've only had a couple year's experience with JS but that'll be fine, that's why we have review.

Let us know?? (No harm, no foul.)

@joshbruce joshbruce added help wanted good first issue Something easy to get started with labels Mar 4, 2018
@joshbruce
Copy link
Member Author

Huh? Fascinating.

You can tag two projects now.

Projects is a new-ish feature in GitHub...not sure it's always been able to do that.

Don't think you can do two milestones though.

@joshbruce joshbruce self-assigned this Apr 13, 2018
@snowyu
Copy link

snowyu commented Nov 16, 2018

Use typescript make the Classes and helper functions export more clear and useful.
And make plugins more easy. It is very hard to write plugin for marked currently.
I have to use the kramed to do a simple task with a little patch, see the hacked code front-matter-markdown, The kramed still need to reconstruct too.

Tokenizer, Parser, Render Classes and userful helper functions.

here is a good starter: https://github.com/alexjoverm/typescript-library-starter

@UziTech
Copy link
Member

UziTech commented Nov 16, 2018

If you are looking for marked written in TypeScript you can look at the fork marked-ts

@snowyu
Copy link

snowyu commented Nov 16, 2018

I have read it just now, but it is not pretty code. The RegExp passed everywhere.

@snowyu
Copy link

snowyu commented Nov 16, 2018

The best way should be inherited from a common tokenizer/Lexer, such as Moo Tokenizer Generator or PEG.js.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Something easy to get started with help wanted
Projects
None yet
Development

No branches or pull requests

3 participants