A post-modern modal text editor.
Go to file
Thanabodee Charoenpiriyakij e8f800a141
Do not crash when run goto command without line number (#1160)
* Do not crash when run goto command without line number

Report an error when running goto command without entering a
line number.

Fixes #1159

* Use is_empty() instead check len zero
2021-11-25 11:02:51 +09:00
.github Fix bug report template use wrong hx version (#1158) 2021-11-24 20:58:25 +05:30
book Implement no-yank delete/change (#1099) 2021-11-24 16:46:40 +09:00
contrib Move themes to runtime/themes, add link from contrib/themes 2021-06-20 00:07:13 +09:00
docs Add a "vision" document, to help give people a sense of Helix's direction. (#657) 2021-09-02 00:18:56 +09:00
helix-core Jump to end char of surrounding pair from any cursor pos (#1121) 2021-11-20 23:17:25 +09:00
helix-lsp build(deps): bump tokio from 1.13.1 to 1.14.0 (#1146) 2021-11-23 10:07:59 +09:00
helix-syntax glsl support (#993) 2021-11-09 00:48:00 +09:00
helix-term Do not crash when run goto command without line number (#1160) 2021-11-25 11:02:51 +09:00
helix-tui Truncate the starts of file paths instead of the ends in picker (#951) 2021-11-04 12:24:05 +09:00
helix-view File picker config (#988) 2021-11-20 23:23:36 +09:00
runtime Solarized theme: fix popup colors, adjust menu (#1124) 2021-11-20 23:17:38 +09:00
.envrc build(nix): use nix-cargo-integration, make shell.nix use flake devshell 2021-06-13 14:46:51 +09:00
.gitignore Dynamically load grammar libraries at runtime 2021-07-14 10:00:05 +09:00
.gitmodules glsl support (#993) 2021-11-09 00:48:00 +09:00
Cargo.lock build(deps): bump tokio from 1.13.1 to 1.14.0 (#1146) 2021-11-23 10:07:59 +09:00
Cargo.toml Enable thin LTO 2021-11-15 14:38:03 +09:00
CHANGELOG.md Mention CMake support in changelog (#926) 2021-10-28 21:23:13 +09:00
flake.lock Update to rust 1.56 + 2021 edition 2021-10-22 12:15:18 +09:00
flake.nix nix: Update lld to 12 2021-10-24 16:55:43 +09:00
languages.toml Add language: racket (#1143) 2021-11-24 22:47:12 +09:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Fix "good first issue" link (#1140) 2021-11-22 07:16:26 +09:00
rust-toolchain.toml Switch rust-toolchain.toml over to stable 2021-09-08 16:34:04 +09:00
rustfmt.toml Add rustfmt.toml to force formatting to use rustfmt defaults 2021-07-23 18:11:22 +09:00
screenshot.png Add screenshot to README. 2021-05-12 16:52:36 +09:00
shell.nix build(nix): use nix-cargo-integration, make shell.nix use flake devshell 2021-06-13 14:46:51 +09:00
theme.toml fix: #896 broke some of the default highlights 2021-11-08 10:03:53 +09:00
TODO.md Remove some old TODOs 2021-10-27 12:25:00 +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.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). This location can be overriden 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.

Packaging status

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 Helix log file, you must:
    • Print using log::info!, warn!, or error!. (log::info!("helix!"))
    • Pass the appropriate verbosity level option for the desired log level. (hx -v <file> for info, more vs for higher severity inclusive)
  • 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

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