A post-modern modal text editor.
Go to file
Michael Davis 43fc073cb3
ci: configure restore-keys for caches (#1806)
`restore-keys` is a configuration option for the actions/cache action
which specifies fallback behavior. The [docs][docs] say it best:

> When a cache miss occurs, the action searches for alternate keys
> called `restore-keys`.
>
> If you provide `restore-keys`, the `cache` action sequentially
> searches for any caches that match the list of `restore-keys`.
> ... If there are no exact matches, the action searches for partial
> matches of the restore keys. When the action finds a partial match,
> the most recent cache is restored to the `path` directory.

So this improves caching when there's a miss. For example if I edit
`.github/workflows/languages.toml`, the current behavior is that the
cache for downloaded grammars will miss and all of them will need to
be fetched again. With `restore-keys`, we use the latest published
cache as 'good enough', we'll fetch whatever grammars changed, and
then at the end we publish a new cache under the new hash.

[docs]: https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#example-using-the-cache-action
2022-03-14 11:44:51 +09:00
.cargo docs: Auto generate command list 2021-12-08 10:23:50 +09:00
.github ci: configure restore-keys for caches (#1806) 2022-03-14 11:44:51 +09:00
book fix #1808 2022-03-14 11:34:21 +09:00
contrib Move themes to runtime/themes, add link from contrib/themes 2021-06-20 00:07:13 +09:00
docs migrate grammar fetching/building code into helix-loader crate 2022-03-10 17:31:57 +09:00
helix-core rename '--fetch/build-grammars' flags into '--grammar fetch/build' 2022-03-10 17:31:57 +09:00
helix-dap Use which to resolve lsp/dap binaries 2022-02-24 11:38:40 +09:00
helix-loader remove stray 'println!' from grammar building function (#1785) 2022-03-11 12:28:34 +09:00
helix-lsp Implement LSP workspace/configuration and workspace/didChangeConfiguration (#1684) 2022-02-28 17:57:22 +09:00
helix-term minor: occurance -> occurrence 2022-03-14 11:43:52 +09:00
helix-tui Highlight matching text in file picker suggestions (#1635) 2022-03-01 10:30:02 +09:00
helix-view build(deps): bump once_cell from 1.9.0 to 1.10.0 (#1768) 2022-03-08 08:55:23 +08:00
runtime C# highlighting improvements (#1795) 2022-03-12 12:06:56 -06:00
xtask Add --health command for troubleshooting (#1669) 2022-03-08 14:25:46 +09:00
.envrc Work around a nix-direnv issue 2022-02-25 18:01:47 +09:00
.gitignore Dynamically load grammar libraries at runtime 2021-07-14 10:00:05 +09:00
base16_theme.toml Add markup support (#1525) 2022-01-23 11:18:50 +09:00
Cargo.lock rename '--fetch/build-grammars' flags into '--grammar fetch/build' 2022-03-10 17:31:57 +09:00
Cargo.toml migrate grammar fetching/building code into helix-loader crate 2022-03-10 17:31:57 +09:00
CHANGELOG.md minor: Fix previous version's header 2022-01-04 19:25:59 +09:00
flake.lock flake: use builtins.fetchTree to shallow-clone grammar repos 2022-03-10 17:31:57 +09:00
flake.nix flake: use builtins.fetchTree to shallow-clone grammar repos 2022-03-10 17:31:57 +09:00
grammars.nix flake: use builtins.fetchTree to shallow-clone grammar repos 2022-03-10 17:31:57 +09:00
languages.toml Add csharp lsp support (#1788) 2022-03-12 09:19:31 +09:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md rename '--fetch/build-grammars' flags into '--grammar fetch/build' 2022-03-10 17:31:57 +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 capture markdown link text as markup.link.text (#1456) 2022-01-09 00:27:50 +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 https://github.com/helix-editor/helix
cd helix
cargo install --path helix-term
hx --grammar fetch
hx --grammar build

This will install the hx binary to $HOME/.cargo/bin and build tree-sitter grammars.

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

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