Skip to content

feat(lint): Add markdownlint integration - #391

Merged
currantw merged 6 commits into
valkey-io:mainfrom
currantw:currantw/add-markdownlint
May 12, 2026
Merged

feat(lint): Add markdownlint integration#391
currantw merged 6 commits into
valkey-io:mainfrom
currantw:currantw/add-markdownlint

Conversation

@currantw

@currantw currantw commented May 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

Integrate markdownlint-cli2 into the project's lint and format pipelines to enforce consistent markdown style across all .md files. This adds automated structural validation and auto-fix capability for markdown, complementing the existing C#, Rust, YAML, and GitHub Actions linting.

Issue Link

Closes #380.

Features and Behaviour Changes

  • task lint:markdown — checks all markdown files for style violations.
  • task format:markdown — auto-fixes markdown violations in-place.
  • Both are wired into task lint and task format respectively.
  • Uses npx markdownlint-cli2 (no separate install step needed, matches existing prettier pattern).
  • Respects .gitignore via gitignore: true config option.

Implementation

  • gitignore: true — automatically excludes gitignored directories (.kiro/, rust/target/, etc.).
  • MD013 (line length) disabled — not auto-fixable, too noisy for prose-heavy docs.
  • MD024 (duplicate headings) set to siblings_only — allows repeated headings under different parents.
  • Explicit ignore for valkey-glide/** (read-only submodule containing .md files).

Limitations

⚪ None.

Testing

  • task lint:markdown passes with 0 errors across 10 linted files
  • task format:markdown runs successfully

Related Issues

⚪ None.

Checklist

  • This Pull Request is related to one issue.
  • Commit message has a detailed description of what changed and why.
  • Tests are added or updated and all checks pass. (No tests applicable — CI/config tooling only)
  • CHANGELOG.md, README.md, DEVELOPER.md, and other documentation files are updated.
  • Destination branch is correct - main or release
  • Create merge commit if merging release branch into main, squash otherwise.

currantw added 5 commits May 11, 2026 13:42
Signed-off-by: currantw <taylor.curran@improving.com>
Signed-off-by: currantw <taylor.curran@improving.com>
Signed-off-by: currantw <taylor.curran@improving.com>
Signed-off-by: currantw <taylor.curran@improving.com>
Signed-off-by: currantw <taylor.curran@improving.com>
@currantw currantw self-assigned this May 11, 2026
@currantw
currantw requested a review from Copilot May 11, 2026 21:53
@currantw currantw changed the title chore: Add markdownlint-cli2 integration feat(lint): Add markdownlint integration May 11, 2026
Comment thread .github/pull_request_template.md
Comment thread docs/configuration-architecture-analysis.md
Comment thread Taskfile.yml

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Integrates markdownlint-cli2 into the repo’s existing task-based lint/format workflow to enforce consistent Markdown style across documentation and meta files.

Changes:

  • Add task lint:markdown and task format:markdown, and wire them into task lint / task format.
  • Introduce .markdownlint-cli2.yaml with project-specific rule/config overrides and ignore globs.
  • Apply Markdown cleanup across several docs/templates to satisfy lint rules (heading levels, table separator, code-fence info strings, spacing).

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
Taskfile.yml Adds markdown lint/format tasks and includes them in aggregate lint/format pipelines.
.markdownlint-cli2.yaml Configures markdownlint-cli2 (rule overrides, gitignore integration, submodule ignores).
docs/configuration-architecture-analysis.md Markdown formatting updates (blank lines, fenced code language).
docs/ci-cd.md Markdown table separator formatting update.
DEVELOPER.md Heading level and lint/format command list updates to include markdown tasks.
AGENTS.md Updates “common commands / quality gates” to include markdown lint/format tasks.
.github/pull_request_template.md Normalizes headings/structure to comply with Markdown linting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread Taskfile.yml
Comment thread Taskfile.yml
@currantw
currantw removed the request for review from xShinnRyuu May 11, 2026 21:59
@currantw currantw added ci CI/CD pipelines and GitHub Actions release-1.2 dev Internal changes like cleanup, refactoring, or developer tools. labels May 11, 2026
@currantw
currantw requested a review from Aryex May 12, 2026 00:12
@currantw
currantw requested a review from xShinnRyuu May 12, 2026 00:12
@currantw
currantw enabled auto-merge (squash) May 12, 2026 00:13
@currantw
currantw merged commit 9665edd into valkey-io:main May 12, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci CI/CD pipelines and GitHub Actions dev Internal changes like cleanup, refactoring, or developer tools.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(lint): add markdownlint support

4 participants