feat: add option to keep files with no toc inside untouched #181
+19
−6
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
uetchy
changed the title
AndrewSouthpaw
requested changes
Oct 12, 2020
There was a problem hiding this comment.
I'd add some additional printout, clarifying that only existing TOC'ed files will be updated. Maybe here.
Also, I'd suggest a name like --update-existing or --update-only as that may carry more meaning than "preserve".
Thoughts?
add cli flag to prevent doctoc from adding toc to a file without toc. this is good for CI or a combination with lint-staged. with -p, doctoc will update toc if md has toc sectioon, otherwise doctoc keep it unmodified.
|
@AndrewSouthpaw Thank you for the suggestion. |
AndrewSouthpaw
requested changes
Oct 14, 2020
uetchy
commented
Oct 15, 2020
AndrewSouthpaw
approved these changes
Oct 22, 2020
3 tasks
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.
add cli flag to prevent doctoc from adding toc to a file without toc.
this is good for CI or the combination with
lint-staged.with -p, doctoc will update toc if md has toc sectioon, otherwise doctoc keep it unmodified.
I'm not sure
preserveis the right name for it. so please change it if you have a better one.