git.iko.soy/helix
on master help sign in
feat: merge default languages.toml with user provided languages.toml, add a generic TOML value merge function (#654)
dc57f8dYusuf Bera Ertan
helix-core/src/lib.rs+83
compare with master
unifiedsplit
@@ -98,6 +98,89 @@ pub fn cache_dir() -> std::path::PathBuf {
98 path
98 path
99}
99}
100
100
101+// right overrides left
102+pub fn merge_toml_values(left: toml::Value, right: toml::Value) -> toml::Value {
103+ use toml::Value;
104+
105+ fn get_name(v: &Value) -> Option<&str> {
106+ v.get("name").and_then(Value::as_str)
107+ }
108+
109+ match (left, right) {
110+ (Value::Array(mut left_items), Value::Array(right_items)) => {
111+ left_items.reserve(right_items.len());
112+ for rvalue in right_items {
113+ let lvalue = get_name(&rvalue)
114+ .and_then(|rname| left_items.iter().position(|v| get_name(v) == Some(rname)))
115+ .map(|lpos| left_items.remove(lpos));
116+ let mvalue = match lvalue {
117+ Some(lvalue) => merge_toml_values(lvalue, rvalue),
118+ None => rvalue,
119+ };
120+ left_items.push(mvalue);
121+ }
122+ Value::Array(left_items)
123+ }
124+ (Value::Table(mut left_map), Value::Table(right_map)) => {
125+ for (rname, rvalue) in right_map {
126+ match left_map.remove(&rname) {
127+ Some(lvalue) => {
128+ let merged_value = merge_toml_values(lvalue, rvalue);
129+ left_map.insert(rname, merged_value);
130+ }
131+ None => {
132+ left_map.insert(rname, rvalue);
133+ }
134+ }
135+ }
136+ Value::Table(left_map)
137+ }
138+ // Catch everything else we didn't handle, and use the right value
139+ (_, value) => value,
140+ }
141+}
142+
143+#[cfg(test)]
144+mod merge_toml_tests {
145+ use super::merge_toml_values;
146+
147+ #[test]
148+ fn language_tomls() {
149+ use toml::Value;
150+
151+ const USER: &str = "
152+ [[language]]
153+ name = \"nix\"
154+ test = \"bbb\"
155+ indent = { tab-width = 4, unit = \" \", test = \"aaa\" }
156+ ";
157+
158+ let base: Value = toml::from_slice(include_bytes!("../../languages.toml"))
159+ .expect("Couldn't parse built-in langauges config");
160+ let user: Value = toml::from_str(USER).unwrap();
161+
162+ let merged = merge_toml_values(base, user);
163+ let languages = merged.get("language").unwrap().as_array().unwrap();
164+ let nix = languages
165+ .iter()
166+ .find(|v| v.get("name").unwrap().as_str().unwrap() == "nix")
167+ .unwrap();
168+ let nix_indent = nix.get("indent").unwrap();
169+
170+ // We changed tab-width and unit in indent so check them if they are the new values
171+ assert_eq!(
172+ nix_indent.get("tab-width").unwrap().as_integer().unwrap(),
173+ 4
174+ );
175+ assert_eq!(nix_indent.get("unit").unwrap().as_str().unwrap(), " ");
176+ // We added a new keys, so check them
177+ assert_eq!(nix.get("test").unwrap().as_str().unwrap(), "bbb");
178+ assert_eq!(nix_indent.get("test").unwrap().as_str().unwrap(), "aaa");
179+ // We didn't change comment-token so it should be same
180+ assert_eq!(nix.get("comment-token").unwrap().as_str().unwrap(), "#");
181+ }
182+}
183+
101pub use etcetera::home_dir;
184pub use etcetera::home_dir;
102
185
103use etcetera::base_strategy::{choose_base_strategy, BaseStrategy};
186use etcetera::base_strategy::{choose_base_strategy, BaseStrategy};
helix-term/src/application.rs+14−7
@@ -1,4 +1,4 @@
1−use helix_core::syntax;
1+use helix_core::{merge_toml_values, syntax};
2use helix_lsp::{lsp, util::lsp_pos_to_pos, LspProgressMap};
2use helix_lsp::{lsp, util::lsp_pos_to_pos, LspProgressMap};
3use helix_view::{theme, Editor};
3use helix_view::{theme, Editor};
4
4
@@ -59,11 +59,16 @@ impl Application {
59 let theme_loader =
59 let theme_loader =
60 std::sync::Arc::new(theme::Loader::new(&conf_dir, &helix_core::runtime_dir()));
60 std::sync::Arc::new(theme::Loader::new(&conf_dir, &helix_core::runtime_dir()));
61
61
62− // load $HOME/.config/helix/languages.toml, fallback to default config
62+ // load default and user config, and merge both
63+ let def_lang_conf: toml::Value = toml::from_slice(include_bytes!("../../languages.toml"))
64+ .expect("Could not parse built-in languages.toml, something must be very wrong");
63− let lang_conf = std::fs::read(conf_dir.join("languages.toml"));
65+ let user_lang_conf: Option<toml::Value> = std::fs::read(conf_dir.join("languages.toml"))
64− let lang_conf = lang_conf
66+ .ok()
65− .as_deref()
67+ .map(|raw| toml::from_slice(&raw).expect("Could not parse user languages.toml"));
66− .unwrap_or(include_bytes!("../../languages.toml"));
68+ let lang_conf = match user_lang_conf {
69+ Some(value) => merge_toml_values(def_lang_conf, value),
70+ None => def_lang_conf,
71+ };
67
72
68 let theme = if let Some(theme) = &config.theme {
73 let theme = if let Some(theme) = &config.theme {
69 match theme_loader.load(theme) {
74 match theme_loader.load(theme) {
@@ -77,7 +82,9 @@ impl Application {
77 theme_loader.default()
82 theme_loader.default()
78 };
83 };
79
84
85+ let syn_loader_conf: helix_core::syntax::Configuration = lang_conf
86+ .try_into()
80− let syn_loader_conf = toml::from_slice(lang_conf).expect("Could not parse languages.toml");
87+ .expect("Could not parse merged (built-in + user) languages.toml");
81 let syn_loader = std::sync::Arc::new(syntax::Loader::new(syn_loader_conf));
88 let syn_loader = std::sync::Arc::new(syntax::Loader::new(syn_loader_conf));
82
89
83 let mut editor = Editor::new(
90 let mut editor = Editor::new(