-
Notifications
You must be signed in to change notification settings - Fork 539
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(lint): refactor Markdown linting to use markdownlint-cli2
This switches from `markdownlint-cli` to `markdownlint-cli2` and drops usage of the https://github.com/avto-dev/markdown-lint GitHub action in CI. - The `avto-dev/markdown-lint` action was using a 4y old version of `markdownlint`. AFAICT that action is not being maintained. - There is a new `npm run lint:markdown` and the `lint.yml` CI workflow uses it. - The switch from `markdownlint-cli` to `markdownlint-cli2` and `.markdownlint-cli2.jsonc` as the config allows using the https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint VSCode plugin for in-editor Markdown lint warnings and intellisense in the config file. Refs: open-telemetry/opentelemetry-js#4713
- Loading branch information
Showing
8 changed files
with
352 additions
and
24 deletions.
There are no files selected for viewing
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
This file was deleted.
Oops, something went wrong.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
// https://github.com/DavidAnson/markdownlint-cli2#markdownlint-cli2jsonc | ||
{ | ||
"config": { | ||
// https://github.com/DavidAnson/markdownlint/blob/main/README.md#rules--aliases | ||
"MD013": false, | ||
"MD024": false, | ||
"MD033": false, | ||
"MD041": false, | ||
"MD012": false, // no-multiple-blanks, common in CHANGELOG.md files | ||
"MD045": false, // XXX no-alt-text | ||
"MD026": false, // XXX drop? | ||
// "MD004": { "style": "dash" } // ul-style | ||
}, | ||
"gitignore": true, | ||
"noBanner": true, | ||
"noProgress": true | ||
} |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.