69fe46a122
* Disable deleting from an empty buffer which can cause a crash. * Improve on the fix for deleting from the end of the buffer. * Clean up leftover log. * Avoid theoretical underflow. * Implement :before which accepts a time interval and moves the editor to the closest history state to the commit of the current time minus that interval. Current time is now by default, or the commit time if :before has just been used. * Add :earlier an :later commands that can move through the edit history and retrieve changes hidded by undoing and commiting new changes. The commands accept a number of steps or a time period relative to the currrent change. * Fix clippy lint error. * Remove the dependency on parse_duration, add a custom parser instead. * Fix clippy errors. * Make helix_core::history a public module. * Use the helper for getting the current document and view. * Handled some PR comments. * Fix the logic in :later n. Co-authored-by: Ivan Tham <pickfire@riseup.net> * Add an alias for :earlier. Co-authored-by: Ivan Tham <pickfire@riseup.net> * Add an alias for later. Co-authored-by: Ivan Tham <pickfire@riseup.net> * Run cargo fmt. * Add some tests for earlier and later. * Add more tests and restore the fix for later that diappeared somehow. * Use ? instead of a match on an option. Co-authored-by: Ivan Tham <pickfire@riseup.net> * Rename to UndoKind. * Remove the leftover match. * Handle a bunch of review comments. * More systemd.time compliant time units and additional description for the new commands. * A more concise rewrite of the time span parser using ideas from PR discussion. * Replace a match with map_err(). Co-authored-by: Ivan Tham <pickfire@riseup.net> Co-authored-by: Jakub Bartodziej <jqb@google.com> Co-authored-by: Ivan Tham <pickfire@riseup.net> |
4 years ago | |
|---|---|---|
| .github | 4 years ago | |
| book | 4 years ago | |
| contrib/themes | 4 years ago | |
| docs | 4 years ago | |
| helix-core | 4 years ago | |
| helix-lsp | 4 years ago | |
| helix-syntax | 4 years ago | |
| helix-term | 4 years ago | |
| helix-tui | 4 years ago | |
| helix-view | 4 years ago | |
| runtime/queries | 4 years ago | |
| .envrc | 4 years ago | |
| .gitignore | 4 years ago | |
| .gitmodules | 4 years ago | |
| Cargo.lock | 4 years ago | |
| Cargo.toml | 4 years ago | |
| LICENSE | 4 years ago | |
| README.md | 4 years ago | |
| TODO.md | 4 years ago | |
| flake.lock | 4 years ago | |
| flake.nix | 4 years ago | |
| languages.toml | 4 years ago | |
| screenshot.png | 4 years ago | |
| shell.nix | 4 years ago | |
| theme.toml | 4 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.
Installation
Note: Only certain languages have indentation definitions at the moment. Check
runtime/<lang>/ for indents.toml.
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.
Now copy the runtime/ directory somewhere. Helix will by default look for the
runtime inside the same folder as the executable, but that can be overriden via
the HELIX_RUNTIME environment variable.
NOTE: You should set this to /runtime in development (if running via cargo).
export HELIX_RUNTIME=$PWD/runtime
If you want to embed the runtime/ directory into the Helix binary you can build
it with:
cargo install --path helix-term --features "embed_runtime"
Arch Linux
There are two packages available from AUR:
helix-bin: contains prebuilt binary from GitHub releaseshelix-git: builds the master branch of this repository
MacOS
Helix can be installed on MacOS through homebrew via:
brew tap helix-editor/helix
brew install helix
Contributing
Contributors are very welcome! No contribution is too small and all contributions are valued.
Some suggestions to get started:
- You can look at the good first issue label on the issue tracker.
- Help with packaging on various distributions needed!
- To use print debugging to the
~/.cache/helix/helix.logfile, you must:- Print using
log::info!,warn!, orerror!. (log::info!("helix!")) - Pass the appropriate verbosity level option for the desired log level. (
hx -v <file>for info, morevs for higher severity inclusive)
- Print using
- If your preferred language is missing, integrating a tree-sitter grammar for it and defining syntax highlight queries for it is straight forward and doesn't require much knowledge of the internals.
We provide an architecture.md that should give you a good overview of the internals.
Getting help
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).