1
0
mirror of https://github.com/helix-editor/helix synced 2024-11-10 10:34:45 +01:00
A post-modern modal text editor. https://helix-editor.com
Go to file
Triton171 58758fee61
Indentation rework (#1562)
* WIP: Rework indentation system

* Add ComplexNode for context-aware indentation (including a proof of concept for assignment statements in rust)

* Add switch statements to Go indents.toml (fixes the second half of issue #1523)
Remove commented-out code

* Migrate all existing indentation queries.
Add more options to ComplexNode and use them to improve C/C++ indentation.

* Add comments & replace Option<Vec<_>> with Vec<_>

* Add more detailed documentation for tree-sitter indentation

* Improve code style in indent.rs

* Use tree-sitter queries for indentation instead of TOML config.
Migrate existing indent queries.

* Add documentation for the new indent queries.
Change xtask docgen to look for indents.scm instead of indents.toml

* Improve code style in indent.rs.
Fix an issue with the rust indent query.

* Move indentation test sources to separate files.
Add `#not-kind-eq?`, `#same-line?` and `#not-same-line` custom predicates.
Improve the rust and c indent queries.

* Fix indent test.
Improve rust indent queries.

* Move indentation tests to integration test folder.

* Improve code style in indent.rs.
Reuse tree-sitter cursors for indentation queries.

* Migrate HCL indent query

* Replace custom loading in indent tests with a designated languages.toml

* Update indent query file name for --health command.

* Fix single-space formatting in indent queries.

* Add explanation for unwrapping.

Co-authored-by: Triton171 <triton0171@gmail.com>
2022-03-31 00:08:07 +09:00
.cargo
.github publish a source tarball with version and grammars (#1875) 2022-03-29 14:34:19 +09:00
book Indentation rework (#1562) 2022-03-31 00:08:07 +09:00
contrib
docs
helix-core Indentation rework (#1562) 2022-03-31 00:08:07 +09:00
helix-dap
helix-loader Avoid using the format ident Rust feature (#1881) 2022-03-30 09:08:30 +09:00
helix-lsp
helix-term Indentation rework (#1562) 2022-03-31 00:08:07 +09:00
helix-tui
helix-view fix: Don't rely on FormattingOptions::default() 2022-03-30 15:19:21 +09:00
runtime Indentation rework (#1562) 2022-03-31 00:08:07 +09:00
xtask
.envrc
.gitignore
base16_theme.toml
Cargo.lock
Cargo.toml
CHANGELOG.md changelog notes for 22.03 (#1830) 2022-03-29 22:15:00 +09:00
flake.lock
flake.nix
grammars.nix
languages.toml add tree-sitter-gleam 2022-03-30 13:24:53 +09:00
LICENSE
README.md
rust-toolchain.toml
rustfmt.toml
screenshot.png update screenshot (#1879) 2022-03-30 00:16:57 +09:00
shell.nix
theme.toml
VERSION publish a source tarball with version and grammars (#1875) 2022-03-29 14:34:19 +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).