update @export. 支持return {}

Author: xuhuanzy

crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs

@@ -1,12 +1,14 @@
-use crate::{LuaExport, LuaExportScope, LuaNoDiscard, LuaSignatureId};
+use crate::{
+    LuaDeclId, LuaExport, LuaExportScope, LuaNoDiscard, LuaSemanticDeclId, LuaSignatureId,
+};
 
 use super::{
     tags::{find_owner_closure, get_owner_id},
     DocAnalyzer,
 };
 use emmylua_parser::{
-    LuaDocDescriptionOwner, LuaDocTagDeprecated, LuaDocTagExport, LuaDocTagNodiscard,
-    LuaDocTagSource, LuaDocTagVersion, LuaDocTagVisibility,
+    LuaAst, LuaAstNode, LuaDocDescriptionOwner, LuaDocTagDeprecated, LuaDocTagExport,
+    LuaDocTagNodiscard, LuaDocTagSource, LuaDocTagVersion, LuaDocTagVisibility, LuaTableExpr,
 };
 
 pub fn analyze_visibility(
@@ -112,7 +114,17 @@ pub fn analyze_async(analyzer: &mut DocAnalyzer) -> Option<()> {
 }
 
 pub fn analyze_export(analyzer: &mut DocAnalyzer, tag: LuaDocTagExport) -> Option<()> {
-    let owner_id = get_owner_id(analyzer)?;
+    let owner = analyzer.comment.get_owner()?;
+    let owner_id = match owner {
+        LuaAst::LuaReturnStat(return_stat) => {
+            let return_table_expr = return_stat.child::<LuaTableExpr>()?;
+            LuaSemanticDeclId::LuaDecl(LuaDeclId::new(
+                analyzer.file_id,
+                return_table_expr.get_position(),
+            ))
+        }
+        _ => get_owner_id(analyzer)?,
+    };
 
     let export_scope = if let Some(scope_text) = tag.get_export_scope() {
         match scope_text.as_str() {

crates/emmylua_code_analysis/src/compilation/analyzer/lua/module.rs

@@ -2,7 +2,7 @@ use emmylua_parser::{LuaAstNode, LuaChunk, LuaExpr};
 
 use crate::{
     compilation::analyzer::unresolve::UnResolveModule, db_index::LuaType, InferFailReason,
-    LuaSemanticDeclId, LuaSignatureId,
+    LuaDeclId, LuaSemanticDeclId, LuaSignatureId,
 };
 
 use super::{func_body::analyze_func_body_returns, LuaAnalyzer, LuaReturnPoint};
@@ -67,6 +67,11 @@ fn get_property_owner_id(analyzer: &LuaAnalyzer, expr: LuaExpr) -> Option<LuaSem
         LuaExpr::ClosureExpr(closure) => Some(LuaSemanticDeclId::Signature(
             LuaSignatureId::from_closure(analyzer.file_id, &closure),
         )),
+        // `return {}`
+        LuaExpr::TableExpr(table_expr) => Some(LuaSemanticDeclId::LuaDecl(LuaDeclId::new(
+            analyzer.file_id,
+            table_expr.get_position(),
+        ))),
         _ => None,
     }
 }

crates/emmylua_code_analysis/src/compilation/test/export_test.rs

@@ -8,27 +8,19 @@ mod test {
         ws.def_file(
             "A.lua",
             r#"
-            ---@export
-            local A = {}
 
-            return A
+            ---@export
+            return {
+               newField = 1           
+            }
         "#,
         );
 
         ws.def(
             r#"
             local A = require("A")
-            A.newField = 1
-        "#,
-        );
-
-        ws.def(
-            r#"
-            E = require("A").newField
-            
+            A.newField = 2
         "#,
         );
-        let res = ws.expr_ty("E");
-        dbg!(&res);
     }
 }

crates/emmylua_code_analysis/src/db_index/module/module_info.rs

@@ -1,6 +1,6 @@
 use emmylua_parser::{LuaVersionCondition, LuaVersionNumber};
 
-use crate::{db_index::LuaType, FileId, LuaSemanticDeclId};
+use crate::{db_index::LuaType, DbIndex, FileId, LuaExport, LuaSemanticDeclId};
 
 use super::{module_node::ModuleNodeId, workspace::WorkspaceId};
 
@@ -36,4 +36,26 @@ impl ModuleInfo {
 
         true
     }
+
+    pub fn is_export(&self, db: &DbIndex) -> bool {
+        let Some(property_owner_id) = &self.property_owner_id else {
+            return false;
+        };
+
+        db.get_property_index()
+            .get_property(property_owner_id)
+            .and_then(|property| property.export.as_ref())
+            .is_some()
+    }
+
+    pub fn get_export<'a>(&self, db: &'a DbIndex) -> Option<&'a LuaExport> {
+        let property_owner_id = self.property_owner_id.as_ref()?;
+        let export = db
+            .get_property_index()
+            .get_property(property_owner_id)?
+            .export
+            .as_ref()?;
+
+        Some(export)
+    }
 }

crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs

@@ -68,7 +68,7 @@ fn check_index_expr(
     if is_invalid_prefix_type(&prefix_typ) {
         if matches!(prefix_typ, LuaType::TableConst(_)) {
             // 如果导入了被 @export 标记的表常量, 那么不应该跳过检查
-            module_info = check_import_table_const(semantic_model, index_expr);
+            module_info = check_require_table_const_with_export(semantic_model, index_expr);
             if module_info.is_none() {
                 return Some(());
             }
@@ -488,7 +488,7 @@ fn check_enum_is_param(
 }
 
 /// 检查导入的表常量
-fn check_import_table_const<'a>(
+fn check_require_table_const_with_export<'a>(
     semantic_model: &'a SemanticModel,
     index_expr: &LuaIndexExpr,
 ) -> Option<&'a ModuleInfo> {
@@ -508,5 +508,9 @@ fn check_import_table_const<'a>(
         .get_decl_index()
         .get_decl(&decl_id)?;
 
-    parse_require_module_info(semantic_model, &decl)
+    let module_info = parse_require_module_info(semantic_model, &decl)?;
+    if module_info.is_export(semantic_model.get_db()) {
+        return Some(module_info);
+    }
+    None
 }

crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs

@@ -180,4 +180,32 @@ mod test {
             "#,
         ));
     }
+
+    #[test]
+    fn test_export_2() {
+        let mut ws = VirtualWorkspace::new();
+        ws.def_file(
+            "a.lua",
+            r#"
+            ---@export
+            return {
+                a = 1
+            }
+            "#,
+        );
+        assert!(!ws.check_code_for(
+            DiagnosticCode::InjectField,
+            r#"
+            local a = require("a")
+            a.newField = 1
+            "#,
+        ));
+        assert!(ws.check_code_for(
+            DiagnosticCode::InjectField,
+            r#"
+            local a = require("a")
+            a.a = 2
+            "#,
+        ));
+    }
 }

crates/emmylua_code_analysis/src/semantic/visibility/export.rs

@@ -1,12 +1,14 @@
-use crate::{LuaExport, LuaExportScope, ModuleInfo, SemanticModel};
+use crate::{LuaExportScope, ModuleInfo, SemanticModel};
 
-/// 检查模块是否可见, 如果没有 export 标记, 视为可见
+/// 检查模块是否可见.
+///
+/// 如果没有 export 标记, 视为可见.
 pub fn check_export_visibility(
     semantic_model: &SemanticModel,
     module_info: &ModuleInfo,
 ) -> Option<bool> {
     // 检查模块是否有 export 标记
-    let Some(export) = get_export(semantic_model, module_info) else {
+    let Some(export) = module_info.get_export(semantic_model.get_db()) else {
         return Some(true);
     };
 
@@ -35,19 +37,3 @@ pub fn check_export_visibility(
 
     Some(false)
 }
-
-fn get_export<'a>(
-    semantic_model: &'a SemanticModel,
-    module_info: &ModuleInfo,
-) -> Option<&'a LuaExport> {
-    // 检查模块是否有 export 标记
-    let property_owner_id = module_info.property_owner_id.clone()?;
-    let export = semantic_model
-        .get_db()
-        .get_property_index()
-        .get_property(&property_owner_id)?
-        .export
-        .as_ref()?;
-
-    Some(export)
-}

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

@@ -127,6 +127,14 @@ fn try_add_member_completion_items(
     position: Position,
     completions: &mut Vec<CompletionItem>,
 ) -> Option<()> {
+    // 模块必须要有 export 标记
+    if module_info
+        .get_export(builder.semantic_model.get_db())
+        .is_none()
+    {
+        return None;
+    };
+
     if let Some(export_type) = &module_info.export_type {
         match export_type {
             LuaType::TableConst(_) | LuaType::Def(_) => {

crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs

@@ -583,7 +583,7 @@ fn handle_name_node(
                 .get_decl_index()
                 .get_decl(&decl_id)?;
             let decl_type = semantic_model.get_type(decl_id.into());
-            if let Some(true) = check_import_decl(semantic_model, &decl) {
+            if let Some(true) = check_require_decl(semantic_model, &decl) {
                 builder.push_with_modifier(
                     name_token.syntax(),
                     SemanticTokenType::CLASS,
@@ -706,7 +706,7 @@ fn check_ref_is_require_def(
 }
 
 /// 检查是否是导入语句
-fn check_import_decl(semantic_model: &SemanticModel, decl: &LuaDecl) -> Option<bool> {
+fn check_require_decl(semantic_model: &SemanticModel, decl: &LuaDecl) -> Option<bool> {
     let module_info = parse_require_module_info(semantic_model, decl)?;
     if check_export_visibility(semantic_model, &module_info).unwrap_or(false) {
         return Some(true);

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

@@ -1,8 +1,6 @@
 #[cfg(test)]
 mod tests {
 
-    use std::{ops::Deref, sync::Arc};
-
     use emmylua_code_analysis::EmmyrcFilenameConvention;
     use lsp_types::{CompletionItemKind, CompletionTriggerKind};
 
@@ -894,9 +892,9 @@ mod tests {
     #[test]
     fn test_auto_require() {
         let mut ws = ProviderVirtualWorkspace::new();
-        let mut emmyrc = ws.analysis.emmyrc.deref().clone();
+        let mut emmyrc = ws.get_emmyrc();
         emmyrc.completion.auto_require_naming_convention = EmmyrcFilenameConvention::KeepClass;
-        ws.analysis.update_config(Arc::new(emmyrc));
+        ws.update_emmyrc(emmyrc);
         ws.def_file(
             "map.lua",
             r#"
@@ -921,9 +919,6 @@ mod tests {
     #[test]
     fn test_auto_require_table_field() {
         let mut ws = ProviderVirtualWorkspace::new();
-        let mut emmyrc = ws.analysis.emmyrc.deref().clone();
-        emmyrc.completion.auto_require_naming_convention = EmmyrcFilenameConvention::KeepClass;
-        ws.analysis.update_config(Arc::new(emmyrc));
         ws.def_file(
             "aaaa.lua",
             r#"
@@ -1049,4 +1044,26 @@ mod tests {
             CompletionTriggerKind::INVOKED,
         ));
     }
+
+    #[test]
+    fn test_auto_require_field_1() {
+        let mut ws = ProviderVirtualWorkspace::new();
+        // 没有 export 标记, 不允许子字段自动导入
+        ws.def_file(
+            "AAA.lua",
+            r#"
+                local function map()
+                end
+                return {
+                    map = map,
+                }
+            "#,
+        );
+        assert!(ws.check_completion(
+            r#"
+                map<??>
+            "#,
+            vec![],
+        ));
+    }
 }

crates/emmylua_ls/src/handlers/test_lib/mod.rs

@@ -1,4 +1,6 @@
-use emmylua_code_analysis::{EmmyLuaAnalysis, FileId, VirtualUrlGenerator};
+use std::{ops::Deref, sync::Arc};
+
+use emmylua_code_analysis::{EmmyLuaAnalysis, Emmyrc, FileId, VirtualUrlGenerator};
 use lsp_types::{
     CodeActionResponse, CompletionItemKind, CompletionResponse, CompletionTriggerKind,
     GotoDefinitionResponse, Hover, HoverContents, InlayHint, MarkupContent, Position,
@@ -104,6 +106,14 @@ impl ProviderVirtualWorkspace {
         file_id
     }
 
+    pub fn get_emmyrc(&self) -> Emmyrc {
+        self.analysis.emmyrc.deref().clone()
+    }
+
+    pub fn update_emmyrc(&mut self, emmyrc: Emmyrc) {
+        self.analysis.update_config(Arc::new(emmyrc));
+    }
+
     /// 处理文件内容
     fn handle_file_content(content: &str) -> Option<(String, Position)> {
         let content = content.to_string();