Scripts: Update lint-md-docs script to use ignore-path
#32633
Merged
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
|
Size Change: 0 B Total Size: 1.04 MB ℹ️ View Unchanged
|
gziolo
added
the
[Type] New API
gziolo
changed the title
lint-md-docs script to use ignore-path
gziolo
approved these changes
Jun 14, 2021
Updates markdown-lint and markdownlint-cli packages. These packages add support for ignore-path parameter to specify a location for the ignore file. Add a default markdownlintignore file to scripts config with build and node_modules as the two default ignores. Matches current script defaults. Updates lint-md-docs script to pass in the new --ignore-path argument and specify the new markdownlintignore file.
gziolo
force-pushed
the
tools/markdown-ignore
branch
from
15420f7
to
a08ec97
Compare
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
Updates markdown-lint and markdownlint-cli packages. These packages add support for ignore-path parameter to specify a location for the ignore file.
Add a default markdownlintignore file to scripts config with build and node_modules as the two default ignores. Matches current script defaults.
Updates lint-md-docs script to pass in the new --ignore-path argument and specify the new markdownlintignore file.
How has this been tested?
npm run lint:md-docsand confirm it does not run inside node_modules directory.packages/scripts/config/.markdownlintignorefile and addpackages/ordocs/and confirm it works.Types of changes
Cleanup task from #19855
The scripts previously did not allow specifying a alternate location for the ignore file, recent package updates added the
--ignore-pathargument. This PR takes adavtage of that update and sets the defaults for ignoringbuild/andnode_modules/to a file instead of inlined.