feat(linter/unicorn): add help messages to 3 rule diagnostics#21459
Merged
camc314 merged 2 commits intooxc-project:mainfrom Apr 15, 2026
Merged
feat(linter/unicorn): add help messages to 3 rule diagnostics#21459camc314 merged 2 commits intooxc-project:mainfrom
camc314 merged 2 commits intooxc-project:mainfrom
Conversation
Part of the oxc-project#19121 cleanup. Adds actionable help text to rules flagged by `diagnostic-missing-help-or-note.yml` as emitting diagnostics with no guidance: - `unicorn/error_message`: Pass a message; empty message; non-string message — three distinct diagnostics, each gets tailored help. - `unicorn/no_static_only_class`: reuses the existing fixer message so CLI and fixer stay consistent. Snapshot diff shows the help line now appears for non-fixable cases too, which is the point. - `unicorn/prefer_add_event_listener`: explains why `addEventListener` is preferred (multiple handlers, `{ once: true }`) vs `on<event>` assignment. Snapshots regenerated with `cargo insta`. Issue oxc-project#19121
with_help to three unicorn rule diagnostics
Merging this PR will not alter performance
Comparing 
Footnotes
|
This was referenced Apr 20, 2026
camc314
added a commit
that referenced
this pull request
Apr 20, 2026
# Oxlint ### 💥 BREAKING CHANGES - 24fb7eb allocator: [**BREAKING**] Rename `Box` and `Vec` methods (#21395) (overlookmotel) ### 🚀 Features - 38d8090 linter/jest: Implemented jest `version` settings in config file. (#21522) (Said Atrahouch) - 7dbbb99 linter/eslint: Implement suggestion for `no-case-declarations` rule (#21508) (Mikhail Baev) - 9b4d9f6 linter/prefer-template: Implement autofix (#21502) (François) - daa64ed linter/no-empty-pattern: Add `allowObjectPatternsAsParameters` option (#21474) (camc314) - cf2d281 linter/typescript: Implement explicit-member-accessibility (#21447) (Hunter Tunnicliff) - d48de6f linter/unicorn: Add help messages to 3 rule diagnostics (#21459) (Mukunda Rao Katta) - cffdc2e linter: Backfill rule version metadata (#21391) (Old Autumn) ### 🐛 Bug Fixes - 1e69b91 linter/no-useless-assignment: Improve diagnostic spans (#21581) (camc314) - f272594 linter/plugins: Align `RuleMeta.replacedBy` type with ESLint (#21544) (bab) - 4d57851 linter/eslint: Enhance `no-empty-function` rule to support async and generator functions in VariableDeclarator (#21542) (Mikhail Baev) - 00fc136 codegen: Preserve coverage comments before object properties (#21312) (bab) - a56b7b9 oxlint: Dont enable gitlab formatter by default (#21501) (camc314) - 9c9b6a2 linter/array-callback-return: Ignore non-exit CFG dead ends (#21497) (camc314) - 61088e0 linter/unicorn: Handle computed property access in `prefer-dom-node-remove` rule (#21470) (Mikhail Baev) - eab5934 linter: Report an error on unsupported `extends` values (#21406) (John Costa) - 3289ba0 linter/valid-expect-in-promise: Check a jest fn to be `test` instead of `describe` (#21422) (Said Atrahouch) - 4417fe3 linter/prefer-ending-with-an-expect: Ignore vi.mock factory callbacks (#21414) (Cédric Exbrayat) - a904883 linter/consistent-type-imports: Ignore vue/svelte/astro files (#21415) (bab) - 2498fe6 linter/no-unused-vars: Allow segments of dotted namespace declarations (#21416) (bab) - 44b5b35 linter: Preserve vitest-compatible jest rules when applying overrides (#21389) (Cameron) - 7bd8331 linter/prefer-ending-with-an-expect: Add missing `version` docs (#21390) (Said Atrahouch) - 43d8f0d linter/no-useless-assignment: Ignore writes read by closures (#21380) (camc314) ### 📚 Documentation - c1eeae3 linter: Add version to `rule.json` (#21547) (camchenry) - 0ec6ab2 linter: Improve the `vitest/no-importing-vitest-globals` rule documentation. (#21557) (connorshea) # Oxfmt ### 💥 BREAKING CHANGES - 24fb7eb allocator: [**BREAKING**] Rename `Box` and `Vec` methods (#21395) (overlookmotel) ### 🚀 Features - 5aa7fe1 oxfmt: Add `--disable-nested-config` CLI flag (#21514) (leaysgur) - b5cb8d1 oxfmt: Update prettier to 3.8.3 (#21451) (leaysgur) - 16713d5 oxfmt/cli: Support per-directory config (#21103) (leaysgur) - 952de06 oxfmt/lsp: Support per-directory config (#21081) (leaysgur) ### 🐛 Bug Fixes - a501a53 formatter: Handle comments after pipe in single-member union types (#21487) (John Costa) - 6f49fad oxfmt: Respect nested config.`ignorePatterns` (#21489) (leaysgur) - 7c98d52 oxfmt: Do not panic on finding invalid nested config (#21461) (leaysgur) - 41bb2d5 formatter: Preserve more `intrinsic` parens (#21449) (leaysgur) - f894750 formatter: Preserve parens around `intrinsic` in type alias annotation (#21410) (Dunqing) ### ⚡ Performance - df27b48 oxfmt: Skip ancestors check when no nested config found (#21517) (leaysgur) - 5e1522a oxfmt: Do not occupy the rayon thread solely for handover (#21408) (leaysgur) Co-authored-by: camc314 <18101008+camc314@users.noreply.github.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
2 participants
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
Part of the #19121 cleanup — adds actionable
with_helptext to three unicorn rules flagged bydiagnostic-missing-help-or-note.ymlas having no help or note.Rules touched
unicorn/error_messageunicorn/no_static_only_classwith_messageso the CLI and fixer stay in syncunicorn/prefer_add_event_listener{ once: true }vson<event>assignmentSnapshots
Regenerated via
cargo insta. Forno_static_only_class, the help line previously rendered in snapshots only for fixable cases (through the fixer'swith_message); the diff shows it now appears on non-fixable cases as well, which is the goal.Verification
cargo check -p oxc_linter— cleancargo test -p oxc_linter --lib error_message— passescargo test -p oxc_linter --lib no_static_only_class— passescargo test -p oxc_linter --lib prefer_add_event_listener— passesPart of #19121