Skip to content

fix(linter): add help messages to import plugin diagnostics#20158

Merged
camc314 merged 4 commits intooxc-project:mainfrom
costajohnt:fix/linter-import-help-messages
Mar 10, 2026
Merged

fix(linter): add help messages to import plugin diagnostics#20158
camc314 merged 4 commits intooxc-project:mainfrom
costajohnt:fix/linter-import-help-messages

Conversation

@costajohnt
Copy link
Contributor

Summary

Add .with_help() messages to 5 import lint rules that were missing actionable guidance:

  • exports-last: "Move this export to the end of the file, after all other statements."
  • no-absolute-path: "Replace the absolute path with a relative path or a module alias."
  • no-default-export: "Replace this default export with a named export."
  • no-mutable-exports: Dynamic per violation — "Replace 'let'/'var' with 'const' to export an immutable binding."
  • no-self-import: "Remove this import. A module should not import itself."

Part of #19121

AI Disclosure: AI-assisted per contribution guidelines.

Test Plan

  • All 33 import rule tests pass (cargo test -p oxc_linter --lib -- "::import::")
  • Snapshots regenerated via cargo insta accept
  • Help messages are actionable and match the specificity of their corresponding warnings

Add `.with_help()` messages to 5 import lint rules that were missing
actionable guidance:

- `exports-last`: Move export to end of file
- `no-absolute-path`: Replace with relative path or module alias
- `no-default-export`: Replace with named export
- `no-mutable-exports`: Replace var/let with const (dynamic per violation)
- `no-self-import`: Remove the self-import

Part of oxc-project#19121
@github-actions github-actions bot added A-linter Area - Linter C-bug Category - Bug labels Mar 9, 2026
Switch no_self_import from .test() to .test_and_snapshot() so the
help text is verified in a snapshot, consistent with the other 4
import rules in this PR.
@costajohnt costajohnt marked this pull request as ready for review March 9, 2026 21:22
@costajohnt costajohnt requested a review from camc314 as a code owner March 9, 2026 21:22
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!

@codspeed-hq
Copy link

codspeed-hq bot commented Mar 9, 2026

Merging this PR will not alter performance

✅ 4 untouched benchmarks
⏩ 52 skipped benchmarks1


Comparing costajohnt:fix/linter-import-help-messages (4a09099) with main (a9acb2b)

Open in CodSpeed

Footnotes

  1. 52 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.

@camc314
Copy link
Contributor

camc314 commented Mar 9, 2026

@costajohnt CI is failing

The oxlint CLI integration test also captures diagnostic output
including the new help message.
@github-actions github-actions bot added the A-cli Area - CLI label Mar 9, 2026
These are tsgolint test artifacts from a missing local binary,
unrelated to the import help message changes.
@costajohnt
Copy link
Contributor Author

@camc314 can you try running CI again? I pushed a fix

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 Mar 10, 2026
@camc314 camc314 merged commit ad27fd6 into oxc-project:main Mar 10, 2026
21 checks passed
leaysgur added a commit that referenced this pull request Mar 11, 2026
# Oxlint
### 🚀 Features

- 04a5ce0 oxlint: Support `vite.config.ts` `.lint` field (#20214)
(leaysgur)
- 1735215 linter: Implement `react/no-clone-element` rule. (#20129)
(connorshea)
- 68e6f6f linter: Implement `react/no-react-children` rule. (#20104)
(connorshea)
- fe3b32e linter/plugins: Add `oxlint-plugin-eslint` package (#20009)
(overlookmotel)

### 🐛 Bug Fixes

- 05f6a09 linter/no-inline-comments: Deserialize rule options with serde
(#20207) (camc314)
- c7eb09d linter/default-case: Deserialize rule options with serde
(#20206) (camc314)
- f85e16c linter/plugins: Fix types for visitor compilation (#20203)
(overlookmotel)
- 44e24e0 linter/exhaustive-deps: Ignore type-only typeof deps (#20201)
(camc314)
- 0b04998 linter/no-fallthrough: Deserialize rule options with serde
(#20192) (camc314)
- a1031cb linter/new-cap: Deserialize rule options with serde (#20161)
(camc314)
- ad27fd6 linter: Add help messages to import plugin diagnostics
(#20158) (John Costa)
- 1340307 linter/plugins: Ensure `after` hooks always run (#20167)
(overlookmotel)
- c4812ec linter/plugins: Reset visitor compilation state if error
during compilation (#20166) (overlookmotel)
- 887eecc linter/plugins: Add license notice to `oxlint-plugin-eslint`
package (#20164) (overlookmotel)
- e1713a4 linter/plugins: Include common chunks in
`oxlint-plugin-eslint` package (#20163) (overlookmotel)
- a9acb2b linter: Check `globals` entry for `no-undef`, only check
es2026 globals for `no-extend-native` and
`no-constant-binary-expression` (#20089) (Sysix)
- 5559f0d linter/no-unused-vars: `reportUsedIgnorePattern` should not
report used rest siblings (#20108) (Don Isaac)
- de7c0e2 linter/plugins: Correct error message for `markVariableAsUsed`
(#20152) (overlookmotel)

### ⚡ Performance

- 3a86427 linter/plugins: Pre-populate cache of `EnterExit` objects at
startup (#20194) (overlookmotel)
- d243391 linter/plugins: Replace arrays with `Uint8Array`s (#20190)
(overlookmotel)
- 8742f8b linter/plugins: Pre-populate cache of `VisitProp` objects
(#20189) (overlookmotel)
- 3061acb linter/plugins: Pre-populate cache of `EnterExit` objects
(#20187) (overlookmotel)
- c73912b linter/plugins: Free visit functions earlier (#20186)
(overlookmotel)
- d9f8ff4 linter/plugins: Faster reset of visitor state (#20185)
(overlookmotel)
- 42aff15 oxlint/lsp: Avoid computing diagnostics for non invoked code
actions requests (#20080) (Sysix)

### 📚 Documentation

- a080650 linter/plugins: Fix documentation of visitor compilation
(#20202) (overlookmotel)
- 542a04a linter: Add a link to the cyclomatic complexity Wikipedia
article in `eslint/complexity` (#20174) (connorshea)
# Oxfmt
### 🚀 Features

- 95943aa oxfmt: Support `vite.config.*` `.fmt` field (#20197)
(leaysgur)
- 172fc07 oxfmt: .js/.ts config file support (#20135) (leaysgur)

### 🐛 Bug Fixes

- e483569 oxfmt: Avoid double-escaping in css-in-js (#20211) (leaysgur)

Co-authored-by: leaysgur <6259812+leaysgur@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants