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

aaron404 e8730ca5fd initial implementation of bufferline (#2759 ) * initial implementation of bufferline * fixed lint * changed to 'bufferline', added enum for config modes, some cleanup * fixed lint * added file modification indicator * removed redundant code, added proper themeing with fallback, changed 'file modified' indicator * remove commented code * Update helix-term/src/ui/editor.rs simplify text and offset computation Co-authored-by: Gokul Soumya <gokulps15@gmail.com> * add ui.bufferline.background key for themes Co-authored-by: lazytanuki <43273245+lazytanuki@users.noreply.github.com> * address PR comments * Update helix-term/src/ui/editor.rs * simplify computation of editor area: * change to set_stringn to avoid overflow * Update configuration.md Updates documentation to reflect decision re: defaulting to never showing bufferline. * addressed pr comments * fix build error * address pr comments * revert accidental change Co-authored-by: Gokul Soumya <gokulps15@gmail.com> Co-authored-by: lazytanuki <43273245+lazytanuki@users.noreply.github.com> Co-authored-by: Seth Bromberger <sbromberger@users.noreply.github.com>		2 years ago
.cargo	add integration-test cargo alias	2 years ago
.github	Reword the feature_request issue template as enhancement (#3481 )	2 years ago
book	initial implementation of bufferline (#2759 )	2 years ago
contrib	fix: add elvish completions (#3331 )	2 years ago
docs	packaging: Point to homebrew-core instead of tap (#3513 )	2 years ago
helix-core	Add query-check xtask	2 years ago
helix-dap	DAP: Make `cwd` required in RunTerminalArguments	2 years ago
helix-loader	feat: shorten output for grammar fetching and building (#3396 )	2 years ago
helix-lsp	Advertise WorkspaceSymbolClientCapabilities support (#3361 )	2 years ago
helix-term	initial implementation of bufferline (#2759 )	2 years ago
helix-tui	Update to crossterm-0.25 (#3390 )	2 years ago
helix-view	initial implementation of bufferline (#2759 )	2 years ago
runtime	theme: Add Varua color scheme (#3610 )	2 years ago
xtask	Add query-check xtask	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	Changelog notes for 22.08.1 (#3639 )	2 years ago
Cargo.lock	Update deps	2 years ago
Cargo.toml	migrate grammar fetching/building code into helix-loader crate	3 years ago
LICENSE	Add the LICENSE file.	4 years ago
README.md	packaging: Point to homebrew-core instead of tap (#3513 )	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	nix: update nixCargoIntegration (#2907 )	2 years ago
flake.nix	Only add cargo-tarpaulin on x86_64 (#3252 )	2 years ago
grammars.nix	build(nix): add a way to override what grammars get built (#3141 )	2 years ago
languages.toml	Update tree-sitter-rust to latest	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 runtime %AppData%\helix\runtime`
Windows (PowerShell)	`xcopy /e 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).