Update markdown lint #1006
Update markdown lint #1006
Conversation
✅ Deploy Preview for all-contributors ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
JoshuaKGoldberg
left a comment
JoshuaKGoldberg
left a comment
There was a problem hiding this comment.
✨ LGTM other than the one note on README.md linting.
package.json
Outdated
| "lint": "markdownlint **/*.{md,mdx} --ignore node_modules", | ||
| "lint-fix": "markdownlint **/*.{md,mdx} --ignore node_modules --fix" | ||
| "lint": "markdownlint src/**/*.{md,mdx} --ignore node_modules", | ||
| "lint-fix": "markdownlint src/**/*.{md,mdx} --ignore node_modules --fix" |
There was a problem hiding this comment.
This now excludes the root README.md. Is that intentional?
If this was to avoid formatting MAINTAINERS.md, I'd suggest moving the --ignore to a .markdownlintignore.
There was a problem hiding this comment.
Good idea, that way we keep the ignores together and explicit.
I was thinking about excluding anything not in the docs from linting. But there isn't any harm in including other files in the repo that pass.
I've kept MAINTAINERS.md excluded. But we could take time to fix that too.
| "lint": "markdownlint **/*.{md,mdx} --ignore node_modules", | ||
| "lint-fix": "markdownlint **/*.{md,mdx} --ignore node_modules --fix" | ||
| "lint": "markdownlint **/*.{md,mdx}", | ||
| "lint-fix": "markdownlint **/*.{md,mdx}" |
There was a problem hiding this comment.
ooh I know this was merge but @JimMadge does this need to have --fix to be different from the lint step and to actually apply the fixes? lint and lint-fix look the same .
3 participants
supersedes #972 and #984
Updates packages and fixes errors that came with a newer version of Markdown Lint CLI.