mirrors/helix
1
0
Fork 0
mirror of https://github.com/helix-editor/helix.git synced 2025-04-03 10:57:48 +03:00
Code Issues Projects Releases Packages Wiki Activity
helix/helix-lsp-types
History
Exact
Michael Davis a8c82ea5e1
Add generic Range and Diagnostic types in helix-view 
This introduces another `Range` type which is an enum: either the
(character) indices in a rope or a wrapper around `lsp::Range` - the
positions in the document according to the position encoding.

Internally we always use character (typically) or byte indices into the
text to represent positions into the text. LSP however uses row and
column counts where the column meaning depends on the position encoding
negotiated with the server. This makes it difficult to have concepts
like `Diagnostic` be generic between an internal feature (for example
spell checking errors) and LSP. The solution here is direct: use an enum
that represents either format of describing a range of positions.

This change introduces that `Range` and uses it for two purposes:

* `Diagnostic` has been rewritten and moved from helix-core to
  helix-view. The diagnostic type in `helix_view::document` is now a
  wrapper around `helix_view::Diagnostic`, tracking the actual ranges
  into the document.
* The `Location` type in `commands::lsp` has been refactored to use this
  range instead of directly using `lsp::Range`.

The point of this is to support emitting features like diagnostics and
symbols using internal features like a spell checker and tree-sitter
(respectively). Now the spell checking integration can attach
diagnostics itself, roughly like so:

    let provider = DiagnosticProvider::Spelling;
    let diagnostics = /* find spelling mistakes */
        .map(|(word, range)| {
            helix_view::Diagnostic {
                message: format!("Possible spelling mistake '{word}'"),
                severity: Some(Severity::Hint),
                range: helix_view::Range::Document(range),
                provider: provider.clone(),
                ..Default::default()
            }
        })
        .collect();
    editor.handle_diagnostics(
        provider,
        uri,
        Some(doc_version),
        diagnostics,
    );

In addition we can use this to build tree-sitter based symbol pickers
(also see <https://redirect.github.com/helix-editor/helix/pull/12275>).
2025-03-24 09:17:13 -04:00
..
src Add generic Range and Diagnostic types in helix-view 2025-03-24 09:17:13 -04:00
Cargo.toml build(deps): bump the rust-dependencies group with 5 updates (#13070) 2025-03-11 08:29:38 -05:00
LICENSE Vendor the lsp-types crate 2024-07-28 10:41:28 -04:00
README.md Vendor the lsp-types crate 2024-07-28 10:41:28 -04:00

README.md

Helix's lsp-types

This is a fork of the lsp-types crate (gluon-lang/lsp-types) taken at version v0.95.1 (commit 3e6daee). This fork focuses usability improvements that make the types easier to work with for the Helix codebase. For example the URL type - the uri crate at this version of lsp-types - will be replaced with a wrapper around a string.