A post-modern modal text editor.
Go to file
Daniel S Poulin b13d44156c
Show infobox to hint textobjects with mi and ma (#1686)
* Show infobox to hint textobjects with `mi` and `ma`

* Add note to infobox than any pair of characters will work too

The wording could probably be a little more clear, but I wanted to
keep it short but still accurate.

* Don't allocate a vec for the static help text

* Fix bug where `mi<esc>` would swallow next input and persist infobox

* Better help text for arbitrary pair matching in textobject selection

* Add way to add fake pending key data below status, use with `mi`/`ma`

This is a bit hacky as it makes use of global state which will end
up managed in multiple places, but has precedent in the way autoinfo
works. There should probably be a bigger refactor to handle this
kind of state better.

* Return early on anything other than `mi` and `ma` for autoinfo

* Remove "ascii" from help text with `mi` and `ma`

* Update helix-term/src/ui/editor.rs

Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
2022-03-01 10:29:22 +09:00
.cargo docs: Auto generate command list 2021-12-08 10:23:50 +09:00
.github Run clippy on all targets (including tests) 2022-01-25 16:37:03 +09:00
book Bring configuration documentation up to date (missing editor.search section) (#1719) 2022-03-01 10:06:14 +09:00
contrib Move themes to runtime/themes, add link from contrib/themes 2021-06-20 00:07:13 +09:00
docs Auto generate docs for language support 2021-12-08 10:23:50 +09:00
helix-core build(deps): bump smartstring from 0.2.10 to 1.0.0 (#1722) 2022-03-01 09:38:44 +09:00
helix-dap Use which to resolve lsp/dap binaries 2022-02-24 11:38:40 +09:00
helix-lsp Implement LSP workspace/configuration and workspace/didChangeConfiguration (#1684) 2022-02-28 17:57:22 +09:00
helix-syntax Add support for HCL language (#1705) 2022-02-25 17:48:20 +09:00
helix-term Show infobox to hint textobjects with mi and ma (#1686) 2022-03-01 10:29:22 +09:00
helix-tui Fix 1.60 lints 2022-02-25 13:06:11 +09:00
helix-view Show infobox to hint textobjects with mi and ma (#1686) 2022-03-01 10:29:22 +09:00
runtime chore(theme): fix "ui.selection" for rose_pine themes (#1716) 2022-02-28 17:56:03 +09:00
xtask Replace tendril with smartstring 2022-02-10 11:12:47 +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
.gitmodules Add support for HCL language (#1705) 2022-02-25 17:48:20 +09:00
base16_theme.toml Add markup support (#1525) 2022-01-23 11:18:50 +09:00
Cargo.lock build(deps): bump smartstring from 0.2.10 to 1.0.0 (#1722) 2022-03-01 09:38:44 +09:00
Cargo.toml Add an optimised release profile 2022-02-25 18:01:41 +09:00
CHANGELOG.md minor: Fix previous version's header 2022-01-04 19:25:59 +09:00
flake.lock Update to rust 1.58, fix a bunch of optional lints 2022-01-16 14:19:48 +09:00
flake.nix fix: nix flake build 2022-02-15 10:12:37 +09:00
languages.toml Add support for HCL language (#1705) 2022-02-25 17:48:20 +09:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Readme: fix typo (#1695) 2022-02-22 21:31:19 +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
TODO.md Remove some TODOs 2022-01-23 16:10:36 +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, 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).