update auto_require

Author: xuhuanzy

crates/emmylua_ls/src/handlers/command/commands/emmy_auto_require.rs

@@ -5,10 +5,7 @@ use emmylua_parser::{LuaAstNode, LuaExpr, LuaStat};
 use lsp_types::{ApplyWorkspaceEditParams, Command, Position, TextEdit, WorkspaceEdit};
 use serde_json::Value;
 
-use crate::{
-    context::ServerContextSnapshot,
-    util::{module_name_convert, time_cancel_token},
-};
+use crate::{context::ServerContextSnapshot, util::time_cancel_token};
 
 use super::CommandSpec;
 
@@ -21,7 +18,8 @@ impl CommandSpec for AutoRequireCommand {
         let add_to: FileId = serde_json::from_value(args.first()?.clone()).ok()?;
         let need_require_file_id: FileId = serde_json::from_value(args.get(1)?.clone()).ok()?;
         let position: Position = serde_json::from_value(args.get(2)?.clone()).ok()?;
-        let member_name: String = serde_json::from_value(args.get(3)?.clone()).ok()?;
+        let local_name: String = serde_json::from_value(args.get(3)?.clone()).ok()?;
+        let member_name: String = serde_json::from_value(args.get(4)?.clone()).ok()?;
 
         let analysis = context.analysis().read().await;
         let semantic_model = analysis.compilation.get_semantic_model(add_to)?;
@@ -32,8 +30,6 @@ impl CommandSpec for AutoRequireCommand {
         let emmyrc = semantic_model.get_emmyrc();
         let require_like_func = &emmyrc.runtime.require_like_function;
         let auto_require_func = emmyrc.completion.auto_require_function.clone();
-        let file_conversion = emmyrc.completion.auto_require_naming_convention;
-        let local_name = module_name_convert(module_info, file_conversion);
         let require_separator = emmyrc.completion.auto_require_separator.clone();
         let full_module_path = match require_separator.as_str() {
             "." | "" => module_info.full_module_name.clone(),
@@ -196,12 +192,14 @@ pub fn make_auto_require(
     add_to: FileId,
     need_require_file_id: FileId,
     position: Position,
-    member_name: Option<String>,
+    local_name: String,          // 导入时使用的名称
+    member_name: Option<String>, // 导入的成员名, 不要包含前缀`.`号, 它将拼接到 `require` 后面. 例如 require("a").member
 ) -> Command {
     let args = vec![
         serde_json::to_value(add_to).unwrap(),
         serde_json::to_value(need_require_file_id).unwrap(),
         serde_json::to_value(position).unwrap(),
+        serde_json::to_value(local_name).unwrap(),
         serde_json::to_value(member_name.unwrap_or_default()).unwrap(),
     ];
 

crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs

@@ -77,7 +77,8 @@ fn add_module_completion_item(
 
     let completion_name = module_name_convert(module_info, file_conversion);
     if !completion_name.to_lowercase().starts_with(prefix) {
-        try_add_member_completion_items(
+        // 如果模块名不匹配, 则根据导出类型添加完成项
+        add_completion_item_by_type(
             builder,
             prefix,
             module_info,
@@ -98,7 +99,7 @@ fn add_module_completion_item(
         None
     };
     let completion_item = CompletionItem {
-        label: completion_name,
+        label: completion_name.clone(),
         kind: Some(lsp_types::CompletionItemKind::MODULE),
         label_details: Some(lsp_types::CompletionItemLabelDetails {
             detail: Some(format!("    (in {})", module_info.full_module_name)),
@@ -109,6 +110,7 @@ fn add_module_completion_item(
             builder.semantic_model.get_file_id(),
             module_info.file_id,
             position,
+            completion_name,
             None,
         )),
         data,
@@ -120,7 +122,7 @@ fn add_module_completion_item(
     Some(())
 }
 
-fn try_add_member_completion_items(
+fn add_completion_item_by_type(
     builder: &CompletionBuilder,
     prefix: &str,
     module_info: &ModuleInfo,
@@ -192,7 +194,7 @@ fn try_add_member_completion_items(
                         };
 
                         let completion_item = CompletionItem {
-                            label: key_name,
+                            label: key_name.clone(),
                             kind: Some(get_completion_kind(&member_info.typ)),
                             label_details: Some(lsp_types::CompletionItemLabelDetails {
                                 detail: Some(format!("    (in {})", module_info.full_module_name)),
@@ -203,6 +205,7 @@ fn try_add_member_completion_items(
                                 builder.semantic_model.get_file_id(),
                                 module_info.file_id,
                                 position,
+                                key_name,
                                 Some(member_info.key.to_path().to_string()),
                             )),
                             data,
@@ -213,6 +216,42 @@ fn try_add_member_completion_items(
                     }
                 }
             }
+            LuaType::Signature(_) => {
+                let semantic_id = module_info.semantic_id.as_ref()?;
+                if let LuaSemanticDeclId::LuaDecl(decl_id) = semantic_id {
+                    let decl = builder
+                        .semantic_model
+                        .get_db()
+                        .get_decl_index()
+                        .get_decl(&decl_id)?;
+                    let name = decl.get_name();
+                    if name.to_lowercase().starts_with(prefix) {
+                        if builder.env_duplicate_name.contains(name) {
+                            return None;
+                        }
+
+                        let completion_item = CompletionItem {
+                            label: name.to_string(),
+                            kind: Some(get_completion_kind(&export_type)),
+                            label_details: Some(lsp_types::CompletionItemLabelDetails {
+                                detail: Some(format!("    (in {})", module_info.full_module_name)),
+                                ..Default::default()
+                            }),
+                            command: Some(make_auto_require(
+                                "",
+                                builder.semantic_model.get_file_id(),
+                                module_info.file_id,
+                                position,
+                                name.to_string(),
+                                None,
+                            )),
+                            ..Default::default()
+                        };
+
+                        completions.push(completion_item);
+                    }
+                }
+            }
             _ => {}
         }
     }

crates/emmylua_ls/src/handlers/test/completion_test.rs

@@ -2373,4 +2373,33 @@ mod tests {
 
         Ok(())
     }
+
+    #[gtest]
+    fn test_modle_return_signature() -> Result<()> {
+        let mut ws = ProviderVirtualWorkspace::new();
+        ws.def_file(
+            "test.lua",
+            r#"
+            ---@export global
+            local function processError()
+                return 1
+            end
+            return processError
+            "#,
+        );
+
+        check!(ws.check_completion_with_kind(
+            r#"
+            processError<??>
+            "#,
+            vec![VirtualCompletionItem {
+                label: "processError".to_string(),
+                kind: CompletionItemKind::FUNCTION,
+                label_detail: Some("    (in test)".to_string()),
+            }],
+            CompletionTriggerKind::INVOKED
+        ));
+
+        Ok(())
+    }
 }