Adopt shared markdownlint config - #732
Merged
Merged
Conversation
Carry the template's .markdownlint-cli2.jsonc verbatim so the davidanson IDE extension and CLI markdownlint-cli2 apply the same rules, and add jsonc to the .editorconfig JSON glob so the config file is CRLF-governed. Existing docs already pass cleanly (0 errors). Realigns with ptr727/ProjectTemplate. Part of #731.
There was a problem hiding this comment.
Pull request overview
This PR aligns PlexCleaner’s Markdown linting behavior with the shared configuration used by ptr727/ProjectTemplate, ensuring consistent lint results between IDE tooling (markdownlint extension) and CLI/CI usage.
Changes:
- Add a repository-wide
.markdownlint-cli2.jsoncconfiguration to standardize markdownlint rules. - Update
.editorconfigto include*.jsoncin the JSON line-ending rules so the new config file follows CRLF expectations.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
.markdownlint-cli2.jsonc |
Introduces shared markdownlint-cli2 rule configuration (JSONC) for consistent Markdown linting. |
.editorconfig |
Extends the JSON glob to include jsonc, applying CRLF line endings to the new markdownlint config file. |
This was referenced Jun 8, 2026
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
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.
Part of #731 - realign with ptr727/ProjectTemplate.
.markdownlint-cli2.jsoncverbatim so the davidansonmarkdownlintIDE extension and CLI/CImarkdownlint-cli2apply the same rules.jsoncto the.editorconfig[*.{json,jsonc}]glob so the config file is CRLF-governed.Existing docs already pass cleanly under the shared config (
markdownlint-cli2 "**/*.md"= 0 errors).Not included (maintainer discretion): #731 also suggested aligning the
AGENTS.mdPR-review section headings to the template's "PR Review Etiquette" / "Expected Review Loop". On inspection this repo already carries the review-loop contract (under "Merging a PR" / "Develop → Main Promotion") and the Copilot runbook in.github/copilot-instructions.md; only the heading names differ. That cosmetic restructuring is left out of this PR to avoid churning maintained docs - can be done separately if desired. Also note: this repo's.editorconfigalready has the full per-extensionend_of_linerules (the issue's "crlf only under[*.md]" claim was inaccurate), so no EOL-rule change was needed.