d5f17d3f69
The purpose of this change is to remove the mutable self borrow on
`HighlightIterLayer::sort_key` so that we can sort layers with the
correct ordering using the `Vec::sort` function family.
`HighlightIterLayer::sort_key` needs `&mut self` since it calls
`Peekable::peek` which needs `&mut self`. `Vec::sort` functions
only give immutable borrows of the elements to ensure the
correctness of the sort.
We could instead approach this by creating an eager Peekable and using
that instead of `std::iter::Peekable` to wrap `QueryCaptures`:
```rust
struct EagerPeekable<I: Iterator> {
iter: I,
peeked: Option<I::Item>,
}
impl<I: Iterator> EagerPeekable<I> {
fn new(mut iter: I) -> Self {
let peeked = iter.next();
Self { iter, peeked }
}
fn peek(&self) -> Option<&I::Item> {
self.peeked.as_ref()
}
}
impl<I: Iterator> Iterator for EagerPeekable<I> {
type Item = I::Item;
fn next(&mut self) -> Option<Self::Item> {
std::mem::replace(&mut self.peeked, self.iter.next())
}
}
```
This would be a cleaner approach (notice how `EagerPeekable::peek`
takes `&self` rather than `&mut self`), however this doesn't work in
practice because the Items emitted by the `tree_sitter::QueryCaptures`
Iterator must be consumed before the next Item is returned.
`Iterator::next` on `tree_sitter::QueryCaptures` modifies the
`QueryMatch` returned by the last call of `next`. This behavior is
not currently reflected in the lifetimes/structure of `QueryCaptures`.
This fixes an issue with layers being out of order when using combined
injections since the old code only checked the first range in the
layer. Layers being out of order could cause missing highlights for
combined-injections content.
|
2 years ago | |
|---|---|---|
| .cargo | 2 years ago | |
| .github | 2 years ago | |
| book | 2 years ago | |
| contrib | 2 years ago | |
| docs | 2 years ago | |
| helix-core | 2 years ago | |
| helix-dap | 2 years ago | |
| helix-loader | 2 years ago | |
| helix-lsp | 2 years ago | |
| helix-term | 2 years ago | |
| helix-tui | 2 years ago | |
| helix-vcs | 2 years ago | |
| helix-view | 2 years ago | |
| runtime | 2 years ago | |
| xtask | 2 years ago | |
| .envrc | 3 years ago | |
| .gitattributes | 2 years ago | |
| .gitignore | 2 years ago | |
| .ignore | 2 years ago | |
| CHANGELOG.md | 2 years ago | |
| Cargo.lock | 2 years ago | |
| Cargo.toml | 2 years ago | |
| LICENSE | 4 years ago | |
| README.md | 2 years ago | |
| VERSION | 2 years ago | |
| base16_theme.toml | 2 years ago | |
| default.nix | 2 years ago | |
| flake.lock | 2 years ago | |
| flake.nix | 2 years ago | |
| grammars.nix | 2 years ago | |
| languages.toml | 2 years ago | |
| logo.svg | 2 years ago | |
| logo_dark.svg | 2 years ago | |
| logo_light.svg | 2 years ago | |
| rust-toolchain.toml | 3 years ago | |
| rustfmt.toml | 3 years ago | |
| screenshot.png | 3 years ago | |
| shell.nix | 2 years ago | |
| theme.toml | 2 years ago | |
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
It's a terminal-based editor first, but I'd like to explore a custom renderer (similar to Emacs) in wgpu or skulpin.
Note: Only certain languages have indentation definitions at the moment. Check
runtime/queries/<lang>/ for indents.scm.
Installation
Packages are available for various distributions (see Installation docs).
If you would like to build from source:
git clone https://github.com/helix-editor/helix
cd helix
cargo install --locked --path helix-term
This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars in ./runtime/grammars.
Helix needs its runtime files so make sure to copy/symlink the runtime/ directory into the
config directory (for example ~/.config/helix/runtime on Linux/macOS, or %AppData%/helix/runtime on Windows).
| OS | Command |
|---|---|
| Windows (Cmd) | xcopy /e /i runtime %AppData%\helix\runtime |
| Windows (PowerShell) | xcopy /e /i runtime $Env:AppData\helix\runtime |
| Linux / macOS | ln -s $PWD/runtime ~/.config/helix/runtime |
Starting with Windows Vista you can also create symbolic links on Windows. Note that this requires elevated privileges - i.e. PowerShell or Cmd must be run as administrator.
PowerShell:
New-Item -ItemType SymbolicLink -Target "runtime" -Path "$Env:AppData\helix\runtime"
Cmd:
cd %appdata%\helix
mklink /D runtime "<helix-repo>\runtime"
The runtime location can be overridden via the HELIX_RUNTIME environment variable.
NOTE: if
HELIX_RUNTIMEis set prior to callingcargo install --locked --path helix-term, tree-sitter grammars will be built in$HELIX_RUNTIME/grammars.
If you plan on keeping the repo locally, an alternative to copying/symlinking
runtime files is to set HELIX_RUNTIME=/path/to/helix/runtime
(HELIX_RUNTIME=$PWD/runtime if you're in the helix repo directory).
Packages already solve this for you by wrapping the hx binary with a wrapper
that sets the variable to the install dir.
NOTE: running via cargo also doesn't require setting explicit
HELIX_RUNTIMEpath, it will automatically detect theruntimedirectory in the project root.
If you want to customize your languages.toml config,
tree-sitter grammars may be manually fetched and built with hx --grammar fetch and hx --grammar build.
In order to use LSP features like auto-complete, you will need to install the appropriate Language Server for a language.
Adding Helix to your desktop environment
If installing from source, to use Helix in desktop environments that supports XDG desktop menu, including Gnome and KDE, copy the provided .desktop file to the correct folder:
cp contrib/Helix.desktop ~/.local/share/applications
cp contrib/helix.png ~/.local/share/icons
To use another terminal than the default, you will need to modify the .desktop file. For example, to use kitty:
sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop
macOS
Helix can be installed on macOS through homebrew:
brew install helix
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 @JakeHL for designing the logo!