fix(linter): add help guidance to eslint diagnostic messages#19562
Merged
camc314 merged 3 commits intooxc-project:mainfrom Feb 20, 2026
Merged
fix(linter): add help guidance to eslint diagnostic messages#19562camc314 merged 3 commits intooxc-project:mainfrom
camc314 merged 3 commits intooxc-project:mainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request adds .with_help() to 4 ESLint rule diagnostics to address issue #19121, which identified lint diagnostics that were missing help text or notes. The changes add helpful guidance messages to help developers understand how to resolve the warnings for the following rules:
Changes:
- Added help text to
no-undef,no-setter-return,no-unreachable, andprefer-numeric-literalsdiagnostic messages - Updated corresponding snapshot files to reflect the new help messages
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| crates/oxc_linter/src/rules/eslint/no_undef.rs | Added help message guiding developers to define the variable, remove the reference, or add it to globals configuration |
| crates/oxc_linter/src/rules/eslint/no_setter_return.rs | Added help message to remove return statement or ensure it doesn't return a value |
| crates/oxc_linter/src/rules/eslint/no_unreachable.rs | Added help message to remove unreachable code or fix control flow |
| crates/oxc_linter/src/rules/eslint/prefer_numeric_literals.rs | Added generic help message to use numeric literal syntax instead of parseInt() |
| crates/oxc_linter/src/snapshots/eslint_no_undef.snap | Updated snapshot with new help messages |
| crates/oxc_linter/src/snapshots/eslint_no_setter_return.snap | Updated snapshot with new help messages |
| crates/oxc_linter/src/snapshots/eslint_no_unreachable.snap | Updated snapshot with new help messages |
| crates/oxc_linter/src/snapshots/eslint_prefer_numeric_literals.snap | Updated snapshot with new help messages |
Merging this PR will not alter performance
Comparing 
Footnotes
|
anthonyamaro15
force-pushed
the
fix/eslint-add-help-diagnostics
branch
from
8c6fc71 to
d2088d4
Compare
camc314
pushed a commit
that referenced
this pull request
Feb 23, 2026
# Oxlint ### 🚀 Features - 46177dd linter: Implement unicorn/prefer-module (#19603) (camc314) - 42f78bb linter: Implement unicorn/prefer-ternary (#19605) (camc314) ### 🐛 Bug Fixes - 43df857 react/exhaustive-deps: Normalize .current callback deps (#19610) (camc314) - 574f48f linter/no-throw-literal: Close warning block (#19612) (camc314) - 79fe3b4 linter/prefer-mock-return-shorthand: Avoid unsafe autofixes for call-like returns (#19581) (camc314) - 85045e8 linter: Check protected members in explicit-module-boundary-types (#19594) (camc314) - e38115e linter: Catch missing return type on exported arrow/function expressions (#19587) (Peter Wagenet) - 419d3fd linter: Fix false negatives in typescript/no-require-imports (#19589) (Peter Wagenet) - 7958b56 linter: Fix syntax error reporting in some output formatters. (#19590) (connorshea) - 024f51c linter: Add help text to more eslint diagnostics (#19591) (Anthony Amaro) - a8489a1 linter: Warning `eslint/no-throw-literal` rule to be deprecated, better use `typescript/only-throw-error` (#19593) (Said Atrahouch) - 50fc70d linter/type-aware: Use correct span for disable directives (#19576) (camc314) - 421a99c linter: Add help guidance to eslint diagnostic messages (#19562) (Anthony Amaro) - e81364a linter: Add help text to eslint rule diagnostics (#19560) (Anthony Amaro) - 89b58d0 linter: Add help text to more eslint rule diagnostics (#19561) (Anthony Amaro) - 74f7833 linter/jest/prefer-mock-return-shorthand: Preserve typed arrow returns (#19556) (camc314) - bdd6f34 linter: Restrict prefer-import-in-mock to mock calls (#19555) (camc314) ### 📚 Documentation - a331993 linter: Improve docs for `eslint/radix` rule. (#19611) (connorshea) ### 🛡️ Security - c67f9dc linter: Update ajv version. (#19613) (connorshea) # Oxfmt ### 🚀 Features - 984dc07 oxfmt: Strip `"experimental"SortXxx` prefix (#19567) (leaysgur) ### 🐛 Bug Fixes - d7b63a4 oxfmt: Update API types for `sortPackageJsonOptions` (#19569) (leaysgur) Co-authored-by: Boshen <1430279+Boshen@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
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.
PR covers:
Closes #19121 (partially)
Add
.with_help()to 4 ESLint rule diagnostics to help developers understand how to resolve warnings:no-undef: "Either define '{name}' or remove the reference to it. If '{name}' is a globalvariable, add it to the 'globals' configuration."
no-setter-return: "Remove the return statement or ensure it does not return a value."no-unreachable: "Remove the unreachable code or fix the control flow to make it reachable."3 rule files changed + 3 corresponding snapshot updates.