Migrate markdownlint-cli to markdownlint-cli2 (single config file)#487
Merged
Conversation
Consolidate the Markdown lint configuration (.markdownlint.json rules, .markdownlintignore excludes, and the '**/*.md' npm-script glob) into a single .markdownlint-cli2.jsonc (config + globs + ignores), and remove the two old files. Script names are unchanged, so the compound test/fix scripts and the CI step (npm run --silent markdownlint) need no change. For consistency with FreshRSS/FreshRSS#8987.
3 tasks
- Reduce obvious comments in .markdownlint-cli2.jsonc (keep only the
non-obvious note on globs)
- Add JSONC to .editorconfig ([*.json] -> [*.{json,jsonc}])
Contributor
Author
|
@Alkarex applied your review changes from FreshRSS/FreshRSS#8987 here as well:
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What
Migrate the Markdown linter from
markdownlint-clitomarkdownlint-cli2, and consolidate its configuration into a single file.Previously the setup was spread across three places:
.markdownlint.json— rules.markdownlintignore— excluded paths'**/*.md'glob argument in the npm scriptsThese are now merged into one
.markdownlint-cli2.jsonc(config+globs+ignores), and the two old files are removed.Why
For consistency with the same migration in the main repository, FreshRSS/FreshRSS#8987. As requested by @Alkarex there:
Details
package.json:markdownlint-cli@^0.49.0→markdownlint-cli2@^0.23.0; themarkdownlint/markdownlint_fixscripts now callmarkdownlint-cli2/markdownlint-cli2 --fix.test/fixcompound scripts and thenpm run --silent markdownlintstep in.github/workflows/tests.ymlneed no change.markdownlint-cli2v0.23.0 bundles the same markdownlint v0.41.0 already used bymarkdownlint-cliv0.49.0, so linting behaviour is identical — the suite still finds 16 files and reports 0 errors..markdownlint.json, so no documentation changes are needed.Checklist
npm run markdownlintpasses (0 errors, 16 files;node_modulesand vendored dirs ignored)npm run markdownlint_fixworks (--fix), no Markdown files changed