fix private config

Author: xuhuanzy

crates/emmylua_code_analysis/src/db_index/property/mod.rs

@@ -2,11 +2,13 @@ mod property;
 
 use std::collections::{HashMap, HashSet};
 
-use emmylua_parser::{LuaVersionCondition, VisibilityKind};
-use property::LuaCommonProperty;
+use emmylua_parser::{LuaAstNode, LuaDocTagField, LuaDocType, LuaVersionCondition, VisibilityKind};
+pub use property::LuaCommonProperty;
 pub use property::{LuaDeprecated, LuaExport, LuaExportScope, LuaPropertyId};
 
-use crate::{db_index::property::property::LuaTagContent, FileId};
+use crate::{
+    db_index::property::property::LuaTagContent, DbIndex, FileId, LuaMember, LuaSignatureId,
+};
 
 use super::{traits::LuaIndex, LuaSemanticDeclId};
 
@@ -240,3 +242,34 @@ impl LuaIndex for LuaPropertyIndex {
         self.id_count = 0;
     }
 }
+
+/// 尝试从 @field 定义中提取函数类型的位置信息
+pub fn try_extract_signature_id_from_field(
+    db: &DbIndex,
+    member: &LuaMember,
+) -> Option<LuaSignatureId> {
+    // 检查是否是 field 定义
+    if !member.is_field() {
+        return None;
+    }
+
+    let root = db
+        .get_vfs()
+        .get_syntax_tree(&member.get_file_id())?
+        .get_red_root();
+    let field_node = member.get_syntax_id().to_node_from_root(&root)?;
+
+    // 尝试转换为 LuaDocTagField
+    let field_tag = LuaDocTagField::cast(field_node)?;
+
+    // 获取类型定义
+    let type_node = field_tag.get_type()?;
+
+    match &type_node {
+        LuaDocType::Func(doc_func) => Some(LuaSignatureId::from_doc_func(
+            member.get_file_id(),
+            &doc_func,
+        )),
+        _ => None,
+    }
+}

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

@@ -5,7 +5,10 @@ use emmylua_parser::{
     LuaSyntaxToken, LuaVarExpr, VisibilityKind,
 };
 
-use crate::{DbIndex, Emmyrc, FileId, LuaMemberOwner, LuaSemanticDeclId, LuaType};
+use crate::{
+    try_extract_signature_id_from_field, DbIndex, Emmyrc, FileId, LuaCommonProperty,
+    LuaMemberOwner, LuaSemanticDeclId, LuaType,
+};
 
 use super::{infer_expr, type_check::is_sub_type_of, LuaInferCache};
 
@@ -19,7 +22,13 @@ pub fn check_visibility(
     token: LuaSyntaxToken,
     property_owner: LuaSemanticDeclId,
 ) -> Option<bool> {
-    let property = db.get_property_index().get_property(&property_owner)?;
+    let property = match get_property(db, &property_owner) {
+        Some(property) => property,
+        None => {
+            return check_member_name(db, file_id, emmyrc, infer_config, token, property_owner);
+        }
+    };
+
     if let Some(version_conds) = &property.version_conds {
         let version_number = emmyrc.runtime.version.to_lua_version_number();
         let visible = version_conds.iter().any(|cond| cond.check(&version_number));
@@ -59,37 +68,7 @@ pub fn check_visibility(
         }
     }
 
-    if let LuaSemanticDeclId::Member(member_id) = property_owner {
-        if let Some(member) = db.get_member_index().get_member(&member_id) {
-            if let Some(name) = member.get_key().get_name() {
-                let config = emmyrc;
-                for pattern in &config.doc.private_name {
-                    let is_match = if let Some(prefix) = pattern.strip_suffix('*') {
-                        name.starts_with(prefix)
-                    } else if let Some(suffix) = pattern.strip_prefix('*') {
-                        name.ends_with(suffix)
-                    } else {
-                        name == pattern
-                    };
-                    if is_match {
-                        return Some(
-                            check_visibility_by_visibility(
-                                db,
-                                infer_config,
-                                file_id,
-                                property_owner,
-                                token,
-                                VisibilityKind::Private,
-                            )
-                            .unwrap_or(false),
-                        );
-                    }
-                }
-            }
-        }
-    }
-
-    Some(true)
+    check_member_name(db, file_id, emmyrc, infer_config, token, property_owner)
 }
 
 fn check_visibility_by_visibility(
@@ -180,7 +159,7 @@ fn check_block_visibility(
 fn check_def_visibility(
     db: &DbIndex,
     infer_config: &mut LuaInferCache,
-    file_id: FileId,
+    _file_id: FileId,
     member_owner: &LuaMemberOwner,
     token: LuaGeneralToken,
     visibility: VisibilityKind,
@@ -189,9 +168,10 @@ fn check_def_visibility(
     let prefix_expr = index_expr.get_prefix_expr()?;
     let typ = infer_expr(db, infer_config, prefix_expr.into()).ok()?;
 
-    if !in_def_file(db, &typ, file_id) {
-        return Some(false);
-    }
+    // 这是为解决 require 后仍然是`Def`类型的问题, 但现在不需要了, 不过还是留着以防万一
+    // if !in_def_file(db, &typ, file_id) {
+    //     return Some(false);
+    // }
 
     match visibility {
         VisibilityKind::Protected => match (typ, member_owner) {
@@ -209,19 +189,77 @@ fn check_def_visibility(
     }
 }
 
-fn in_def_file(db: &DbIndex, typ: &LuaType, file_id: FileId) -> bool {
-    match typ {
-        LuaType::Def(id) => {
-            let decl = db.get_type_index().get_type_decl(id);
-            if let Some(decl) = decl {
-                decl.get_locations()
-                    .iter()
-                    .any(|location| location.file_id == file_id)
-            } else {
-                false
-            }
+// fn in_def_file(db: &DbIndex, typ: &LuaType, file_id: FileId) -> bool {
+//     match typ {
+//         LuaType::Def(id) => {
+//             let decl = db.get_type_index().get_type_decl(id);
+//             if let Some(decl) = decl {
+//                 decl.get_locations()
+//                     .iter()
+//                     .any(|location| location.file_id == file_id)
+//             } else {
+//                 false
+//             }
+//         }
+//         LuaType::TableConst(in_file) => in_file.file_id == file_id,
+//         _ => false,
+//     }
+// }
+
+fn get_property<'a>(
+    db: &'a DbIndex,
+    property_owner: &'a LuaSemanticDeclId,
+) -> Option<&'a LuaCommonProperty> {
+    match db.get_property_index().get_property(&property_owner) {
+        Some(common_property) => Some(common_property),
+        None => {
+            let LuaSemanticDeclId::Member(member_id) = property_owner else {
+                return None;
+            };
+            let member = db.get_member_index().get_member(&member_id)?;
+            let signature_id = try_extract_signature_id_from_field(db, member)?;
+            db.get_property_index()
+                .get_property(&LuaSemanticDeclId::Signature(signature_id))
         }
-        LuaType::TableConst(in_file) => in_file.file_id == file_id,
-        _ => false,
     }
 }
+
+fn check_member_name(
+    db: &DbIndex,
+    file_id: FileId,
+    emmyrc: &Emmyrc,
+    infer_config: &mut LuaInferCache,
+    token: LuaSyntaxToken,
+    property_owner: LuaSemanticDeclId,
+) -> Option<bool> {
+    if let LuaSemanticDeclId::Member(member_id) = property_owner {
+        if let Some(member) = db.get_member_index().get_member(&member_id) {
+            if let Some(name) = member.get_key().get_name() {
+                let config = emmyrc;
+                for pattern in &config.doc.private_name {
+                    let is_match = if let Some(prefix) = pattern.strip_suffix('*') {
+                        name.starts_with(prefix)
+                    } else if let Some(suffix) = pattern.strip_prefix('*') {
+                        name.ends_with(suffix)
+                    } else {
+                        name == pattern
+                    };
+                    if is_match {
+                        return Some(
+                            check_visibility_by_visibility(
+                                db,
+                                infer_config,
+                                file_id,
+                                property_owner,
+                                token,
+                                VisibilityKind::Private,
+                            )
+                            .unwrap_or(false),
+                        );
+                    }
+                }
+            }
+        }
+    };
+    Some(true)
+}

crates/emmylua_ls/src/handlers/completion/add_completions/add_member_completion.rs

@@ -1,18 +1,16 @@
 use emmylua_code_analysis::{
-    DbIndex, LuaMemberInfo, LuaMemberKey, LuaSemanticDeclId, LuaType, SemanticModel,
+    try_extract_signature_id_from_field, DbIndex, LuaMemberInfo, LuaMemberKey, LuaSemanticDeclId,
+    LuaType, SemanticModel,
 };
 use emmylua_parser::{
     LuaAssignStat, LuaAstNode, LuaAstToken, LuaFuncStat, LuaGeneralToken, LuaIndexExpr,
     LuaParenExpr, LuaTokenKind,
 };
 use lsp_types::CompletionItem;
 
-use crate::handlers::{
-    completion::{
-        completion_builder::CompletionBuilder, completion_data::CompletionData,
-        providers::get_function_remove_nil,
-    },
-    hover::try_extract_signature_id_from_field,
+use crate::handlers::completion::{
+    completion_builder::CompletionBuilder, completion_data::CompletionData,
+    providers::get_function_remove_nil,
 };
 
 use super::{
@@ -361,7 +359,8 @@ pub fn extract_index_member_alias(
         None => {
             // field定义的`signature`的`common_property`绑定位置稍有不同, 需要特殊处理
             let member = db.get_member_index().get_member(member_id)?;
-            let signature_id = try_extract_signature_id_from_field(semantic_model, member)?;
+            let signature_id =
+                try_extract_signature_id_from_field(semantic_model.get_db(), member)?;
             db.get_property_index()
                 .get_property(&LuaSemanticDeclId::Signature(signature_id))?
         }

crates/emmylua_ls/src/handlers/hover/function_humanize.rs

@@ -1,11 +1,10 @@
 use std::collections::HashSet;
 
 use emmylua_code_analysis::{
-    humanize_type, DbIndex, LuaDocReturnInfo, LuaFunctionType, LuaMember, LuaMemberKey,
-    LuaMemberOwner, LuaSemanticDeclId, LuaSignature, LuaSignatureId, LuaType, RenderLevel,
-    SemanticModel,
+    humanize_type, try_extract_signature_id_from_field, DbIndex, LuaDocReturnInfo, LuaFunctionType,
+    LuaMember, LuaMemberKey, LuaMemberOwner, LuaSemanticDeclId, LuaSignature, LuaSignatureId,
+    LuaType, RenderLevel,
 };
-use emmylua_parser::{LuaAstNode, LuaDocTagField, LuaDocType};
 
 use crate::handlers::{
     definition::extract_semantic_decl_from_signature,
@@ -76,9 +75,7 @@ pub fn hover_function_type(
                 let member = db.get_member_index().get_member(&id)?;
                 // 以 @field 定义的 function 描述信息绑定的 id 并不是 member, 需要特殊处理
                 if is_new && function_info.description.is_none() {
-                    if let Some(signature_id) =
-                        try_extract_signature_id_from_field(builder.semantic_model, &member)
-                    {
+                    if let Some(signature_id) = try_extract_signature_id_from_field(db, &member) {
                         function_info.description = extract_description_from_property_owner(
                             &builder.semantic_model,
                             &LuaSemanticDeclId::Signature(signature_id),
@@ -781,35 +778,3 @@ pub fn is_function(typ: &LuaType) -> bool {
             _ => false,
         }
 }
-
-/// 尝试从 @field 定义中提取函数类型的位置信息
-pub fn try_extract_signature_id_from_field(
-    semantic_model: &SemanticModel,
-    member: &LuaMember,
-) -> Option<LuaSignatureId> {
-    // 检查是否是 field 定义
-    if !member.is_field() {
-        return None;
-    }
-
-    let root = semantic_model
-        .get_db()
-        .get_vfs()
-        .get_syntax_tree(&member.get_file_id())?
-        .get_red_root();
-    let field_node = member.get_syntax_id().to_node_from_root(&root)?;
-
-    // 尝试转换为 LuaDocTagField
-    let field_tag = LuaDocTagField::cast(field_node)?;
-
-    // 获取类型定义
-    let type_node = field_tag.get_type()?;
-
-    match &type_node {
-        LuaDocType::Func(doc_func) => Some(LuaSignatureId::from_doc_func(
-            member.get_file_id(),
-            &doc_func,
-        )),
-        _ => None,
-    }
-}

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

@@ -11,7 +11,6 @@ use build_hover::build_semantic_info_hover;
 use emmylua_code_analysis::{EmmyLuaAnalysis, FileId};
 use emmylua_parser::LuaAstNode;
 pub use find_origin::{find_all_same_named_members, find_member_origin_owner};
-pub use function_humanize::try_extract_signature_id_from_field;
 pub use hover_builder::HoverBuilder;
 pub use hover_humanize::infer_prefix_global_name;
 use keyword_hover::{hover_keyword, is_keyword};

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

@@ -1167,4 +1167,61 @@ mod tests {
             },],
         ));
     }
+
+    #[test]
+    fn test_private_config() {
+        let mut ws = ProviderVirtualWorkspace::new();
+        let mut emmyrc = ws.get_emmyrc();
+        emmyrc.doc.private_name = vec!["_*".to_string()];
+        ws.update_emmyrc(emmyrc);
+        ws.def(
+            r#"
+                ---@class A
+                ---@field _abc number
+                ---@field _next fun()
+                A = {}
+            "#,
+        );
+        assert!(ws.check_completion(
+            r#"
+                ---@type A
+                local a
+                a.<??>
+            "#,
+            vec![],
+        ));
+        assert!(!ws.check_completion(
+            r#"
+                A.<??>
+            "#,
+            vec![],
+        ));
+    }
+
+    #[test]
+    fn test_require_private() {
+        let mut ws = ProviderVirtualWorkspace::new();
+        let mut emmyrc = ws.get_emmyrc();
+        emmyrc.doc.private_name = vec!["_*".to_string()];
+        ws.update_emmyrc(emmyrc);
+        ws.def_file(
+            "a.lua",
+            r#"
+                ---@class A
+                ---@field _next fun()
+                local A = {}
+
+                return {
+                    A = A,
+                }
+            "#,
+        );
+        assert!(ws.check_completion(
+            r#"
+                local A = require("a").A
+                A.<??>
+            "#,
+            vec![],
+        ));
+    }
 }