Unify and clarify config loading

book/src/configuration.md

@@ -26,7 +26,11 @@ hidden = false
 ```
 
 You may also specify a file to use for configuration with the `-c` or
-`--config` CLI argument: `hx -c path/to/custom-config.toml`.
+`--config` CLI argument: `hx -c path/to/custom-config.toml`. 
+
+Finally, you can have a `config.toml` local to a project by putting it under a `.helix` directory in your repository.
+Its settings will be merged with the configuration directory `config.toml` and the built-in configuration,
+if you have enabled the feature under `[editor.security]` in your global configuration.
 
 It is also possible to trigger configuration file reloading by sending the `USR1`
 signal to the helix process, e.g. via `pkill -USR1 hx`. This is only supported 
@@ -50,9 +54,11 @@ on unix operating systems.
 | `auto-completion` | Enable automatic pop up of auto-completion. | `true` |
 | `auto-format` | Enable automatic formatting on save. | `true` |
 | `auto-save` | Enable automatic saving on focus moving away from Helix. Requires [focus event support](https://github.com/helix-editor/helix/wiki/Terminal-Support) from your terminal. | `false` |
+| `load-local-config` | Look for `$PWD/.helix/config.toml` and merge with default and user configuration if it exists.  | `true`  |
 | `idle-timeout` | Time in milliseconds since last keypress before idle timers trigger. Used for autocompletion, set to 0 for instant. | `400` |
 | `completion-trigger-len` | The min-length of word under cursor to trigger autocompletion | `2` |
 | `auto-info` | Whether to display infoboxes | `true` |
+| `sorted-infobox` | Sort infoboxes by key event category rather than by predefined command categories | `false` |
 | `true-color` | Set to `true` to override automatic detection of terminal truecolor support in the event of a false negative. | `false` |
 | `rulers` | List of column positions at which to display the rulers. Can be overridden by language specific `rulers` in `languages.toml` file. | `[]` |
 | `bufferline` | Renders a line at the top of the editor displaying open buffers. Can be `always`, `never` or `multiple` (only shown if more than one buffer is in use) | `never` |

book/src/install.md

@@ -108,8 +108,9 @@ RUSTFLAGS="-C target-feature=-crt-static"
 
 
 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). This location can be overridden
-via the `HELIX_RUNTIME` environment variable.
+config directory (for example `~/.config/helix/runtime` on Linux/macOS). An alternative runtime directory can
+be used by setting the `HELIX_RUNTIME` environment variable. Both runtime directories can be used at the same
+time, with the files residing under the config runtime directory given priority.
 
 | OS                   | Command                                          |
 | -------------------- | ------------------------------------------------ |
@@ -134,11 +135,6 @@ cd %appdata%\helix
 mklink /D runtime "<helix-repo>\runtime"
 ```
 
-The runtime location can be overridden via the `HELIX_RUNTIME` environment variable.
-
-> NOTE: if `HELIX_RUNTIME` is set prior to calling `cargo install --path helix-term --locked`,
-> tree-sitter grammars will be built in `$HELIX_RUNTIME/grammars`.
-
 If you plan on keeping the repo locally, an alternative to copying/symlinking
 runtime files is to set `HELIX_RUNTIME=/path/to/helix/runtime`
 (`HELIX_RUNTIME=$PWD/runtime` if you're in the helix repo directory).

book/src/remapping.md

@@ -49,6 +49,31 @@ c = ":run-shell-command cargo build"
 t = ":run-shell-command cargo test"
 ```
 
+## Custom descriptions
+
+Remapping of singular typable commands or seqences of any commands, can be given a custom description for the keymap menus (infoboxes).
+This is the text on each row that's paired together with each key event trigger.
+
+```toml
+[keys.normal]
+A-k = { description = "Edit Config", exec = ":open ~/.config/helix/config.toml" }
+# (Note that the example example above mostly for illustrative purposes, a :config-open is provided out of the box.)
+"C-r" = { "description" = "Sort selection", "exec" = ["split_selection_on_newline", ":sort", "collapse_selection", "keep_primary_selection"]             }
+```
+
+A custom descriptions can also be defined for sub-menus.
+Aside from being them being shown in the parent-menu infobox,
+sub-menu descriptions also act as infobox titles for the submenu itself.
+
+```toml
+# A submenu accessed though space->f in normal mode.
+[keys.normal.space.f]
+description = "File"
+f = "file_picker"
+s = { description = "Save", exec = ":write" }
+c = { description = "Format", exec = ":format" }
+```
+
 ## Special keys and modifiers
 
 Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes
@@ -76,5 +101,8 @@ Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes
 
 Keys can be disabled by binding them to the `no_op` command.
 
+Making a mode "sticky" can be achieved by adding `sticky = true` to the mapping. 
+(Predefined sticky keytries can like wise be made unsticky with `sticky = false`.)
+
 Commands can be found at [Keymap](https://docs.helix-editor.com/keymap.html) Commands.
 > Commands can also be found in the source code at [`helix-term/src/commands.rs`](https://github.com/helix-editor/helix/blob/master/helix-term/src/commands.rs) at the invocation of `static_commands!` macro and the `TypableCommandList`.

helix-core/Cargo.toml

@@ -17,6 +17,7 @@ integration = []
 [dependencies]
 helix-loader = { version = "0.6", path = "../helix-loader" }
 
+anyhow = "1"
 ropey = { version = "1.6.0", default-features = false, features = ["simd"] }
 smallvec = "1.10"
 smartstring = "1.0.1"

helix-core/src/lib.rs

@@ -3,7 +3,6 @@ pub use encoding_rs as encoding;
 pub mod auto_pairs;
 pub mod chars;
 pub mod comment;
-pub mod config;
 pub mod diagnostic;
 pub mod diff;
 pub mod doc_formatter;

helix-core/src/syntax.rs

@@ -8,6 +8,7 @@ use crate::{
 };
 
 use ahash::RandomState;
+use anyhow;
 use arc_swap::{ArcSwap, Guard};
 use bitflags::bitflags;
 use hashbrown::raw::RawTable;
@@ -60,13 +61,26 @@ fn default_timeout() -> u64 {
 }
 
 #[derive(Debug, Serialize, Deserialize)]
-pub struct Configuration {
+pub struct LanguageConfigurations {
     pub language: Vec<LanguageConfiguration>,
 }
 
-impl Default for Configuration {
+impl LanguageConfigurations {
+    // Local, user config, and system language configs
+    pub fn merged() -> Result<Self, anyhow::Error> {
+        let merged_lang_configs = helix_loader::merged_lang_config()?;
+        merged_lang_configs
+            .try_into()
+            .map_err(|error| anyhow::anyhow!("{}", error))
+    }
+}
+
+impl Default for LanguageConfigurations {
     fn default() -> Self {
-        crate::config::default_syntax_loader()
+        toml::from_str(
+            &std::fs::read_to_string(helix_loader::repo_paths::default_lang_configs()).unwrap(),
+        )
+        .expect("Failed to deserialize built-in languages.toml")
     }
 }
 
@@ -561,7 +575,7 @@ pub struct Loader {
 }
 
 impl Loader {
-    pub fn new(config: Configuration) -> Self {
+    pub fn new(config: LanguageConfigurations) -> Self {
         let mut loader = Self {
             language_configs: Vec::new(),
             language_config_ids_by_extension: HashMap::new(),
@@ -2272,7 +2286,7 @@ mod test {
         "#,
         );
 
-        let loader = Loader::new(Configuration { language: vec![] });
+        let loader = Loader::new(LanguageConfigurations { language: vec![] });
         let language = get_language("rust").unwrap();
 
         let query = Query::new(language, query_str).unwrap();
@@ -2331,7 +2345,7 @@ mod test {
         .map(String::from)
         .collect();
 
-        let loader = Loader::new(Configuration { language: vec![] });
+        let loader = Loader::new(LanguageConfigurations { language: vec![] });
 
         let language = get_language("rust").unwrap();
         let config = HighlightConfiguration::new(
@@ -2434,7 +2448,7 @@ mod test {
     ) {
         let source = Rope::from_str(source);
 
-        let loader = Loader::new(Configuration { language: vec![] });
+        let loader = Loader::new(LanguageConfigurations { language: vec![] });
         let language = get_language(language_name).unwrap();
 
         let config = HighlightConfiguration::new(language, "", "", "").unwrap();

helix-loader/src/grammar.rs

@@ -67,8 +67,9 @@ pub fn get_language(name: &str) -> Result<Language> {
 #[cfg(not(target_arch = "wasm32"))]
 pub fn get_language(name: &str) -> Result<Language> {
     use libloading::{Library, Symbol};
-    let mut library_path = crate::runtime_dir().join("grammars").join(name);
-    library_path.set_extension(DYLIB_EXTENSION);
+    let mut rel_library_path = PathBuf::from("grammars").join(name);
+    rel_library_path.set_extension(DYLIB_EXTENSION);
+    let library_path = crate::get_runtime_file(&rel_library_path);
 
     let library = unsafe { Library::new(&library_path) }
         .with_context(|| format!("Error opening dynamic library {:?}", library_path))?;
@@ -191,7 +192,7 @@ pub fn build_grammars(target: Option<String>) -> Result<()> {
 // merged. The `grammar_selection` key of the config is then used to filter
 // down all grammars into a subset of the user's choosing.
 fn get_grammar_configs() -> Result<Vec<GrammarConfiguration>> {
-    let config: Configuration = crate::config::user_lang_config()
+    let config: Configuration = crate::merged_lang_config()
         .context("Could not parse languages.toml")?
         .try_into()?;
 
@@ -252,7 +253,7 @@ fn fetch_grammar(grammar: GrammarConfiguration) -> Result<FetchStatus> {
         remote, revision, ..
     } = grammar.source
     {
-        let grammar_dir = crate::runtime_dir()
+        let grammar_dir = crate::get_first_runtime_dir()
             .join("grammars")
             .join("sources")
             .join(&grammar.grammar_id);
@@ -350,7 +351,7 @@ fn build_grammar(grammar: GrammarConfiguration, target: Option<&str>) -> Result<
     let grammar_dir = if let GrammarSource::Local { path } = &grammar.source {
         PathBuf::from(&path)
     } else {
-        crate::runtime_dir()
+        crate::get_first_runtime_dir()
             .join("grammars")
             .join("sources")
             .join(&grammar.grammar_id)
@@ -401,7 +402,10 @@ fn build_tree_sitter_library(
             None
         }
     };
-    let parser_lib_path = crate::runtime_dir().join("grammars");
+    let parser_lib_path = crate::get_runtime_dirs()
+        .first()
+        .expect("No runtime directories provided") // guaranteed by post-condition
+        .join("grammars");
     let mut library_path = parser_lib_path.join(&grammar.grammar_id);
     library_path.set_extension(DYLIB_EXTENSION);
 
@@ -511,9 +515,6 @@ fn mtime(path: &Path) -> Result<SystemTime> {
 /// Gives the contents of a file from a language's `runtime/queries/<lang>`
 /// directory
 pub fn load_runtime_file(language: &str, filename: &str) -> Result<String, std::io::Error> {
-    let path = crate::RUNTIME_DIR
-        .join("queries")
-        .join(language)
-        .join(filename);
+    let path = crate::get_runtime_file(&PathBuf::from("queries").join(language).join(filename));
     std::fs::read_to_string(path)
 }