feat: replace markdownlint with prettier Markdown auto-formatting
#123
Conversation
This file contains 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
tk-woven
changed the title
prettier Markdown auto-formatting
This also disables natural language validation since there is no corresponding pre-commit hook. We deem this check non-critical and in its place continue to enforce clear meaning in natural language in code reivews.
tk-woven
force-pushed
the
feat/tyler-kowallis/use-pre-commit-for-linting-3
branch
from
2cdab9d to
51e1fb2
Compare
wadimkehl
approved these changes
Aug 20, 2022
There was a problem hiding this comment.
NICE!
Reviewed 10 of 10 files at r1, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @chrisochoatri and @kuanleetri)
|
Thanks! |
tk-woven
deleted the
feat/tyler-kowallis/use-pre-commit-for-linting-3
branch
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.
Description
This is toward #114 . SuperLinter uses
markdownlintfor linting Markdown. When running the latest version on DGP, I found many violations. Instead of manually requiring conformance to specific style, I replacemarkdownlintwithprettierwhich will auto-format Markdown files for us.I've also disabled the natural language validator since there is no corresponding pre-commit hook for it. I don't think this validator is critical. What's more important is that we enforce clear meaning in prose in code review.
Lastly, I've built the docs locally and glanced over them (rather quickly). Everything seems to be okay still, including the PDF generated by
rinoh.This change is