make linting easier #2094
Merged
make linting easier #2094
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
ross-p-smith
approved these changes
Jun 22, 2022
|
/test-force-approve |
|
🤖 pr-bot 🤖 ✅ Marking tests as complete (for commit 4fb89fb) (in response to this comment from @ross-p-smith) |
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.
This is a small PR that makes local linting slightly easier, with a specific use case for linting the docs.
The
Makefileallows you to override which files to include in the linting run. This is a regular expression, so it's possible to go wild on this, but the most obvious use case is to restrict the linting to a given folder, or a given file extension, or both.Included in the
Makefileis a use case that I will be using a lot.make lint-docssets the regular expression and then runs the regularmake lint. This allows us to locally check that the markdown will pass superlinter checks in the PR builds.