mirror of
https://github.com/astral-sh/ruff.git
synced 2025-10-27 02:16:54 +00:00
Some checks are pending
CI / Determine changes (push) Waiting to run
CI / cargo fmt (push) Waiting to run
CI / cargo clippy (push) Blocked by required conditions
CI / cargo test (linux) (push) Blocked by required conditions
CI / cargo test (linux, release) (push) Blocked by required conditions
CI / cargo test (windows) (push) Blocked by required conditions
CI / cargo test (wasm) (push) Blocked by required conditions
CI / cargo build (release) (push) Waiting to run
CI / cargo build (msrv) (push) Blocked by required conditions
CI / cargo fuzz build (push) Blocked by required conditions
CI / fuzz parser (push) Blocked by required conditions
CI / test scripts (push) Blocked by required conditions
CI / ecosystem (push) Blocked by required conditions
CI / Fuzz for new ty panics (push) Blocked by required conditions
CI / cargo shear (push) Blocked by required conditions
CI / python package (push) Waiting to run
CI / pre-commit (push) Waiting to run
CI / mkdocs (push) Waiting to run
CI / formatter instabilities and black similarity (push) Blocked by required conditions
CI / test ruff-lsp (push) Blocked by required conditions
CI / check playground (push) Blocked by required conditions
CI / benchmarks-instrumented (push) Blocked by required conditions
CI / benchmarks-walltime (push) Blocked by required conditions
[ty Playground] Release / publish (push) Waiting to run
This PR adds support for the "document highlights" language server feature. This feature allows a client to highlight all instances of a selected name within a document. Without this feature, editors perform highlighting based on a simple text match. This adds semantic knowledge. The implementation of this feature largely overlaps that of the recently-added "references" feature. This PR refactors the existing "references.rs" module, separating out the functionality and tests that are specific to the other language feature into a "goto_references.rs" module. The "references.rs" module now contains the functionality that is common to "goto references", "document highlights" and "rename" (which is not yet implemented). As part of this PR, I also created a new `ReferenceTarget` type which is similar to the existing `NavigationTarget` type but better suited for references. This idea was suggested by @MichaReiser in [this code review feedback](https://github.com/astral-sh/ruff/pull/19475#discussion_r2224061006) from a previous PR. Notably, this new type contains a field that specifies the "kind" of the reference (read, write or other). This "kind" is needed for the document highlights feature. Before: all textual instances of `foo` are highlighted <img width="156" height="126" alt="Screenshot 2025-07-23 at 12 51 09 PM" src="https://github.com/user-attachments/assets/37ccdb2f-d48a-473d-89d5-8e89cb6c394e" /> After: only semantic matches are highlighted <img width="164" height="157" alt="Screenshot 2025-07-23 at 12 52 05 PM" src="https://github.com/user-attachments/assets/2efadadd-4691-4815-af04-b031e74c81b7" /> --------- Co-authored-by: UnboundVariable <unbound@gmail.com>
74 lines
2.4 KiB
Rust
74 lines
2.4 KiB
Rust
use std::borrow::Cow;
|
|
|
|
use lsp_types::request::DocumentHighlightRequest;
|
|
use lsp_types::{DocumentHighlight, DocumentHighlightKind, DocumentHighlightParams, Url};
|
|
use ruff_db::source::{line_index, source_text};
|
|
use ty_ide::{ReferenceKind, document_highlights};
|
|
use ty_project::ProjectDatabase;
|
|
|
|
use crate::document::{PositionExt, ToRangeExt};
|
|
use crate::server::api::traits::{
|
|
BackgroundDocumentRequestHandler, RequestHandler, RetriableRequestHandler,
|
|
};
|
|
use crate::session::DocumentSnapshot;
|
|
use crate::session::client::Client;
|
|
|
|
pub(crate) struct DocumentHighlightRequestHandler;
|
|
|
|
impl RequestHandler for DocumentHighlightRequestHandler {
|
|
type RequestType = DocumentHighlightRequest;
|
|
}
|
|
|
|
impl BackgroundDocumentRequestHandler for DocumentHighlightRequestHandler {
|
|
fn document_url(params: &DocumentHighlightParams) -> Cow<Url> {
|
|
Cow::Borrowed(¶ms.text_document_position_params.text_document.uri)
|
|
}
|
|
|
|
fn run_with_snapshot(
|
|
db: &ProjectDatabase,
|
|
snapshot: DocumentSnapshot,
|
|
_client: &Client,
|
|
params: DocumentHighlightParams,
|
|
) -> crate::server::Result<Option<Vec<DocumentHighlight>>> {
|
|
if snapshot.client_settings().is_language_services_disabled() {
|
|
return Ok(None);
|
|
}
|
|
|
|
let Some(file) = snapshot.file(db) else {
|
|
return Ok(None);
|
|
};
|
|
|
|
let source = source_text(db, file);
|
|
let line_index = line_index(db, file);
|
|
let offset = params.text_document_position_params.position.to_text_size(
|
|
&source,
|
|
&line_index,
|
|
snapshot.encoding(),
|
|
);
|
|
|
|
let Some(highlights_result) = document_highlights(db, file, offset) else {
|
|
return Ok(None);
|
|
};
|
|
|
|
let highlights: Vec<_> = highlights_result
|
|
.into_iter()
|
|
.map(|target| {
|
|
let range = target
|
|
.range()
|
|
.to_lsp_range(&source, &line_index, snapshot.encoding());
|
|
|
|
let kind = match target.kind() {
|
|
ReferenceKind::Read => Some(DocumentHighlightKind::READ),
|
|
ReferenceKind::Write => Some(DocumentHighlightKind::WRITE),
|
|
ReferenceKind::Other => Some(DocumentHighlightKind::TEXT),
|
|
};
|
|
|
|
DocumentHighlight { range, kind }
|
|
})
|
|
.collect();
|
|
|
|
Ok(Some(highlights))
|
|
}
|
|
}
|
|
|
|
impl RetriableRequestHandler for DocumentHighlightRequestHandler {}
|