Skip to content
/ utils Public

Switch to rumdl instead of markdownlint#517

Merged
5ouma merged 1 commit intomainfrom
chore-pre-commit-rumdl
Nov 20, 2025
Merged

Switch to rumdl instead of markdownlint#517
5ouma merged 1 commit intomainfrom
chore-pre-commit-rumdl

Conversation

@5ouma
Copy link
Owner

@5ouma 5ouma commented Nov 20, 2025

It's much faster and easier to use.

@github-actions github-actions bot added the 🚸 pre-commit Check the code with pre-commit hooks label Nov 20, 2025
@coderabbitai
Copy link

coderabbitai bot commented Nov 20, 2025

Walkthrough

The .pre-commit-config.yaml configuration file is updated to replace the markdownlint pre-commit hook with a new rumdl-based hook. The repository, revision, and hook identifier are changed accordingly, and linting arguments are modified from a disable-only list to a combined fix-and-disable format with specific Markdown codes.

Changes

Cohort / File(s) Summary
Pre-commit configuration
\.pre-commit-config.yaml``		 Replaces markdownlint hook with rumdl hook; updates repository URL, revision, and hook ID; modifies arguments from disable-only list to combined fix-and-disable arguments with quoted MD code list

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

  • Verify that rumdl is an appropriate replacement for markdownlint with compatible functionality
  • Confirm the MD codes list in the quoted argument is comprehensive and includes all necessary rule codes
  • Validate that the new hook configuration will execute correctly in the pre-commit pipeline

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly and clearly summarizes the main change—replacing markdownlint with rumdl in the pre-commit configuration.
Description check ✅ Passed The description relates to the changeset by providing rationale for the switch, explaining that rumdl is faster and easier to use.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore-pre-commit-rumdl
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7eaf25d and 9bd122e.

📒 Files selected for processing (1)
  • .pre-commit-config.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: 🚸 pre-commit
🔇 Additional comments (3)
.pre-commit-config.yaml (3)

80-84: Arguments syntax is correct.

The rumdl CLI supports --fix for automatic fixes and --disable with comma-separated rule codes. The configuration properly disables MD013, MD024, MD033, and MD036, which are valid rule codes. The quoted comma-separated list in the YAML array is the correct pre-commit syntax.

80-84: Ensure existing markdownlint config is compatible.

rumdl automatically discovers and loads existing markdownlint config files, so switching from markdownlint to rumdl should be seamless if you have existing .markdownlint.json or .markdownlint.yaml files in the repository. Verify that the team is aware of this migration and any behavior differences.

Consider running pre-commit run --all-files after merging to ensure all Markdown files pass the new linter without unexpected failures.

80-84: No issues found with rumdl-pre-commit version v0.0.180.

The version v0.0.180 is valid and represents the latest published release as of November 19, 2025. The repository shows active maintenance. The hook configuration with --fix and --disable arguments is correct and aligns with rumdl's documented usage.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@5ouma 5ouma merged commit bc56be5 into main Nov 20, 2025
5 checks passed
@5ouma 5ouma deleted the chore-pre-commit-rumdl branch November 20, 2025 02:41
@5ouma 5ouma bot mentioned this pull request Nov 20, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

@5ouma 5ouma

Labels

🚸 pre-commit Check the code with pre-commit hooks

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@5ouma