Repository navigation
chore: replace markdownlint-cli2 with rumdl - #1785
Merged
Merged
Conversation
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 Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1785 +/- ##
====================================
Coverage 66% 66%
====================================
Files 23 23
Lines 3565 3565
====================================
Hits 2355 2355
Misses 1210 1210
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. |
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.
📝 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:
emphasis-styledisable comments. The changelogs and bothcliff.tomltemplates disabledemph-style, which is not a rule. markdownlint ignored the name without a warning. rumdl warns about it, so this fix comes first.rumdl importconverted.markdownlint-cli2.yamlinto.rumdl.toml. The existingmarkdownlint-disablecomments still work, because rumdl reads them. Three settings needed manual work:excludewithforce_exclude, because prek passes file paths directly. The importer dropped theignoreskey.docs/trees. Their links point at pages generated at build time..vscode/. This drops the shared extension recommendations and the pytest settings.prek autoupdatebumped 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.jsonturns 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 directbiomeruns.🔥 Motivation
rumdl is a single Rust binary, so the hook needs no Node toolchain. It also caught the dead
emph-styledirective.🔨 Test Plan
prek run --all-filespasses on every hook.rumdl checkreports no issues across the 33 tracked Markdown files. A directrumdl checkof the PR template leaves it out.🔗 Related issues/PRs
None.