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` |
@@ -307,4 +313,4 @@ Currently unused
 
 #### `[editor.gutters.spacer]` Section
 
-Currently unused
+Currently unused

helix-core/Cargo.toml

@@ -17,6 +17,7 @@ integration = []
 [dependencies]
 helix-loader = { version = "0.6", path = "../helix-loader" }
 
+anyhow = "1"
 ropey = { version = "1.5.1", 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 graphemes;

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,24 @@ 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 +573,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(),
@@ -2278,7 +2290,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();
@@ -2337,7 +2349,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(
@@ -2440,7 +2452,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-core/tests/indent.rs

@@ -28,8 +28,8 @@ fn test_treesitter_indent(file_name: &str, lang_scope: &str) {
 
     let mut config_file = test_dir;
     config_file.push("languages.toml");
-    let config = std::fs::read(config_file).unwrap();
-    let config = toml::from_slice(&config).unwrap();
+    let config = std::fs::read_to_string(config_file).unwrap();
+    let config = toml::from_str(&config).unwrap();
     let loader = Loader::new(config);
 
     // set runtime path so we can find the queries

helix-loader/src/grammar.rs

@@ -191,7 +191,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()?;
 
@@ -511,7 +511,7 @@ 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
+    let path = crate::runtime_dir()
         .join("queries")
         .join(language)
         .join(filename);