Rewrite to not mutate given node #1
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
...and other changes: * Rewrite module to not mutate the given node, previously, slugs were added and the contents of the previous TOC (the nodes between the heading and the first heading in TOC were removed). * Remove dependency on `remark`, `remark-slug`; * Update `example.js`, usage section; * Add description of what is returned; * Fix different return values; * Remove an initial space character throughout `list`, `list-item`, and `insert`; * Fix bundle name: `remarkTOC` > `mdastUtilTOC`; * Rewrite tests to assert results of this module only.
This comment has been minimized.
This comment has been minimized.
|
Fantastic. That is a significant improvement on my attempt The test output makes so much more sense as the actual output of the method... |
|
I know, getting into unified/unist/remark/mdast, and whatnot, is a pretty daunting task. If you have any particular points which were hard to grasp, I’d love to hear about them! |
wooorm
added
⛵️ status/released
🗄 area/interface
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
...and other changes:
previously, slugs were added and the contents
of the previous TOC (the nodes between the heading
and the first heading in TOC were removed).
remark,remark-slug;example.js, usage section;list,list-item, andinsert;remarkTOC>mdastUtilTOC;/cc @BarryThePenguin I’d love to hear what you think about these changes. I believe it makes for a more solid approach, but if you don’t agree (on some parts), do let me know. Also: I’d gladly answer any question you might have. Last: This does include some breaking changes, I suggest releasing 2.0.0