Helix Mirror
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Mr. E dbf68e0370
Customizable/configurable status line (#2434)
* 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 8d28f95.

* fix(statusline): remove the spinner padding

* refactor(statusline): remove unnecessary format!()
2 years ago
.cargo add integration-test cargo alias 2 years ago
.github add integration-test cargo alias 2 years ago
book Customizable/configurable status line (#2434) 2 years ago
contrib adds --vsplit and --hsplit arguments (#2773) 2 years ago
docs Fix some typos (#2978) 2 years ago
helix-core respect count in treesitter movement (#3058) 2 years ago
helix-dap DAP: Make `cwd` required in RunTerminalArguments 2 years ago
helix-loader build(deps): bump once_cell from 1.12.0 to 1.13.0 (#2969) 2 years ago
helix-lsp lsp: Add workspace/applyEdit to client capabilites (#3012) 2 years ago
helix-term Customizable/configurable status line (#2434) 2 years ago
helix-tui build(deps): bump crossterm from 0.23.0 to 0.24.0 (#2968) 2 years ago
helix-view Customizable/configurable status line (#2434) 2 years ago
runtime Add SCSS language support (#3074) 2 years ago
xtask Add workspace and document diagnostics picker (#2013) 2 years ago
.envrc Work around a nix-direnv issue 3 years ago
.gitignore Fix initial selection of Document in new view 2 years ago
CHANGELOG.md Fix link to `pop-dark` in `CHANGELOG.md` (#2594) 2 years ago
Cargo.lock build(deps): bump regex from 1.5.5 to 1.6.0 (#3041) 2 years ago
Cargo.toml migrate grammar fetching/building code into helix-loader crate 3 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md Add runtime `xcopy` command on powershell in docs (#2958) 2 years ago
VERSION Fix the VERSION file 2 years ago
base16_theme.toml Update theme base16_default (`ui.menu`) (#2794) 2 years ago
default.nix build(nix): update flake deps, add default.nix file 2 years ago
flake.lock nix: update nixCargoIntegration (#2907) 2 years ago
flake.nix nix: pass makeWrapperArgs to wrapProgram (#3003) 2 years ago
grammars.nix chore(nix): format nix files with alejandra, update deps, minor code refactors (#2683) 2 years ago
languages.toml Remove .git extension from SCSS tree-sitter repo url (#3089) 2 years ago
rust-toolchain.toml pin the rust toolchain to 1.61.0 2 years ago
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 3 years ago
screenshot.png update screenshot (#1879) 3 years ago
shell.nix build(nix): update flake deps, add default.nix file 2 years ago
theme.toml Add a default cursorline style for the primary selection 2 years ago

README.md

Helix

Build status

Screenshot

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.

Troubleshooting

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 the runtime 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.

Packaging status

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).