My mods of a post-modern modal text editor.
Find a file
Michael Davis 65febe0cf4
Overlay all diagnostics with highest severity on top (#4113)
Here we separate the diagnostics by severity and then overlay the Vec
of spans for each severity on top of the highlights. The error
diagnostics end up overlaid on the warning diagnostics, which are
overlaid on the hints, overlaid on info, overlaid on any other severity
(default), then overlaid on the syntax highlights.

This fixes two things:

* Error diagnostics are now always visible when overlapped with other
  diagnostics.
* Ghost text is eliminated.
    * Ghost text was caused by duplicate diagnostics at the EOF:
      overlaps within the merged `Vec<(usize, Range<usize>)>` violate
      assumptions in `helix_core::syntax::Merge`.
    * When we push a new range, we check it against the last range and
      merge the two if they overlap. This is safe because they both
      have the same severity and therefore highlight.

The actual merge is skipped for any of these when they are empty, so
this is very fast in practice. For some data, I threw together an FPS
counter which renders as fast as possible and logs the renders per
second.

With no diagnostics, I see an FPS gain from this change from 868 FPS
to 878 (+1.1%) on a release build on a Rust file. On an Erlang file
with 12 error diagnostics and 6 warnings in view (233 errors and 66
warnings total), I see a decrease in average FPS from 795 to 790
(-0.6%) on a release build.
2022-10-11 15:46:47 +09:00
.cargo chore: rename .cargo/{config -> config.toml} 2022-09-10 08:44:31 -05:00
.github Document MSRV policy (#3913) 2022-09-23 15:58:00 +09:00
book remove filterting with C-space from picker 2022-10-11 12:25:28 +09:00
contrib fix fish completions for --config & --log (#3912) 2022-09-20 07:35:00 -05:00
docs Document MSRV policy (#3913) 2022-09-23 15:58:00 +09:00
helix-core build(deps): bump smallvec from 1.9.0 to 1.10.0 (#4093) 2022-10-03 18:38:24 -05: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.14.0 to 1.15.0 (#3987) 2022-09-26 18:19:50 -05:00
helix-lsp Find workspace from document path (#3553) 2022-10-04 00:02:49 +09:00
helix-term Overlay all diagnostics with highest severity on top (#4113) 2022-10-11 15:46:47 +09:00
helix-tui build(deps): bump unicode-segmentation from 1.9.0 to 1.10.0 (#3903) 2022-09-19 18:28:38 -05:00
helix-view Add a helper function for applying transactions 2022-10-11 12:17:32 +09:00
runtime Change twig tree-sitter grammar (#4176) 2022-10-10 16:27:14 -05:00
xtask feat: xtask themelint (#3234) 2022-09-19 21:38:20 +08:00
.envrc Work around a nix-direnv issue 2022-02-25 18:01:47 +09:00
.gitattributes Add .gitattributes (#3318) 2022-08-03 08:21:51 -05:00
.gitignore Remove vale from .gitignore 2022-07-26 10:22:28 +09:00
.ignore Add a .ignore file to make ripgrep more useful (#3315) 2022-08-03 09:00:39 -05:00
base16_theme.toml Update theme base16_default (ui.menu) (#2794) 2022-06-17 20:24:18 +09:00
Cargo.lock build(deps): bump serde_json from 1.0.85 to 1.0.86 (#4187) 2022-10-10 18:44:40 -05:00
Cargo.toml remove split-debuginfo setting (#3691) 2022-10-04 00:04:19 +09:00
CHANGELOG.md Fix typos (#3858) 2022-09-17 06:34:48 -05:00
default.nix build(nix): update flake deps, add default.nix file 2022-06-21 17:39:30 -05:00
flake.lock build(nix): update flake deps (#3663) 2022-09-03 13:16:34 +09:00
flake.nix flake: Fix devShell on aarch64-darwin (#3810) 2022-09-13 22:50:53 +09:00
grammars.nix nix: replace runCommandNoCC with runCommand (#3992) 2022-09-27 08:01:58 -05:00
languages.toml Change twig tree-sitter grammar (#4176) 2022-10-10 16:27:14 -05:00
LICENSE Add the LICENSE file. 2021-05-11 01:44:00 +09:00
README.md Add instructions for gnome desktop support using the .desktop file (#4165) 2022-10-10 12:23:36 -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 Changelog notes for 22.08.1 (#3639) 2022-09-01 12:07:46 -05: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 /e /i runtime %AppData%\helix\runtime
Windows (PowerShell) xcopy /e /i 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

Adding Helix to your desktop environment

If installing from source, to use Helix in desktop environments that supports XDG desktop menu, including Gnome and KDE, copy the provided .desktop file to the correct folder:

cp contrib/Helix.desktop ~/.local/share/applications

To use another terminal than the default, you will need to modify the .desktop file. For example, to use kitty:

sed -i "s|Exec=hx %F|Exec=kitty hx %F|g" ~/.local/share/applications/Helix.desktop
sed -i "s|Terminal=true|Terminal=false|g" ~/.local/share/applications/Helix.desktop

Please note: there is no icon for Helix yet, so the system default will be used.

MacOS

Helix can be installed on MacOS through homebrew:

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