diff options
author | Yusuf Bera Ertan | 2021-08-26 15:29:14 +0000 |
---|---|---|
committer | GitHub | 2021-08-26 15:29:14 +0000 |
commit | dc57f8dc89e4d4d58e9af836690c0929a2092439 (patch) | |
tree | 5b356341742e2e08f369553a8c718285d7bd4f25 | |
parent | 4bafda3995be01b4624469a4ba305e3d019e3f59 (diff) |
feat: merge default languages.toml with user provided languages.toml, add a generic TOML value merge function (#654)
* feat: merge default languages.toml with user provided languages.toml
* refactor: use catch-all to override all other values for merge toml
* tests: add a test case for merging languages configs
* refactor: change test module name
-rw-r--r-- | helix-core/src/lib.rs | 83 | ||||
-rw-r--r-- | helix-term/src/application.rs | 21 |
2 files changed, 97 insertions, 7 deletions
diff --git a/helix-core/src/lib.rs b/helix-core/src/lib.rs index be01c302..d971464a 100644 --- a/helix-core/src/lib.rs +++ b/helix-core/src/lib.rs @@ -98,6 +98,89 @@ pub fn cache_dir() -> std::path::PathBuf { path } +// right overrides left +pub fn merge_toml_values(left: toml::Value, right: toml::Value) -> toml::Value { + use toml::Value; + + fn get_name(v: &Value) -> Option<&str> { + v.get("name").and_then(Value::as_str) + } + + match (left, right) { + (Value::Array(mut left_items), Value::Array(right_items)) => { + left_items.reserve(right_items.len()); + for rvalue in right_items { + let lvalue = get_name(&rvalue) + .and_then(|rname| left_items.iter().position(|v| get_name(v) == Some(rname))) + .map(|lpos| left_items.remove(lpos)); + let mvalue = match lvalue { + Some(lvalue) => merge_toml_values(lvalue, rvalue), + None => rvalue, + }; + left_items.push(mvalue); + } + Value::Array(left_items) + } + (Value::Table(mut left_map), Value::Table(right_map)) => { + for (rname, rvalue) in right_map { + match left_map.remove(&rname) { + Some(lvalue) => { + let merged_value = merge_toml_values(lvalue, rvalue); + left_map.insert(rname, merged_value); + } + None => { + left_map.insert(rname, rvalue); + } + } + } + Value::Table(left_map) + } + // Catch everything else we didn't handle, and use the right value + (_, value) => value, + } +} + +#[cfg(test)] +mod merge_toml_tests { + use super::merge_toml_values; + + #[test] + fn language_tomls() { + use toml::Value; + + const USER: &str = " + [[language]] + name = \"nix\" + test = \"bbb\" + indent = { tab-width = 4, unit = \" \", test = \"aaa\" } + "; + + let base: Value = toml::from_slice(include_bytes!("../../languages.toml")) + .expect("Couldn't parse built-in langauges config"); + let user: Value = toml::from_str(USER).unwrap(); + + let merged = merge_toml_values(base, user); + let languages = merged.get("language").unwrap().as_array().unwrap(); + let nix = languages + .iter() + .find(|v| v.get("name").unwrap().as_str().unwrap() == "nix") + .unwrap(); + let nix_indent = nix.get("indent").unwrap(); + + // We changed tab-width and unit in indent so check them if they are the new values + assert_eq!( + nix_indent.get("tab-width").unwrap().as_integer().unwrap(), + 4 + ); + assert_eq!(nix_indent.get("unit").unwrap().as_str().unwrap(), " "); + // We added a new keys, so check them + assert_eq!(nix.get("test").unwrap().as_str().unwrap(), "bbb"); + assert_eq!(nix_indent.get("test").unwrap().as_str().unwrap(), "aaa"); + // We didn't change comment-token so it should be same + assert_eq!(nix.get("comment-token").unwrap().as_str().unwrap(), "#"); + } +} + pub use etcetera::home_dir; use etcetera::base_strategy::{choose_base_strategy, BaseStrategy}; diff --git a/helix-term/src/application.rs b/helix-term/src/application.rs index 3d59c33a..1fcca681 100644 --- a/helix-term/src/application.rs +++ b/helix-term/src/application.rs @@ -1,4 +1,4 @@ -use helix_core::syntax; +use helix_core::{merge_toml_values, syntax}; use helix_lsp::{lsp, util::lsp_pos_to_pos, LspProgressMap}; use helix_view::{theme, Editor}; @@ -59,11 +59,16 @@ impl Application { let theme_loader = std::sync::Arc::new(theme::Loader::new(&conf_dir, &helix_core::runtime_dir())); - // load $HOME/.config/helix/languages.toml, fallback to default config - let lang_conf = std::fs::read(conf_dir.join("languages.toml")); - let lang_conf = lang_conf - .as_deref() - .unwrap_or(include_bytes!("../../languages.toml")); + // load default and user config, and merge both + let def_lang_conf: toml::Value = toml::from_slice(include_bytes!("../../languages.toml")) + .expect("Could not parse built-in languages.toml, something must be very wrong"); + let user_lang_conf: Option<toml::Value> = std::fs::read(conf_dir.join("languages.toml")) + .ok() + .map(|raw| toml::from_slice(&raw).expect("Could not parse user languages.toml")); + let lang_conf = match user_lang_conf { + Some(value) => merge_toml_values(def_lang_conf, value), + None => def_lang_conf, + }; let theme = if let Some(theme) = &config.theme { match theme_loader.load(theme) { @@ -77,7 +82,9 @@ impl Application { theme_loader.default() }; - let syn_loader_conf = toml::from_slice(lang_conf).expect("Could not parse languages.toml"); + let syn_loader_conf: helix_core::syntax::Configuration = lang_conf + .try_into() + .expect("Could not parse merged (built-in + user) languages.toml"); let syn_loader = std::sync::Arc::new(syntax::Loader::new(syn_loader_conf)); let mut editor = Editor::new( |