Helix Mirror
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
paul-scott ce1fb9e64c
Generalised to multiple runtime directories with priorities (#5411)
* Generalised to multiple runtime directories with priorities

This is an implementation for #3346.

Previously, one of the following runtime directories were used:

1. `$HELIX_RUNTIME`
2. sibling directory to `$CARGO_MANIFEST_DIR`
3. subdirectory of user config directory
4. subdirectory of path to helix executable

The first directory provided / found to exist in this order was used as a
root for all runtime file searches (grammars, themes, queries).

This change lowers the priority of `$HELIX_RUNTIME` so that the user
config runtime has higher priority. More significantly, all of these
directories are now searched for runtime files, enabling a user to override
default or system-level runtime files. If the same file name appears
in multiple runtime directories, the following priority is now used:

1. sibling directory to `$CARGO_MANIFEST_DIR`
2. subdirectory of user config directory
3. `$HELIX_RUNTIME`
4. subdirectory of path to helix executable

One exception to this rule is that a user can have a `themes`
directory directly in the user config directory that has higher piority
to `themes` directories in runtime directories. That behaviour has been
preserved.

As part of implementing this feature `theme::Loader` was simplified
and the cycle detection logic of the theme inheritance was improved to
cover more cases and to be more explicit.

* Removed AsRef usage to avoid binary growth

* Health displaying ;-separated runtime dirs

* Changed HELIX_RUNTIME build from src instructions

* Updated doc for more detail on runtime directories

* Improved health symlink printing and theme cycle errors

The health display of runtime symlinks now prints both ends of the
link.

Separate errors are given when theme file is not found and when the
only theme file found would form an inheritence cycle.

* Satisfied clippy on passing Path

* Clarified highest priority runtime directory purpose

* Further clarified multiple runtime details in book

Also gave markdown headings to subsections.

Fixed a error with table indentation not building
table that also appears present on master.

---------

Co-authored-by: Paul Scott <paul.scott@anu.edu.au>
Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
2 years ago
.cargo enable rendering in integration tests (#5819) 2 years ago
.github update MSRV to 1.65 2 years ago
book Generalised to multiple runtime directories with priorities (#5411) 2 years ago
contrib Add Appstream metadata file (#5643) 2 years ago
docs Expand contributing docs (#5967) 2 years ago
helix-core Fix `shrink_selection` with multiple cursors. (#6093) 2 years ago
helix-dap feat(dap): implement Restart request (#5651) 2 years ago
helix-loader Generalised to multiple runtime directories with priorities (#5411) 2 years ago
helix-lsp LSP: Support textDocument/prepareRename (#6103) 2 years ago
helix-parsec Remove now unused the pattern combinator 2 years ago
helix-term Generalised to multiple runtime directories with priorities (#5411) 2 years ago
helix-tui tui: Log keyboard enhancement query time 2 years ago
helix-vcs Add command for resetting diff hunks (#5736) 2 years ago
helix-view Generalised to multiple runtime directories with priorities (#5411) 2 years ago
runtime feat(theme): Update pop-dark statusline (#6227) 2 years ago
xtask Fix new clippy lints (#5892) 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 Add changelog notes for 22.12 (#4822) 2 years ago
Cargo.lock store multiple snapshots on the document at once 2 years ago
Cargo.toml Add a parser-combinator crate 2 years ago
LICENSE Add the LICENSE file. 4 years ago
README.md Rewrite and refactor all documentation (#5534) 2 years ago
VERSION Add changelog notes for 22.12 (#4822) 2 years ago
base16_theme.toml Set ui.text.inactive for official themes 2 years ago
default.nix build(nix): update flake deps, add default.nix file 2 years ago
flake.lock build(nix): fix devshell 2 years ago
flake.nix build(nix): fix devshell 2 years ago
grammars.nix nix: replace `runCommandNoCC` with `runCommand` (#3992) 2 years ago
languages.toml Softwrapping improvements (#5893) 2 years ago
logo.svg Add the new logo! 2 years ago
logo_dark.svg Add logo with text included (#4973) 2 years ago
logo_light.svg Add logo with text included (#4973) 2 years ago
rust-toolchain.toml update MSRV to 1.65 2 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 `markup.strikethrough` theme keys (#5619) 2 years ago

README.md

Helix

Build status GitHub Release Documentation GitHub contributors Matrix Space

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

Installation documentation.

Packaging status

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

Credits

Thanks to @JakeHL for designing the logo!