Skip to content

fix(linter): add help text to eslint rule diagnostics#19539

Merged
camc314 merged 2 commits intooxc-project:mainfrom
anthonyamaro15:fix/eslint-diagnostics-add-help-text
Feb 19, 2026
Merged

fix(linter): add help text to eslint rule diagnostics#19539
camc314 merged 2 commits intooxc-project:mainfrom
anthonyamaro15:fix/eslint-diagnostics-add-help-text

Conversation

@anthonyamaro15
Copy link
Contributor

What PR covers:

  • Closes linter: Add help or notes to diagnostics only containing a message #19121 (partially)
  • Add .with_help() to 5 ESLint rule diagnostics to provide actionable guidance:
  • no-new-native-nonconstructor: "Remove the new operator to call {fn_name} as a function."
  • prefer-rest-params: "Replace arguments with rest parameters (...args)."
  • prefer-spread: "Replace .apply() with spread syntax (...args)."
  • sort-vars: "Sort variable declarations in ascending order (case-sensitive by default)."
  • prefer-exponentiation-operator: "Replace Math.pow(a, b) with a ** b."

5 rule files changed + 5 corresponding snapshot updates.

Copilot AI review requested due to automatic review settings February 19, 2026 03:24
@github-actions github-actions bot added A-linter Area - Linter C-bug Category - Bug labels Feb 19, 2026
Copy link
Contributor

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 adds helpful guidance text to 5 ESLint rule diagnostics that previously only contained warning messages, partially addressing issue #19121. Each rule now provides actionable advice to developers on how to fix the reported issues.

Changes:

  • Added .with_help() to 5 ESLint rule diagnostic functions with clear, actionable guidance
  • Updated corresponding snapshot files to reflect the new help text in test outputs

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
crates/oxc_linter/src/rules/eslint/no_new_native_nonconstructor.rs Added help text instructing to remove the new operator when calling Symbol/BigInt
crates/oxc_linter/src/rules/eslint/prefer_rest_params.rs Added help text suggesting to replace arguments with rest parameters
crates/oxc_linter/src/rules/eslint/prefer_spread.rs Added help text suggesting to replace .apply() with spread syntax
crates/oxc_linter/src/rules/eslint/sort_vars.rs Added help text explaining to sort variable declarations in ascending order
crates/oxc_linter/src/rules/eslint/prefer_exponentiation_operator.rs Added generic help text to replace Math.pow(a, b) with a ** b
crates/oxc_linter/src/snapshots/eslint_no_new_native_nonconstructor.snap Updated test snapshots to include new help text
crates/oxc_linter/src/snapshots/eslint_prefer_rest_params.snap Updated test snapshots to include new help text
crates/oxc_linter/src/snapshots/eslint_prefer_spread.snap Updated test snapshots to include new help text
crates/oxc_linter/src/snapshots/eslint_sort_vars.snap Updated test snapshots to include new help text
crates/oxc_linter/src/snapshots/eslint_prefer_exponentiation_operator.snap Updated test snapshots with simplified, consistent help text

@codspeed-hq
Copy link

codspeed-hq bot commented Feb 19, 2026

Merging this PR will not alter performance

✅ 47 untouched benchmarks
⏩ 3 skipped benchmarks1


Comparing anthonyamaro15:fix/eslint-diagnostics-add-help-text (f4d1079) with main (fd11073)

Open in CodSpeed

Footnotes

  1. 3 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

Copy link
Contributor

@camc314 camc314 left a comment

Choose a reason for hiding this comment

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

Thanks!

@camc314 camc314 merged commit f064482 into oxc-project:main Feb 19, 2026
29 checks passed
camc314 added a commit that referenced this pull request Feb 19, 2026
# Oxlint
### 💥 BREAKING CHANGES

- 4315594 oxlint: [**BREAKING**] Deprecate `"always"` and `"as-needed"`
options of the radix rule (#19408) (Sysix)
- d4c7af3 linter: [**BREAKING**] Remove
`allowRuleToRunWithoutStrictNullChecksIKnowWhatIAmDoing` option (#19451)
(camc314)

### 🚀 Features

- 82ca5c3 linter: Add typescript/dot-notation rule (#19442) (camc314)
- 6db0811 linter: Implement
eslint-plugin-vitest/no-importing-vitest-globals (#18694) (Said
Atrahouch)
- c7fe8ae linter: Implement eslint-plugin-vitest/prefer-import-in-mock
(#17966) (Said Atrahouch)
- 0abb39a linter: Implement
eslint-vitest-jest-plugin/prefer-mock-return-shorthand (#18002) (Said
Atrahouch)
- 2b95537 linter: Implement `n/no-path-concat` rule (#19502) (Mikhail
Baev)
- 735d0e4 linter: Implement typescript/no-useless-default-assignment
(#19488) (camc314)
- 31c3a93 linter: Add typescript/no-unnecessary-type-parameters rule
(#19450) (camc314)
- c948090 linter: Add typescript/consistent-return rule (#19449)
(camc314)
- 9f87df0 linter: Add typescript/prefer-string-starts-ends-with rule
(#19448) (camc314)
- 04536be linter: Add typescript/prefer-regexp-exec rule (#19447)
(camc314)
- 56a7feb linter: Add typescript/prefer-readonly rule (#19446) (camc314)
- a1cea63 linter: Add typescript/no-unnecessary-qualifier rule (#19445)
(camc314)
- e3144d2 linter: Add typescript/prefer-find rule (#19444) (camc314)
- 13c7408 linter: Add typescript/prefer-readonly-parameter-types rule
(#19443) (camc314)
- 9b17d44 linter: Add typescript/strict-void-return rule (#19441)
(camc314)
- ed821b4 linter: Add typescript/consistent-type-exports rule (#19440)
(camc314)

### 🐛 Bug Fixes

- daad7bc linter/array-callback-return: Check `allowVoid` option
(#19506) (Said Atrahouch)
- 638cf94 linter: Add help text to eslint rule diagnostics (#19508)
(Kyle Tse)
- 79fc6d7 linter: Move no-use-before-define to eslint plugin (#19438)
(camc314)
- c832a9f linter: Add `onScrollEnd` and `onScrollEndCapture` to
`react/no-unknown-property`. (#19536) (connorshea)
- 999a0db linter: Add help text to `symbol-description` diagnostics
(#19538) (Anthony Amaro)
- f064482 linter: Add help text to eslint rule diagnostics (#19539)
(Anthony Amaro)
- fd11073 linter/react/no-unknown-property: Add missing `fetchPriority`
prop (#19525) (João Pedro Schmitz)
- a9bb604 linter/no-shadow: Align initializer shadow handling with
typescript-eslint (#19462) (camc314)
- 32e6eb9 linter: Handle typed arrays/array buffers in `prefer-spread`
rule. (#19478) (connorshea)
- e309f84 linter: Handle additional cases in
`typescript/consistent-generic-constructors` rule. (#19477) (connorshea)
- 71db91a linter/array-callback-return: Check `fromAsync`, update test
cases (#19483) (Said Atrahouch)
- 2a12d74 linter: Handle optional chaining in
`no-array-method-this-argument` rule. (#19476) (connorshea)
- f65310b linter: Handle optional chaining in
`prefer-object-from-entries` rule. (#19475) (connorshea)
- 840acf4 linter: Handle optional chain in
`no-unnecessary-array-flat-depth` rule. (#19471) (connorshea)
- 85a19e9 linter: Skip string literal imports in `consistent-assert`
rule. (#19474) (connorshea)

### ⚡ Performance

- 6155ac4 linter/constructor-super: Use node_id over nodes loop (#19489)
(camc314)
- a02496d linter/consistent-index-object-style: Resolve circular type
refs semantically (#19490) (camc314)
# Oxfmt
### 🚀 Features

- 652c346 oxfmt/lsp: Support `untitled://` schema (#19287) (Sysix)

### 🐛 Bug Fixes

- 6c61b70 oxfmt: Fix outdated `sortImports.groups` doc comments (#19513)
(leaysgur)

Co-authored-by: camc314 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-bug Category - Bug

Projects

None yet

Development

Successfully merging this pull request may close these issues.

linter: Add help or notes to diagnostics only containing a message

2 participants

Comments