✨ feat: Add optional description field to rules#24
Merged
Conversation
Add an optional `description` field to rules that is shown in violation output, helping users understand why a rule exists and why a violation was reported. The violation output format is updated so the arrow line is always on its own line for consistency. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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
descriptionfield toRulethat provides human-readable context for why a rule existsdescriptionin violation output when present, helping users understand violations at a glancesource → imported) is always on its own line for consistencyOutput format
With description:
Without description (backward compatible):
Config example
Changed files
config.py—Ruledataclass + parsingchecker.py—Violationdataclass + propagationmatcher.py—merge_rulespreserves descriptionreporter.py— output formattests/— test_config, test_checker, test_matcher, test_reporterdocs/— config-schema, rules guide, getting-startedTest plan
descriptionparsed from YAML configdescriptionparsed from TOML configdescriptionisNonewhen omittedViolationcarriesrule_descriptionfor both allow and deny violationsmerge_rulespreserves first rule's description🤖 Generated with Claude Code