Skip to content

chore: replace markdownlint-cli2 with rumdl - #1785

Merged
JP-Ellis merged 4 commits into
mainfrom
chore/rumdl
Nov 20, 2026
Merged

JP-Ellis merged 4 commits into
mainfrom
chore/rumdl

Conversation

@JP-Ellis

Copy link
Copy Markdown
Member

✈️ Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

📝 Summary

The Markdown lint hook switches from markdownlint-cli2 to rumdl. The remaining prek hooks move to their latest releases.

The commits land in this order:

  1. Fix the emphasis-style disable comments. The changelogs and both cliff.toml templates disabled emph-style, which is not a rule. markdownlint ignored the name without a warning. rumdl warns about it, so this fix comes first.
  2. Replace markdownlint-cli2 with rumdl. rumdl import converted .markdownlint-cli2.yaml into .rumdl.toml. The existing markdownlint-disable comments still work, because rumdl reads them. Three settings needed manual work:
    • The PR template exclusion comes back as exclude with force_exclude, because prek passes file paths directly. The importer dropped the ignores key.
    • MD076 is off. It is a new rumdl rule for list item spacing, and the changelogs that git-cliff generates fail it.
    • MD057 is ignored under the two MkDocs docs/ trees. Their links point at pages generated at build time.
  3. Remove .vscode/. This drops the shared extension recommendations and the pytest settings.
  4. Update the prek hooks. prek autoupdate bumped biome, ruff, committed, typos and tombi.

Biome 2.6 added Markdown and YAML support. Its Markdown formatter broke MkDocs front matter and indented a /// admonition fence. It also rewrote __repr__ as **repr**. The YAML formatter rewrapped issue-template strings and moved comment spacing, which conflicts with yamlfix. biome.json turns off both languages, so rumdl and yamlfix keep those files. I chose that over narrowing the hook's file types, because the setting also applies to editors and direct biome runs.

🔥 Motivation

rumdl is a single Rust binary, so the hook needs no Node toolchain. It also caught the dead emph-style directive.

🔨 Test Plan

  • prek run --all-files passes on every hook.
  • rumdl check reports no issues across the 33 tracked Markdown files. A direct rumdl check of the PR template leaves it out.

🔗 Related issues/PRs

None.

The changelogs and the git-cliff templates that generate them disabled
`emph-style`, which no linter defines. markdownlint ignored the unknown
name without a warning, so the comment never took effect. The rule is
`emphasis-style` (MD049).

Assisted-by: Claude Code:claude-opus-5-5
rumdl implements the markdownlint rule set in Rust and reads
`markdownlint-disable` comments, so the inline directives stay as they
are.

`.rumdl.toml` carries over the markdownlint options through `rumdl
import`, plus three settings:

- `exclude` with `force_exclude` keeps the PR template out of the run
  when prek passes it by path. `rumdl import` dropped the `ignores` key.
- MD076 (list item spacing, new in rumdl) is disabled. git-cliff writes
  changelog lists that mix tight and loose items.
- MD057 (relative link targets exist) is ignored under the MkDocs docs
  trees, whose links point at pages generated at build time.

Assisted-by: Claude Code:claude-opus-5-5
The shared extension recommendations and test settings were tied to one
editor. Contributors keep their own editor configuration locally.

Assisted-by: Claude Code:claude-opus-5-5
Bumps biome, ruff, committed, typos and tombi to their latest releases
with `prek autoupdate`.

Biome 2.6 formats and lints Markdown and YAML. Its Markdown formatter
breaks MkDocs front matter and admonition fences, and turns dunder
names such as `__repr__` into bold text. rumdl and yamlfix already own
those files, so `biome.json` turns both languages off. `biome migrate`
updated the schema and replaced `recommended` with `preset`.

Assisted-by: Claude Code:claude-opus-5-5
@codecov

codecov Bot commented Nov 20, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 66%. Comparing base (46fe5c3) to head (472460a).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@         Coverage Diff          @@
##           main   #1785   +/-   ##
====================================
  Coverage    66%     66%           
====================================
  Files        23      23           
  Lines      3565    3565           
====================================
  Hits       2355    2355           
  Misses     1210    1210           
Flag Coverage Δ
examples 39% <ø> (ø)
tests 65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@JP-Ellis
JP-Ellis merged commit 38d21b0 into main Nov 20, 2026
38 checks passed
@JP-Ellis
JP-Ellis deleted the chore/rumdl branch November 20, 2026 03:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant