Skip to content

fix(linter): add help text to symbol-description diagnostics#19538

Merged
camc314 merged 3 commits intooxc-project:mainfrom
anthonyamaro15:fix/symbol-description-add-help
Feb 19, 2026
Merged

fix(linter): add help text to symbol-description diagnostics#19538
camc314 merged 3 commits intooxc-project:mainfrom
anthonyamaro15:fix/symbol-description-add-help

Conversation

@anthonyamaro15
Copy link
Contributor

Closes #19121 (partially)

  • Before: only shows "Expected Symbol to have a description."
  • After: also shows help: Pass a description argument to the Symbol()

Copilot AI review requested due to automatic review settings February 19, 2026 02:17
@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 improves the eslint(symbol-description) diagnostic by adding actionable help text so users know how to resolve the warning, aligning with the request in #19121.

Changes:

  • Add .with_help(...) text to the symbol-description diagnostic.
  • Update the corresponding snapshot output to include the new help line(s).

Reviewed changes

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

File Description
crates/oxc_linter/src/rules/eslint/symbol_description.rs Adds help text to the emitted diagnostic for missing Symbol() description.
crates/oxc_linter/src/snapshots/eslint_symbol_description.snap Updates snapshot to reflect the new diagnostic help output (and includes new snapshot metadata).
Comments suppressed due to low confidence (2)

crates/oxc_linter/src/rules/eslint/symbol_description.rs:14

  • The new .with_help text reads like a complete sentence but is missing trailing punctuation (many existing with_help("Pass …") messages end with a period). Consider adding a final period for consistency/readability.
    OxcDiagnostic::warn("Expected Symbol to have a description.")
        .with_help("Pass a description argument to the Symbol()")
        .with_label(span)

crates/oxc_linter/src/snapshots/eslint_symbol_description.snap:3

  • This snapshot header now includes assertion_line: 444, but other snapshot files in this directory typically only include ---, source: …, --- (e.g. crates/oxc_linter/src/snapshots/eslint_new_cap.snap). If this was added unintentionally by a different insta version/config, consider regenerating/normalizing the snapshot to avoid inconsistent metadata churn.
assertion_line: 444

@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/symbol-description-add-help (e8f9d30) with main (f064482)

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.

Co-authored-by: Connor Shea <connor.james.shea@gmail.com>
Signed-off-by: Anthony Amaro <47038260+anthonyamaro15@users.noreply.github.com>
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 self-assigned this Feb 19, 2026
@camc314 camc314 merged commit 999a0db 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 <18101008+camc314@users.noreply.github.com>
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

4 participants