mirror of https://github.com/helix-editor/helix
a8c82ea5e1
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>).
|
||
|---|---|---|
| .cargo | ||
| .github | ||
| book | ||
| contrib | ||
| docs | ||
| helix-core | ||
| helix-dap | ||
| helix-event | ||
| helix-loader | ||
| helix-lsp | ||
| helix-lsp-types | ||
| helix-parsec | ||
| helix-stdx | ||
| helix-term | ||
| helix-tui | ||
| helix-vcs | ||
| helix-view | ||
| runtime | ||
| xtask | ||
| .envrc | ||
| .gitattributes | ||
| .gitignore | ||
| CHANGELOG.md | ||
| Cargo.lock | ||
| Cargo.toml | ||
| LICENSE | ||
| README.md | ||
| base16_theme.toml | ||
| default.nix | ||
| flake.lock | ||
| flake.nix | ||
| grammars.nix | ||
| languages.toml | ||
| logo.svg | ||
| logo_dark.svg | ||
| logo_light.svg | ||
| rust-toolchain.toml | ||
| rustfmt.toml | ||
| screenshot.png | ||
| shell.nix | ||
| theme.toml | ||
README.md
A Kakoune / Neovim inspired editor, written in Rust.
The editing model is very heavily based on Kakoune; during development I found myself agreeing with most of Kakoune's design decisions.
For more information, see the website or documentation.
All shortcuts/keymaps can be found in the documentation on the website.
Features
- Vim-like modal editing
- Multiple selections
- Built-in language server support
- Smart, incremental syntax highlighting and code editing via tree-sitter
Although it's primarily a terminal-based editor, I am interested in exploring a custom renderer (similar to Emacs) using wgpu or skulpin.
Note: Only certain languages have indentation definitions at the moment. Check
runtime/queries/<lang>/ for indents.scm.
Installation
Contributing
Contributing guidelines can be found here.
Getting help
Your question might already be answered on the FAQ.
Discuss the project on the community Matrix Space (make sure to join #helix-editor:matrix.org if you're on a client that doesn't support Matrix Spaces yet).
Credits
Thanks to @jakenvac for designing the logo!