6e2aaed5c2
* Refactor menu::Item to accomodate external state Will be useful for storing editor state when reused by pickers. * Add some type aliases for readability * Reuse menu::Item trait in picker This opens the way for merging the menu and picker code in the future, since a picker is essentially a menu + prompt. More excitingly, this change will also allow aligning items in the picker, which would be useful (for example) in the command palette for aligning the descriptions to the left and the keybinds to the right in two separate columns. The item formatting of each picker has been kept as is, even though there is room for improvement now that we can format the data into columns, since that is better tackled in a separate PR. * Rename menu::Item::EditorData to Data * Call and inline filter_text() in sort_text() completion * Rename diagnostic picker's Item::Data |
||
|---|---|---|
| .cargo | ||
| .github | ||
| book | ||
| contrib | ||
| docs | ||
| helix-core | ||
| helix-dap | ||
| helix-loader | ||
| helix-lsp | ||
| helix-term | ||
| helix-tui | ||
| helix-view | ||
| runtime | ||
| xtask | ||
| .envrc | ||
| .gitignore | ||
| base16_theme.toml | ||
| Cargo.lock | ||
| Cargo.toml | ||
| CHANGELOG.md | ||
| default.nix | ||
| flake.lock | ||
| flake.nix | ||
| grammars.nix | ||
| languages.toml | ||
| LICENSE | ||
| README.md | ||
| rust-toolchain.toml | ||
| rustfmt.toml | ||
| screenshot.png | ||
| shell.nix | ||
| theme.toml | ||
| VERSION | ||
Helix
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 --path helix-term
This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars.
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.
Helix also 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 | xcopy runtime %AppData%/helix/runtime |
| linux/macos | ln -s $PWD/runtime ~/.config/helix/runtime |
This location can be overridden via the HELIX_RUNTIME environment variable.
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.
In order to use LSP features like auto-complete, you will need to install the appropriate Language Server for a language.
MacOS
Helix can be installed on MacOS through homebrew via:
brew tap helix-editor/helix
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).