add config: doc.privateName

Author: xuhuanzy

crates/emmylua_code_analysis/resources/schema.json

@@ -46,6 +46,12 @@
         "severity": {}
       }
     },
+    "doc": {
+      "$ref": "#/$defs/EmmyrcDoc",
+      "default": {
+        "privateName": []
+      }
+    },
     "documentColor": {
       "$ref": "#/$defs/EmmyrcDocumentColor",
       "default": {
@@ -542,6 +548,19 @@
         }
       }
     },
+    "EmmyrcDoc": {
+      "type": "object",
+      "properties": {
+        "privateName": {
+          "description": "Treat specific field names as private, e.g. `m_*` means `XXX.m_id` and `XXX.m_type` are private, witch can only be accessed in the class where the definition is located.",
+          "type": "array",
+          "default": [],
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
     "EmmyrcDocumentColor": {
       "type": "object",
       "properties": {

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

@@ -0,0 +1,18 @@
+use schemars::JsonSchema;
+use serde::{Deserialize, Serialize};
+
+#[derive(Serialize, Deserialize, Debug, JsonSchema, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct EmmyrcDoc {
+    #[serde(default)]
+    /// Treat specific field names as private, e.g. `m_*` means `XXX.m_id` and `XXX.m_type` are private, witch can only be accessed in the class where the definition is located.
+    pub private_name: Vec<String>,
+}
+
+impl Default for EmmyrcDoc {
+    fn default() -> Self {
+        Self {
+            private_name: Default::default(),
+        }
+    }
+}

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

@@ -13,6 +13,7 @@ mod semantictoken;
 mod signature;
 mod strict;
 mod workspace;
+mod doc;
 
 pub use code_action::EmmyrcCodeAction;
 pub use codelen::EmmyrcCodeLen;
@@ -29,3 +30,4 @@ pub use semantictoken::EmmyrcSemanticToken;
 pub use signature::EmmyrcSignature;
 pub use strict::EmmyrcStrict;
 pub use workspace::EmmyrcWorkspace;
+pub use doc::EmmyrcDoc;

crates/emmylua_code_analysis/src/config/mod.rs

@@ -12,7 +12,7 @@ pub use configs::EmmyrcFilenameConvention;
 pub use configs::EmmyrcLuaVersion;
 use configs::{EmmyrcCodeAction, EmmyrcDocumentColor};
 use configs::{
-    EmmyrcCodeLen, EmmyrcCompletion, EmmyrcDiagnostic, EmmyrcHover, EmmyrcInlayHint,
+    EmmyrcCodeLen, EmmyrcCompletion, EmmyrcDiagnostic, EmmyrcDoc, EmmyrcHover, EmmyrcInlayHint,
     EmmyrcInlineValues, EmmyrcReference, EmmyrcResource, EmmyrcRuntime, EmmyrcSemanticToken,
     EmmyrcSignature, EmmyrcStrict, EmmyrcWorkspace,
 };
@@ -58,6 +58,8 @@ pub struct Emmyrc {
     pub code_action: EmmyrcCodeAction,
     #[serde(default)]
     pub inline_values: EmmyrcInlineValues,
+    #[serde(default)]
+    pub doc: EmmyrcDoc,
 }
 
 impl Emmyrc {

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

@@ -59,6 +59,36 @@ 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)
 }
 

crates/emmylua_ls/src/handlers/inlay_hint/build_function_hint.rs

@@ -160,6 +160,10 @@ fn get_type_location(semantic_model: &SemanticModel, typ: &LuaType) -> Option<Lo
             let lsp_range = document.to_lsp_range(location.range)?;
             Some(Location::new(document.get_uri(), lsp_range))
         }
+        LuaType::Generic(generic) => {
+            let base_type_id = generic.get_base_type_id();
+            get_type_location(semantic_model, &LuaType::Ref(base_type_id))
+        }
         LuaType::Array(base) => get_type_location(semantic_model, base),
         LuaType::Any => get_base_type_location(semantic_model, "any"),
         LuaType::Nil => get_base_type_location(semantic_model, "nil"),
@@ -207,6 +211,20 @@ fn hint_humanize_type(semantic_model: &SemanticModel, typ: &LuaType, level: Rend
                 id.get_name().to_string()
             }
         }
+        LuaType::Generic(generic) => {
+            let base_type_id = generic.get_base_type_id();
+            let base_type_name =
+                hint_humanize_type(semantic_model, &LuaType::Ref(base_type_id), level);
+
+            let generic_params = generic
+                .get_params()
+                .iter()
+                .map(|ty| hint_humanize_type(semantic_model, ty, level.next_level()))
+                .collect::<Vec<_>>()
+                .join(",");
+
+            format!("{}<{}>", base_type_name, generic_params)
+        }
         LuaType::Union(union) => hint_humanize_union_type(semantic_model, union, level),
         _ => humanize_type(semantic_model.get_db(), typ, level),
     }