support config: codeAction.insertSpace

Close EmmyLuaLs#475

Author: CppCXY

crates/emmylua_code_analysis/resources/schema.json

@@ -9,6 +9,16 @@
         "null"
       ]
     },
+    "codeAction": {
+      "default": {
+        "insertSpace": false
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/EmmyrcCodeAction"
+        }
+      ]
+    },
     "codeLens": {
       "default": {
         "enable": true
@@ -524,6 +534,16 @@
         }
       ]
     },
+    "EmmyrcCodeAction": {
+      "type": "object",
+      "properties": {
+        "insertSpace": {
+          "description": "Whether to insert space after '---'",
+          "default": false,
+          "type": "boolean"
+        }
+      }
+    },
     "EmmyrcCodeLen": {
       "type": "object",
       "properties": {

crates/emmylua_code_analysis/src/config/configs/code_action.rs

@@ -0,0 +1,22 @@
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+#[derive(Serialize, Deserialize, Debug, JsonSchema, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct EmmyrcCodeAction {
+    /// Whether to insert space after '---'
+    #[serde(default = "default_false")]
+    pub insert_space: bool,
+}
+
+impl Default for EmmyrcCodeAction {
+    fn default() -> Self {
+        Self {
+            insert_space: default_false(),
+        }
+    }
+}
+
+fn default_false() -> bool {
+    false
+}

crates/emmylua_code_analysis/src/config/configs/mod.rs

@@ -1,3 +1,4 @@
+mod code_action;
 mod codelen;
 mod completion;
 mod diagnostics;
@@ -12,6 +13,7 @@ mod signature;
 mod strict;
 mod workspace;
 
+pub use code_action::EmmyrcCodeAction;
 pub use codelen::EmmyrcCodeLen;
 pub use completion::{EmmyrcCompletion, EmmyrcFilenameConvention};
 pub use diagnostics::EmmyrcDiagnostic;

crates/emmylua_code_analysis/src/config/mod.rs

@@ -8,9 +8,9 @@ use std::{
 };
 
 pub use config_loader::load_configs;
-use configs::EmmyrcDocumentColor;
 pub use configs::EmmyrcFilenameConvention;
 pub use configs::EmmyrcLuaVersion;
+use configs::{EmmyrcCodeAction, EmmyrcDocumentColor};
 use configs::{
     EmmyrcCodeLen, EmmyrcCompletion, EmmyrcDiagnostic, EmmyrcHover, EmmyrcInlayHint,
     EmmyrcReference, EmmyrcResource, EmmyrcRuntime, EmmyrcSemanticToken, EmmyrcSignature,
@@ -54,6 +54,8 @@ pub struct Emmyrc {
     pub hover: EmmyrcHover,
     #[serde(default)]
     pub document_color: EmmyrcDocumentColor,
+    #[serde(default)]
+    pub code_action: EmmyrcCodeAction,
 }
 
 impl Emmyrc {

crates/emmylua_ls/src/handlers/code_actions/actions/build_disable_code.rs

@@ -1,6 +1,6 @@
 use std::collections::HashMap;
 
-use emmylua_code_analysis::{DiagnosticCode, LuaDocument, SemanticModel};
+use emmylua_code_analysis::{DiagnosticCode, Emmyrc, LuaDocument, SemanticModel};
 use emmylua_parser::{
     LuaAst, LuaAstNode, LuaComment, LuaCommentOwner, LuaDocTag, LuaDocTagDiagnostic, LuaExpr,
     LuaKind, LuaStat, LuaSyntaxNode, LuaTokenKind,
@@ -71,6 +71,7 @@ pub fn build_disable_next_line_changes(
     start: Position,
     code: DiagnosticCode,
 ) -> Option<HashMap<Uri, Vec<TextEdit>>> {
+    let emmyrc = semantic_model.get_emmyrc();
     let document = semantic_model.get_document();
     let offset = document.get_offset(start.line as usize, start.character as usize)?;
     let root = semantic_model.get_root();
@@ -127,6 +128,7 @@ pub fn build_disable_next_line_changes(
         } else {
             text_edit = get_disable_next_line_text_edit(
                 &document,
+                &emmyrc,
                 comment.syntax().clone(),
                 comment.get_position(),
                 code,
@@ -137,6 +139,7 @@ pub fn build_disable_next_line_changes(
     if text_edit.is_none() {
         text_edit = get_disable_next_line_text_edit(
             &document,
+            &emmyrc,
             ast.syntax().clone(),
             ast.get_position(),
             code,
@@ -152,6 +155,7 @@ pub fn build_disable_next_line_changes(
 
 fn get_disable_next_line_text_edit(
     document: &LuaDocument,
+    emmyrc: &Emmyrc,
     node: LuaSyntaxNode,
     offset: TextSize,
     code: DiagnosticCode,
@@ -167,6 +171,11 @@ fn get_disable_next_line_text_edit(
     };
 
     let line = document.get_line(offset)?;
+    let space = if emmyrc.code_action.insert_space {
+        " "
+    } else {
+        ""
+    };
     Some(TextEdit {
         range: Range {
             start: Position {
@@ -179,8 +188,9 @@ fn get_disable_next_line_text_edit(
             },
         },
         new_text: format!(
-            "{}---@diagnostic disable-next-line: {}\n",
+            "{}---{}@diagnostic disable-next-line: {}\n",
             indent_text,
+            space,
             code.get_name()
         ),
     })
@@ -194,6 +204,12 @@ pub fn build_disable_file_changes(
     let first_block = root.get_block()?;
     let first_child = first_block.children::<LuaAst>().next()?;
     let document = semantic_model.get_document();
+    let emmyrc = semantic_model.get_emmyrc();
+    let space = if emmyrc.code_action.insert_space {
+        " "
+    } else {
+        ""
+    };
     let text_edit = if let LuaAst::LuaComment(comment) = first_child {
         if let Some(diagnostic_tag) =
             find_diagnostic_disable_tag(comment.clone(), DisableAction::DisableFile)
@@ -230,7 +246,7 @@ pub fn build_disable_file_changes(
                         character: 0,
                     },
                 },
-                new_text: format!("---@diagnostic disable: {}\n", code.get_name()),
+                new_text: format!("---{}@diagnostic disable: {}\n", space, code.get_name()),
             }
         }
     } else {
@@ -245,7 +261,7 @@ pub fn build_disable_file_changes(
                     character: 0,
                 },
             },
-            new_text: format!("---@diagnostic disable: {}\n", code.get_name()),
+            new_text: format!("---{}@diagnostic disable: {}\n", space, code.get_name()),
         }
     };