[chore] Improve check/fix make targets #787
Merged
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.
Changes
I often run into a problem where I modify a markdown and forget to update the TOC, and then the PR fails. My flow is:
make check
But I noticed that
make check
does not include the TOC target which makes it not so useful.It's unfortunate, but today, the toc library does not offer a "check" or "dry-run" feature (there's a PR open jonschlinkert/markdown-toc#148), so the only way to check is to execute it, and verify if there's any pending changes using git, which is exactly what we do in CI today.
I propose that we add the same thing to
make check
so at least I know locally that I'm missing something and need to commit. I also addedmarkdown-toc
tofix
even though it will already be fixed withmake check
. I know it isn't great, but at least me personally, prefer this over waiting for a PR to fail and then having to push again.Note: Also I found out that prettier is formatting the CONTRIBUTING.md with
-
bullet points, wheremarkdown-toc
uses*
by default. So I also changed that and that's why all the modified files (sorry)Merge requirement checklist
[chore]