feat!: update default rule doc title and notices to separate rule name and description#835
Merged
Conversation
bmish
changed the title
bmish
pushed a commit
that referenced
this pull request
Jan 1, 2026
🤖 I have created a release *beep* *boop* --- ## [3.0.0](v2.4.0...v3.0.0) (2026-01-01) ### ⚠ BREAKING CHANGES * update default rule doc title and notices to separate rule name and description ([#835](#835)) * Add default emoji for `base` config * Remove implicit config badge fallback * Require Node 20, 22, 24+ ### Features * Add default emoji for `base` config ([c3f1fb9](c3f1fb9)) * Remove implicit config badge fallback ([654667c](654667c)) * Require Node 20, 22, 24+ ([af5ab75](af5ab75)) * update default rule doc title and notices to separate rule name and description ([#835](#835)) ([3d4b160](3d4b160)) * update dependencies ([#834](#834)) ([828d6cf](828d6cf)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This was referenced Jan 2, 2026
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
1 participant
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.
Changes default title format and adds description notice
This PR updates the default
--rule-doc-title-formatfromdesc-parens-prefix-nametoprefix-name(e.g.,# test/no-fooinstead of# Disallow use of foo (test/no-foo)), addsdescriptionas a new default notice in--rule-doc-notices(appearing last in the list afterconfigs,deprecated,fixableAndHasSuggestions, andrequiresTypeChecking), and introduces the 📝 emoji for the description notice type to maintain consistency with other notice types.This is a long-requested change. The goal is to be more consistent with ESLint/typescript-eslint and give the rule description the dedicated line that it deserves, while keeping the title short and simple.
Note that you can revert to the old behavior using the config options. Please provide feedback if these new defaults cause issues.
Fixes #347.
BEGIN_COMMIT_OVERRIDE
feat!: Update default rule doc title and notices to separate rule name and description
END_COMMIT_OVERRIDE