-
-
Notifications
You must be signed in to change notification settings - Fork 721
fix(language_server): use the first Span of the message as the primary Diagnostic range #14057
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(language_server): use the first Span of the message as the primary Diagnostic range #14057
Conversation
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
CodSpeed Performance ReportMerging #14057 will not alter performanceComparing Summary
Footnotes
|
fdb03e8 to
100c21a
Compare
2efc8f9 to
ac86d37
Compare
ac86d37 to
553aa9a
Compare
MAX_LSP_INTThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Align LSP diagnostics to use the first span/label as the primary diagnostic range, matching oxlint’s behavior.
- Use the first SpanPositionMessage as the diagnostic range instead of deriving it from related information
- Derive Default for SpanPosition and re-export SpanPositionMessage under the language_server feature
- Remove LSP_MAX_INT and update snapshots to reflect new primary/related message ranges
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| crates/oxc_linter/src/lsp.rs | Adds #[must_use] to with_message and derives Default for SpanPosition to support default fallbacks. |
| crates/oxc_linter/src/lib.rs | Re-exports SpanPositionMessage for language_server feature consumers. |
| crates/oxc_language_server/src/linter/error_with_position.rs | Computes Diagnostic.range from the first label; removes LSP_MAX_INT and cmp_range logic; adjusts imports. |
| crates/oxc_language_server/src/main.rs | Removes unused LSP_MAX_INT constant and its documentation comments. |
| crates/oxc_language_server/src/snapshots/fixtures_linter_issue_9958@issue.ts.snap | Updates expected ranges/messages to reflect using the first span as primary. |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Merge activity
|
…y Diagnostic range (#14057) This PR aligns the main label/span with `oxlint`. `oxlint` will use the first available span as the error. The LSP should use this span for the red line. ``` let a: { b?: { c: number; }; } = {}; for(var i = 0; i < 10; i--){} console.log(a?.b?.c!); ``` Note that `file.ts:7:16` means the line/column number and is linkable. ``` ⚠ eslint(for-direction): The update clause in this loop moves the variable in the wrong direction ╭─[for_direction.ts:7:16] 6 │ 7 │ for(var i = 0; i < 10; i--){} · ───┬── ─┬─ · │ ╰── with this update · ╰── This test moves in the wrong direction 8 │ console.log(a?.b?.c!); ╰──── help: Use while loop for intended infinite loop ⚠ typescript-eslint(no-non-null-asserted-optional-chain): Optional chain expressions can return undefined by design: using a non-null assertion is unsafe and wrong. ╭─[for_direction.ts:8:20] 7 │ for(var i = 0; i < 10; i--){} 8 │ console.log(a?.b?.c!); · ┬ ┬ · │ ╰── non-null assertion made after optional chain · ╰── optional chain used 9 │ ╰──── help: Remove the non-null assertion. ``` https://github.com/oxc-project/oxc/blob/main/crates/oxc_language_server/fixtures/linter/issue_9958/issue.ts Main: <img width="258" height="88" alt="grafik" src="https://github.com/user-attachments/assets/7da86f38-9789-4e04-b08b-18aa783a93ed" /> This PR: <img width="265" height="108" alt="grafik" src="https://github.com/user-attachments/assets/2a031f84-04c3-49a8-8409-a3b1822c55a5" />
553aa9a to
493082c
Compare
| let start = labels.first().map(SpanPositionMessage::start).cloned().unwrap_or_default(); | ||
| let end = labels.first().map(SpanPositionMessage::end).cloned().unwrap_or_default(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you double check this is correct? I think it should be:
| let start = labels.first().map(SpanPositionMessage::start).cloned().unwrap_or_default(); | |
| let end = labels.first().map(SpanPositionMessage::end).cloned().unwrap_or_default(); | |
| let (start, end) = labels | |
| .iter() | |
| .find(|span| span.primary()) | |
| .or_else(|| labels.first()) | |
| .map(|span| ((SpanPositionMessage::start(span), SpanPositionMessage::end(span)))); |
The reasoning, is that some rules - e.g. react/exhaustive deps, mark the primary span (out of the two), and this is where the red line should be
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh these aren't spans, and don't have a primary(), method on them.
## [1.21.0] - 2025-10-08 ### 🚀 Features - 576be20 linter/plugins: Support selectors DSL (#14435) (overlookmotel) - b2de44f linter/plugins: Support interpolation in normal diagnostic `message` (#14419) (overlookmotel) - 382c5be linter/plugins: Support placeholders in messageIds (#14416) (camc314) - 529e88e linter/plugins: Support `messageId`s (#14415) (camc314) - 83e7824 linter: Add `vue/require-default-export` rule (#14351) (Sysix) - ff98536 linter: Add `vue/no-import-compiler-macros` rule (#14335) (Sysix) - 0ec0847 ci: Run napi tests on windows (#14383) (camc314) ### 🐛 Bug Fixes - 11e0440 linter/jsx-handler-name: Improve handler name position in error messages (#14174) (Takuji Shimokawa) - 493082c language_server: Use the first Span of the message as the primary Diagnostic range (#14057) (Sysix) - 88ec1bd linter/plugins: Fix error messages (#14423) (overlookmotel) - 18616c2 oxlint: Ignore fixtures dir for vitest (#14414) (camc314) - ec02fe8 oxlint: Normalize path separators in snapshot tests (#14406) (camc314) - 6e8d2f6 language_server: Ignore JS plugins (#14379) (overlookmotel) - 96663fb linter/plugins: Do not call `before` hook if empty visitor (#14401) (overlookmotel) - 52f04bd linter: Use `pathToFileURL` for importing plugins to ensure correct URL format (#14394) (camc314) - 1ea0d46 oxlint: Resolve tsdown deprecation warning (#14389) (camc314) - bb679b5 linter: Promise/prefer-await-to-then strict option not reading from config (#14382) (camc314) ### 🚜 Refactor - 3374b8e linter/language_server: Move all lsp relevant code to `oxc_language_server` crate (#14430) (Sysix) - d24b74e linter/language_server: `oxc_linter::TsgoLinter::run_source` returns `Message` (#14429) (Sysix) - e5b7fb2 linter/language_server: `oxc_linter::Runtime::run_source` returns `Message` (#14428) (Sysix) - 3b26bf3 linter/plugins: Split adding visit function to compiler visitor into multiple functions (#14433) (overlookmotel) - af3a75e linter/plugins: Track ancestors while walking AST (#14432) (overlookmotel) - f279f0b linter/plugins: Do not lazy-load visitor keys (#14431) (overlookmotel) - 5e99ed3 linter/plugins: Allow nullish values as `message` or `messageId` (#14422) (overlookmotel) - dc30938 linter/plugins: Remove default value from `Context` constructor (#14421) (overlookmotel) - 28cfae0 oxlint: Use `vitest`s built in file snapshot comparison (#14392) (camc314) - 06b0e9f linter/plugins: Convert generated files to TS (#14385) (overlookmotel) - 52f35c6 napi/parser, linter/plugins: Rename `types.js` to `type_ids.js` (#14384) (overlookmotel) ### ⚡ Performance - 26435a1 linter/plugins: Small perf optimizations (#14420) (overlookmotel) - d8a8be1 linter/plugins: Avoid private methods (#14418) (overlookmotel) ### 🧪 Testing - d8da4a4 linter/plugins: Clarify tests for message placeholders (#14417) (overlookmotel) Co-authored-by: camc314 <18101008+camc314@users.noreply.github.com>

This PR aligns the main label/span with
oxlint.oxlintwill use the first available span as the error. The LSP should use this span for the red line.Note that
file.ts:7:16means the line/column number and is linkable.https://github.com/oxc-project/oxc/blob/main/crates/oxc_language_server/fixtures/linter/issue_9958/issue.ts
Main:

This PR:
