Fork of helix with some PRs merged

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Michael Davis 6cca7375ec Automatically track pseudo-pending text (#4077 ) This change automatically tracks pending text for for commands which use on-next-key callbacks. For example, `t` will await the next key event and "t" will be shown in the bottom right-hand corner to show that we're in a pending state. Previously, the text for these on-next-key commands needed to be hard-coded into the command definition which had some drawbacks: * It was easy to forget to write and clear the pending text. * If a command was remapped in a custom config, the pending text would still show the old key. With this change, pending text is automatically tracked based on the key events that lead to the command being executed. This works even when the command is remapped in config and when the on-next-key callback is nested under some key sequence (for example `mi`).		2 years ago
.cargo	chore: rename `.cargo/{config -> config.toml}`	2 years ago
.github	Document MSRV policy (#3913 )	2 years ago
book	respond to SIGUSR1 by reloading config (#3952 )	2 years ago
contrib	fix fish completions for --config & --log (#3912 )	2 years ago
docs	Document MSRV policy (#3913 )	2 years ago
helix-core	Use requested direction for new textobject selection range	2 years ago
helix-dap	DAP: Make `cwd` required in RunTerminalArguments	2 years ago
helix-loader	build(deps): bump once_cell from 1.14.0 to 1.15.0 (#3987 )	2 years ago
helix-lsp	Find workspace from document path (#3553 )	2 years ago
helix-term	Automatically track pseudo-pending text (#4077 )	2 years ago
helix-tui	build(deps): bump unicode-segmentation from 1.9.0 to 1.10.0 (#3903 )	2 years ago
helix-view	Automatically track pseudo-pending text (#4077 )	2 years ago
runtime	Keep arrow and special keys in insert (#3915 )	2 years ago
xtask	feat: xtask themelint (#3234 )	2 years ago
.envrc	Work around a nix-direnv issue	3 years ago
.gitattributes	Add .gitattributes (#3318 )	2 years ago
.gitignore	Remove vale from .gitignore	2 years ago
.ignore	Add a .ignore file to make ripgrep more useful (#3315 )	2 years ago
CHANGELOG.md	Fix typos (#3858 )	2 years ago
Cargo.lock	Inherit theme (#3067 )	2 years ago
Cargo.toml	remove `split-debuginfo` setting (#3691 )	2 years ago
LICENSE	Add the LICENSE file.	4 years ago
README.md	Fix typos (#3858 )	2 years ago
VERSION	Changelog notes for 22.08.1 (#3639 )	2 years ago
base16_theme.toml	Update theme base16_default (`ui.menu`) (#2794 )	2 years ago
default.nix	build(nix): update flake deps, add default.nix file	2 years ago
flake.lock	build(nix): update flake deps (#3663 )	2 years ago
flake.nix	flake: Fix devShell on aarch64-darwin (#3810 )	2 years ago
grammars.nix	nix: replace `runCommandNoCC` with `runCommand` (#3992 )	2 years ago
languages.toml	Update treesitter markdown (#4078 )	2 years ago
rust-toolchain.toml	pin the rust toolchain to 1.61.0	3 years ago
rustfmt.toml	Add rustfmt.toml to force formatting to use rustfmt defaults	3 years ago
screenshot.png	update screenshot (#1879 )	3 years ago
shell.nix	build(nix): update flake deps, add default.nix file	2 years ago
theme.toml	Add a default cursorline style for the primary selection	2 years ago

README.md

Helix

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.

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