fbb98300df
The submodules system is being replaced with a command-line flag
hx --fetch-grammars
Which shallow-clones grammar repositories at the given revision and
hx --build-grammars
For building grammars separate of the initial compilation of helix.
Why remove submodules?
* Cloning helix in general takes a long time because of the submodules,
especially when the submodules are not fetched as shallow
* Packaging is consistently painful no matter the package-manager
* It is quite difficult to devise a scheme where users can declare
a desired set of grammars and implement it with submodules
This commit fully removes the existing tree-sitter submodules from
the tree (as well as the .gitmodules file which is no longer used).
|
3 years ago | |
|---|---|---|
| .cargo | 3 years ago | |
| .github | 3 years ago | |
| book | 3 years ago | |
| contrib | 3 years ago | |
| docs | 3 years ago | |
| helix-core | 3 years ago | |
| helix-dap | 3 years ago | |
| helix-lsp | 3 years ago | |
| helix-syntax | 3 years ago | |
| helix-term | 3 years ago | |
| helix-tui | 3 years ago | |
| helix-view | 3 years ago | |
| runtime | 3 years ago | |
| xtask | 3 years ago | |
| .envrc | 3 years ago | |
| .gitignore | 3 years ago | |
| CHANGELOG.md | 3 years ago | |
| Cargo.lock | 3 years ago | |
| Cargo.toml | 3 years ago | |
| LICENSE | 4 years ago | |
| README.md | 3 years ago | |
| base16_theme.toml | 3 years ago | |
| flake.lock | 3 years ago | |
| flake.nix | 3 years ago | |
| languages.toml | 3 years ago | |
| rust-toolchain.toml | 3 years ago | |
| rustfmt.toml | 3 years ago | |
| screenshot.png | 4 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).