My mods of a post-modern modal text editor.
Find a 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!()
2022-07-18 09:57:01 +09:00
.cargo add integration-test cargo alias 2022-06-18 23:57:47 -04:00
.github add integration-test cargo alias 2022-06-18 23:57:47 -04:00
book Customizable/configurable status line (#2434) 2022-07-18 09:57:01 +09:00
contrib adds --vsplit and --hsplit arguments (#2773) 2022-07-01 18:27:32 +09:00
docs Fix some typos (#2978) 2022-07-05 21:49:54 -05:00
helix-core respect count in treesitter movement (#3058) 2022-07-14 08:08:09 +08:00
helix-dap DAP: Make cwd required in RunTerminalArguments 2022-07-05 12:34:03 +02:00
helix-loader build(deps): bump once_cell from 1.12.0 to 1.13.0 (#2969) 2022-07-05 11:04:03 +08:00
helix-lsp lsp: Add workspace/applyEdit to client capabilites (#3012) 2022-07-09 07:31:15 +09:00
helix-term Customizable/configurable status line (#2434) 2022-07-18 09:57:01 +09:00
helix-tui build(deps): bump crossterm from 0.23.0 to 0.24.0 (#2968) 2022-07-05 19:30:33 +09:00
helix-view Customizable/configurable status line (#2434) 2022-07-18 09:57:01 +09:00
runtime Add SCSS language support (#3074) 2022-07-17 17:55:20 +08:00
xtask Add workspace and document diagnostics picker (#2013) 2022-06-30 18:16:18 +09:00
.envrc Work around a nix-direnv issue 2022-02-25 18:01:47 +09:00
.gitignore Fix initial selection of Document in new view 2022-06-18 23:54:03 -04:00
base16_theme.toml Update theme base16_default (ui.menu) (#2794) 2022-06-17 20:24:18 +09:00
Cargo.lock build(deps): bump regex from 1.5.5 to 1.6.0 (#3041) 2022-07-12 11:17:24 +09:00
Cargo.toml migrate grammar fetching/building code into helix-loader crate 2022-03-10 17:31:57 +09:00
CHANGELOG.md Fix link to pop-dark in CHANGELOG.md (#2594) 2022-05-28 13:11:31 -05:00
default.nix build(nix): update flake deps, add default.nix file 2022-06-21 17:39:30 -05:00
flake.lock nix: update nixCargoIntegration (#2907) 2022-06-29 17:53:56 +09:00
flake.nix nix: pass makeWrapperArgs to wrapProgram (#3003) 2022-07-09 11:17:44 -05:00
grammars.nix chore(nix): format nix files with alejandra, update deps, minor code refactors (#2683) 2022-06-06 14:24:52 -05:00
languages.toml Remove .git extension from SCSS tree-sitter repo url (#3089) 2022-07-17 21:41:05 +05:30
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Add runtime xcopy command on powershell in docs (#2958) 2022-07-04 12:32:46 -05:00
rust-toolchain.toml pin the rust toolchain to 1.61.0 2022-05-24 01:05:19 +09:00
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 2021-07-23 18:11:22 +09:00
screenshot.png update screenshot (#1879) 2022-03-30 00:16:57 +09:00
shell.nix build(nix): update flake deps, add default.nix file 2022-06-21 17:39:30 -05:00
theme.toml Add a default cursorline style for the primary selection 2022-06-27 17:27:24 +09:00
VERSION Fix the VERSION file 2022-05-29 01:07:30 +09:00

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