c1f90a127b
Here we add syntax to the languages.toml languge
[[grammar]]
name = "<name>"
source = { .. }
Which can be used to specify a tree-sitter grammar separately of
the language that defines it, and we make this distinction for
two reasons:
* In later commits, we will separate this code from helix-core
and bring it to a new helix-loader crate. Using separate schemas
for language and grammar configurations allows for a nice divide
between the types needed to be declared in helix-loader and in
helix-core/syntax
* Two different languages may use the same grammar. This is currently
the case with llvm-mir-yaml and yaml. We could accomplish a config
that works for this with just `[[languages]]`, but it gets a bit
dicey with languages depending on one another. If you enable
llvm-mir-yaml and disable yaml, does helix still need to fetch and
build tree-sitter-yaml? It could be a matter of interpretation.
|
2 years ago | |
|---|---|---|
| .cargo | 3 years ago | |
| .github | 2 years ago | |
| book | 2 years ago | |
| contrib | 3 years ago | |
| docs | 2 years ago | |
| helix-core | 2 years ago | |
| helix-dap | 2 years ago | |
| helix-lsp | 2 years ago | |
| helix-syntax | 2 years ago | |
| helix-term | 2 years ago | |
| helix-tui | 2 years ago | |
| helix-view | 2 years ago | |
| runtime | 2 years ago | |
| xtask | 2 years ago | |
| .envrc | 2 years ago | |
| .gitignore | 3 years ago | |
| CHANGELOG.md | 3 years ago | |
| Cargo.lock | 2 years ago | |
| Cargo.toml | 2 years ago | |
| LICENSE | 3 years ago | |
| README.md | 2 years ago | |
| base16_theme.toml | 2 years ago | |
| flake.lock | 2 years ago | |
| flake.nix | 2 years ago | |
| languages.toml | 2 years ago | |
| rust-toolchain.toml | 3 years ago | |
| rustfmt.toml | 3 years ago | |
| screenshot.png | 3 years ago | |
| shell.nix | 3 years ago | |
| theme.toml | 3 years ago | |
README.md
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.toml.
Installation
We provide packaging for various distributions, but here's a quick method to build from source.
git clone --recurse-submodules --shallow-submodules -j8 https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term
This will install the hx binary to $HOME/.cargo/bin.
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).
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.
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).