chore: use markdownlint-cli2 directly for linting Markdown #42192
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
codebytere
approved these changes
May 15, 2024
jkleinsc
approved these changes
May 15, 2024
|
No Release Notes |
|
@dsanders11, this is so cool! :) |
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 of Change
After #42078, we can use
markdownlint-cli2directly instead of theelectron-markdownlintwrapper provided by@electron/lint-roller, which will be dropped in a future release.This change means our custom rules will be picked up by the VS Code extension for
markdownlintand show errors in the editor, providing better DX.The name change for
.markdownlint.autofix.jsonrequired a larger change due to constraintsmarkdownlint-cli2puts on config filenames (needed to end in.markdownlint-cli2.jsonc).Checklist
Release Notes
Notes: none