dbf68e0370
* feat(statusline): add the file type (language id) to the status line
* refactor(statusline): move the statusline implementation into an own struct
* refactor(statusline): split the statusline implementation into different functions
* refactor(statusline): Append elements using a consistent API
This is a preparation for the configurability which is about to be
implemented.
* refactor(statusline): implement render_diagnostics()
This avoid cluttering the render() function and will simplify
configurability.
* feat(statusline): make the status line configurable
* refactor(statusline): make clippy happy
* refactor(statusline): avoid intermediate StatusLineObject
Use a more functional approach to obtain render functions and write to
the buffers, and avoid an intermediate StatusLineElement object.
* fix(statusline): avoid rendering the left elements twice
* refactor(statusline): make clippy happy again
* refactor(statusline): rename `buffer` into `parts`
* refactor(statusline): ensure the match is exhaustive
* fix(statusline): avoid an overflow when calculating the maximal center width
* chore(statusline): Describe the statusline configurability in the book
* chore(statusline): Correct and add documentation
* refactor(statusline): refactor some code following the code review
Avoid very small helper functions for the diagnositcs and inline them
instead.
Rename the config field `status_line` to `statusline` to remain
consistent with `bufferline`.
* chore(statusline): adjust documentation following the config field refactoring
* revert(statusline): revert regression introduced by c0a1870
* chore(statusline): slight adjustment in the configuration documentation
* feat(statusline): integrate changes from #2676 after rebasing
* refactor(statusline): remove the StatusLine struct
Because none of the functions need `Self` and all of them are in an own
file, there is no explicit need for the struct.
* fix(statusline): restore the configurability of color modes
The configuration was ignored after reintegrating the changes of #2676
in
|
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-view | 2 years ago | |
runtime | 2 years ago | |
xtask | 2 years ago | |
.envrc | 3 years ago | |
.gitignore | 2 years ago | |
CHANGELOG.md | 2 years ago | |
Cargo.lock | 2 years ago | |
Cargo.toml | 3 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 | |
rust-toolchain.toml | 2 years ago | |
rustfmt.toml | 3 years ago | |
screenshot.png | 3 years ago | |
shell.nix | 2 years ago | |
theme.toml | 2 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.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(cmd.exe) | xcopy runtime %AppData%/helix/runtime |
windows(powershell) | xcopy runtime $Env: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_RUNTIME
path, it will automatically detect theruntime
directory 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).