My mods of a post-modern modal text editor.
Find a file
Gokul Soumya 394629ab73 Skip enclosed pairs in surround
Surround operations previously ignored other pairs that are
enclosed within which should be skipped. For example if the
cursor is on the `,` in `{{a},{b}}`, doing `md{` previously
would delete the `{` on the left of `a` and `}` on the right
of `b` instead of the outermost braces. This commit corrects
this behavior.
2021-06-24 13:02:56 +09:00
.github Bump actions/upload-artifact from 2.2.3 to 2.2.4 2021-06-22 09:25:29 +09:00
book Refactor, add ui.cursor.primary 2021-06-23 21:55:02 +09:00
contrib Move themes to runtime/themes, add link from contrib/themes 2021-06-20 00:07:13 +09:00
docs Update architecture.md 2021-05-30 17:52:46 +09:00
helix-core Skip enclosed pairs in surround 2021-06-24 13:02:56 +09:00
helix-lsp Merge pull request #224 from helix-editor/line_ending_detection 2021-06-22 11:09:19 +09:00
helix-syntax Run cargo-diet 2021-06-19 10:04:59 +09:00
helix-term Fix picker item width overflow 2021-06-24 12:00:08 +09:00
helix-tui Merge branch 'master' of github.com:helix-editor/helix into line_ending_detection 2021-06-20 16:09:14 -07:00
helix-view add missing doc 2021-06-23 15:40:27 +09:00
runtime Move themes to runtime/themes, add link from contrib/themes 2021-06-20 00:07:13 +09:00
.envrc build(nix): use nix-cargo-integration, make shell.nix use flake devshell 2021-06-13 14:46:51 +09:00
.gitattributes Handle non-UTF8 files 2021-06-23 15:40:27 +09:00
.gitignore ignore Nix outputs 2021-06-10 22:00:53 +09:00
.gitmodules Add latex 2021-06-16 21:42:05 +09:00
Cargo.lock Handle non-UTF8 files 2021-06-23 15:40:27 +09:00
Cargo.toml Inline tui as helix-tui fork. 2021-05-09 17:52:55 +09:00
flake.lock build(nix): fetch submodules lazily 2021-06-22 13:29:13 +09:00
flake.nix build(nix): fetch submodules lazily 2021-06-22 13:29:13 +09:00
languages.toml Use pep 8 indentation for python 2021-06-21 08:50:51 -07:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Add repology.org packaging status 2021-06-23 01:05: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 Remove duplicate properties from theme.toml 2021-06-24 09:23:23 +08:00
TODO.md minor: Remove old TODOs 2021-06-22 23:26:34 +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

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 config directory or the same directory as executable, but that can be overriden via the HELIX_RUNTIME environment variable.

NOTE: running via cargo doesn't require setting explicit HELIX_RUNTIME path, it will automatically detect the runtime directory in the project root.

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"

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 ~/.cache/helix/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

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