Skip to content
/ utils Public

Fail rumdl when warnings occur#615

Merged
5ouma merged 1 commit intomainfrom
chore-pre-commit-rumdl-fail
Jan 3, 2026
Merged

Fail rumdl when warnings occur#615
5ouma merged 1 commit intomainfrom
chore-pre-commit-rumdl-fail

Conversation

@5ouma
Copy link
Owner

@5ouma 5ouma commented Jan 3, 2026

Don't ignore any warnings as well as errors.

Don't ignore any warnings as well as errors.
Copilot AI review requested due to automatic review settings January 3, 2026 02:30
@github-actions github-actions bot added the 🚸 pre-commit Check the code with pre-commit hooks label Jan 3, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR enhances the rumdl markdown linter configuration to treat warnings as failures, making the pre-commit hook stricter by not allowing any warnings to pass through unchecked.

  • Adds --fail-on warning flag to the rumdl pre-commit hook configuration

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

@coderabbitai
Copy link

coderabbitai bot commented Jan 3, 2026

Walkthrough

The rumdl hook configuration in the pre-commit setup has been updated to add a fail-on policy with the warning level, alongside the existing disable flags. This modifies the linting behavior to treat warnings as failures while maintaining the same MD code disables.

Changes

Cohort / File(s) Summary
Pre-commit configuration
\.pre-commit-config.yaml``
Added --fail-on warning flag to rumdl hook args while preserving existing --disable configuration with MD codes (MD013, MD024, MD033, MD036). Changes error handling behavior to elevate warnings to failures.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Fail rumdl when warnings occur' accurately summarizes the main change: adding --fail-on warning to the rumdl configuration to treat warnings as failures.
Description check ✅ Passed The description 'Don't ignore any warnings as well as errors' is directly related to the changeset, which adds --fail-on warning to prevent ignoring warnings in rumdl linting.
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-fail

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a2f279a and 5a14e4f.

📒 Files selected for processing (1)
  • .pre-commit-config.yaml
🔇 Additional comments (1)
.pre-commit-config.yaml (1)

86-86: Change is correct and aligns with PR objectives.

The addition of --fail-on warning is properly implemented. The --fail-on flag is supported in rumdl v0.0.207 (added in v0.0.201), and warning is a valid option that causes rumdl to exit non-zero when warnings or errors occur. The YAML list syntax correctly passes --fail-on and warning as separate arguments. The existing --disable and --fix flags are properly maintained.


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 fdde4aa into main Jan 3, 2026
11 checks passed
@5ouma 5ouma deleted the chore-pre-commit-rumdl-fail branch January 3, 2026 02:35
This was referenced Jan 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant