Merge pull request #681 from taminomara/gentle-config-edit

CppCXY · web-flow · commit 3f233ad6b3ad · 2025-08-04T10:06:19.000+08:00
Don't add default fields when automatically editing `.emmyrc.json`
diff --git a/crates/emmylua_code_analysis/src/config/config_loader.rs b/crates/emmylua_code_analysis/src/config/config_loader.rs
@@ -6,7 +6,7 @@ use crate::read_file_with_encoding;
 
 use super::{Emmyrc, flatten_config::FlattenConfigObject};
 
-pub fn load_configs(config_files: Vec<PathBuf>, partial_emmyrcs: Option<Vec<Value>>) -> Emmyrc {
+pub fn load_configs_raw(config_files: Vec<PathBuf>, partial_emmyrcs: Option<Vec<Value>>) -> Value {
     let mut config_jsons = Vec::new();
 
     for config_file in config_files {
@@ -45,26 +45,15 @@ pub fn load_configs(config_files: Vec<PathBuf>, partial_emmyrcs: Option<Vec<Valu
 
     if config_jsons.is_empty() {
         log::info!("No valid config file found.");
-        Emmyrc::default()
+        Value::Object(Default::default())
     } else if config_jsons.len() == 1 {
-        let first_config = match config_jsons.into_iter().next() {
-            Some(config) => config,
-            None => {
-                log::error!("No valid config file found.");
-                return Emmyrc::default();
-            }
-        };
+        let first_config = config_jsons.into_iter().next().unwrap_or_else(|| {
+            log::error!("No valid config file found.");
+            Value::Object(Default::default())
+        });
 
         let flatten_config = FlattenConfigObject::parse(first_config);
-        let emmyrc_json_value = flatten_config.to_emmyrc();
-        let emmyrc: Emmyrc = match serde_json::from_value(emmyrc_json_value) {
-            Ok(config) => config,
-            Err(err) => {
-                log::error!("Failed to parse config, error: {:?}", err);
-                Emmyrc::default()
-            }
-        };
-        emmyrc
+        flatten_config.to_emmyrc()
     } else {
         let merge_config =
             config_jsons
@@ -74,18 +63,18 @@ pub fn load_configs(config_files: Vec<PathBuf>, partial_emmyrcs: Option<Vec<Valu
                     acc
                 });
         let flatten_config = FlattenConfigObject::parse(merge_config.clone());
-        let emmyrc_json_value = flatten_config.to_emmyrc();
-        let emmyrc: Emmyrc = match serde_json::from_value(emmyrc_json_value) {
-            Ok(config) => config,
-            Err(err) => {
-                log::error!("Failed to parse config: error: {:?}", err);
-                Emmyrc::default()
-            }
-        };
-        emmyrc
+        flatten_config.to_emmyrc()
     }
 }
 
+pub fn load_configs(config_files: Vec<PathBuf>, partial_emmyrcs: Option<Vec<Value>>) -> Emmyrc {
+    let emmyrc_json_value = load_configs_raw(config_files, partial_emmyrcs);
+    serde_json::from_value(emmyrc_json_value).unwrap_or_else(|err| {
+        log::error!("Failed to parse config: error: {:?}", err);
+        Emmyrc::default()
+    })
+}
+
 fn merge_values(base: &mut Value, overlay: Value) {
     match (base, overlay) {
         (Value::Object(base_map), Value::Object(overlay_map)) => {
diff --git a/crates/emmylua_code_analysis/src/config/mod.rs b/crates/emmylua_code_analysis/src/config/mod.rs
@@ -7,15 +7,14 @@ use std::{
     path::{Path, PathBuf},
 };
 
-pub use config_loader::load_configs;
-pub use configs::EmmyrcFilenameConvention;
-pub use configs::EmmyrcLuaVersion;
-use configs::{EmmyrcCodeAction, EmmyrcDocumentColor};
+pub use config_loader::{load_configs, load_configs_raw};
 use configs::{
-    EmmyrcCodeLen, EmmyrcCompletion, EmmyrcDiagnostic, EmmyrcDoc, EmmyrcHover, EmmyrcInlayHint,
-    EmmyrcInlineValues, EmmyrcReference, EmmyrcResource, EmmyrcRuntime, EmmyrcSemanticToken,
-    EmmyrcSignature, EmmyrcStrict, EmmyrcWorkspace,
+    EmmyrcCodeAction, EmmyrcCodeLen, EmmyrcCompletion, EmmyrcDiagnostic, EmmyrcDoc,
+    EmmyrcDocumentColor, EmmyrcHover, EmmyrcInlayHint, EmmyrcInlineValues, EmmyrcReference,
+    EmmyrcResource, EmmyrcRuntime, EmmyrcSemanticToken, EmmyrcSignature, EmmyrcStrict,
+    EmmyrcWorkspace,
 };
+pub use configs::{EmmyrcFilenameConvention, EmmyrcLuaVersion};
 use emmylua_parser::{LuaLanguageLevel, ParserConfig, SpecialFunction};
 use regex::Regex;
 use rowan::NodeCache;
diff --git a/crates/emmylua_ls/src/handlers/command/commands/emmy_add_doc_tag.rs b/crates/emmylua_ls/src/handlers/command/commands/emmy_add_doc_tag.rs
@@ -1,6 +1,6 @@
 use std::{fs::OpenOptions, io::Write, sync::Arc};
 
-use emmylua_code_analysis::load_configs;
+use emmylua_code_analysis::load_configs_raw;
 use lsp_types::Command;
 use serde_json::Value;
 use tokio::sync::RwLock;
@@ -38,10 +38,19 @@ async fn add_doc_tag(
     let config_manager = config_manager.read().await;
     let main_workspace = config_manager.workspace_folders.get(0)?;
     let emmyrc_path = main_workspace.join(".emmyrc.json");
-    let mut emmyrc = load_configs(vec![emmyrc_path.clone()], None);
-    emmyrc.doc.known_tags.push(tag_name);
+    let mut emmyrc = load_configs_raw(vec![emmyrc_path.clone()], None);
     drop(config_manager);
 
+    emmyrc
+        .as_object_mut()?
+        .entry("doc")
+        .or_insert_with(|| Value::Object(Default::default()))
+        .as_object_mut()?
+        .entry("knownTags")
+        .or_insert_with(|| Value::Array(Default::default()))
+        .as_array_mut()?
+        .push(Value::String(tag_name));
+
     let emmyrc_json = serde_json::to_string_pretty(&emmyrc).ok()?;
     if let Ok(mut file) = OpenOptions::new()
         .write(true)
diff --git a/crates/emmylua_ls/src/handlers/command/commands/emmy_disable_code.rs b/crates/emmylua_ls/src/handlers/command/commands/emmy_disable_code.rs
@@ -1,6 +1,6 @@
 use std::{fs::OpenOptions, io::Write, sync::Arc};
 
-use emmylua_code_analysis::{DiagnosticCode, FileId, load_configs};
+use emmylua_code_analysis::{DiagnosticCode, FileId, load_configs_raw};
 use lsp_types::{Command, Range};
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
@@ -66,10 +66,19 @@ async fn add_disable_project(
     let config_manager = config_manager.read().await;
     let main_workspace = config_manager.workspace_folders.get(0)?;
     let emmyrc_path = main_workspace.join(".emmyrc.json");
-    let mut emmyrc = load_configs(vec![emmyrc_path.clone()], None);
-    emmyrc.diagnostics.disable.push(code);
+    let mut emmyrc = load_configs_raw(vec![emmyrc_path.clone()], None);
     drop(config_manager);
 
+    emmyrc
+        .as_object_mut()?
+        .entry("diagnostics")
+        .or_insert_with(|| Value::Object(Default::default()))
+        .as_object_mut()?
+        .entry("disable")
+        .or_insert_with(|| Value::Array(Default::default()))
+        .as_array_mut()?
+        .push(Value::String(code.to_string()));
+
     let emmyrc_json = serde_json::to_string_pretty(&emmyrc).ok()?;
     if let Ok(mut file) = OpenOptions::new()
         .write(true)
