Merge pull request #539 from xuhuanzy/update

update

Author: CppCXY

.gitignore

@@ -1,3 +1,4 @@
 /target
 .idea
-dhat-heap.json
+.cursor
+dhat-heap.json

CHANGELOG.md

@@ -17,6 +17,8 @@
   local a = {}
   ```
 
+### 🔧 Changed
+- **Class Method Completion**: When a function call jumps, if there are multiple declarations, It will then attempt to return the most matching definition along with all actual code declarations, rather than returning all definitions.
 
 ### 🐛 Fixed
 - **Enum Variable Parameter Issue**: Fixed a crash issue when checking enum variable as parameter

crates/emmylua_code_analysis/locales/lint.yml

@@ -252,4 +252,12 @@ Cannot use `...` outside a vararg function.:
 "the string template type must be a string constant":
   en: "the string template type must be a string constant"
   zh_CN: "字符串模板类型必须是字符串常量"
-  zh_HK: "字串模板類型必須是字串常量"
+  zh_HK: "字串模板類型必須是字串常量"
+"Cannot cast `%{original}` to `%{target}`. %{reason}":
+  en: "Cannot cast `%{original}` to `%{target}`. %{reason}"
+  zh_CN: "不能将 `%{original}` 转换为 `%{target}`。%{reason}"
+  zh_HK: "不能將 `%{original}` 轉換為 `%{target}`。%{reason}"
+"type recursion":
+  en: "type recursion"
+  zh_CN: "类型递归"
+  zh_HK: "類型遞歸"

crates/emmylua_code_analysis/resources/schema.json

@@ -35,6 +35,7 @@
         "autoRequireFunction": "require",
         "autoRequireNamingConvention": "keep",
         "autoRequireSeparator": ".",
+        "baseFunctionIncludesName": true,
         "callSnippet": false,
         "enable": true,
         "postfix": "@"
@@ -76,6 +77,7 @@
         "enable": true,
         "indexHint": true,
         "localHint": true,
+        "metaCallHint": true,
         "overrideHint": true,
         "paramHint": true
       },
@@ -95,6 +97,16 @@
         }
       ]
     },
+    "inlineValues": {
+      "default": {
+        "enable": true
+      },
+      "allOf": [
+        {
+          "$ref": "#/definitions/EmmyrcInlineValues"
+        }
+      ]
+    },
     "references": {
       "default": {
         "enable": true,
@@ -511,6 +523,13 @@
           "enum": [
             "generic-constraint-mismatch"
           ]
+        },
+        {
+          "description": "cast-type-mismatch",
+          "type": "string",
+          "enum": [
+            "cast-type-mismatch"
+          ]
         }
       ]
     },
@@ -594,6 +613,11 @@
           "default": ".",
           "type": "string"
         },
+        "baseFunctionIncludesName": {
+          "description": "Whether to include the name in the base function completion. effect: `function () end` -> `function name() end`.",
+          "default": true,
+          "type": "boolean"
+        },
         "callSnippet": {
           "description": "Whether to use call snippets in completions.",
           "default": false,
@@ -710,6 +734,13 @@
           "enum": [
             "camel-case"
           ]
+        },
+        {
+          "description": "When returning class definition, use class name, otherwise keep original name.",
+          "type": "string",
+          "enum": [
+            "keep-class"
+          ]
         }
       ]
     },
@@ -741,6 +772,11 @@
           "default": true,
           "type": "boolean"
         },
+        "metaCallHint": {
+          "description": "Whether to enable meta __call operator hints.",
+          "default": true,
+          "type": "boolean"
+        },
         "overrideHint": {
           "description": "Whether to enable override hints.",
           "default": true,
@@ -753,6 +789,16 @@
         }
       }
     },
+    "EmmyrcInlineValues": {
+      "type": "object",
+      "properties": {
+        "enable": {
+          "description": "Whether to enable inline values.",
+          "default": true,
+          "type": "boolean"
+        }
+      }
+    },
     "EmmyrcLuaVersion": {
       "oneOf": [
         {

crates/emmylua_code_analysis/src/compilation/analyzer/decl/exprs.rs

@@ -1,6 +1,7 @@
 use emmylua_parser::{
-    LuaAst, LuaAstNode, LuaAstToken, LuaCallExpr, LuaClosureExpr, LuaExpr, LuaIndexExpr,
-    LuaIndexKey, LuaLiteralExpr, LuaLiteralToken, LuaNameExpr, LuaTableExpr, LuaVarExpr,
+    LuaAst, LuaAstNode, LuaAstToken, LuaCallExpr, LuaClosureExpr, LuaDocTagCast, LuaExpr,
+    LuaIndexExpr, LuaIndexKey, LuaLiteralExpr, LuaLiteralToken, LuaNameExpr, LuaTableExpr,
+    LuaVarExpr,
 };
 
 use crate::{
@@ -50,6 +51,9 @@ pub fn analyze_name_expr(analyzer: &mut DeclAnalyzer, expr: LuaNameExpr) -> Opti
 }
 
 pub fn analyze_index_expr(analyzer: &mut DeclAnalyzer, index_expr: LuaIndexExpr) -> Option<()> {
+    if index_expr.ancestors::<LuaDocTagCast>().next().is_some() {
+        return Some(());
+    }
     let index_key = index_expr.get_index_key()?;
     let key = match index_key {
         LuaIndexKey::Name(name) => LuaMemberKey::Name(name.get_name_text().to_string().into()),

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

@@ -66,7 +66,7 @@ pub fn analyze_field(analyzer: &mut DocAnalyzer, tag: LuaDocTagField) -> Option<
     for desc in tag.get_descriptions() {
         let mut desc_text = desc.get_description_text().to_string();
         if !desc_text.is_empty() {
-            let text = preprocess_description(&mut desc_text);
+            let text = preprocess_description(&mut desc_text, Some(&property_owner));
             if !description.is_empty() {
                 description.push_str("\n\n");
             }

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

@@ -1,10 +1,10 @@
 use std::sync::Arc;
 
 use emmylua_parser::{
-    LuaAst, LuaAstNode, LuaDocBinaryType, LuaDocFuncType, LuaDocGenericType,
-    LuaDocMultiLineUnionType, LuaDocObjectFieldKey, LuaDocObjectType, LuaDocStrTplType, LuaDocType,
-    LuaDocUnaryType, LuaDocVariadicType, LuaLiteralToken, LuaSyntaxKind, LuaTypeBinaryOperator,
-    LuaTypeUnaryOperator, LuaVarExpr,
+    LuaAst, LuaAstNode, LuaDocBinaryType, LuaDocDescriptionOwner, LuaDocFuncType,
+    LuaDocGenericType, LuaDocMultiLineUnionType, LuaDocObjectFieldKey, LuaDocObjectType,
+    LuaDocStrTplType, LuaDocType, LuaDocUnaryType, LuaDocVariadicType, LuaLiteralToken,
+    LuaSyntaxKind, LuaTypeBinaryOperator, LuaTypeUnaryOperator, LuaVarExpr,
 };
 use rowan::TextRange;
 use smol_str::SmolStr;
@@ -588,7 +588,8 @@ fn infer_multi_line_union_type(
         };
 
         let description = if let Some(description) = field.get_description() {
-            let description_text = preprocess_description(&description.get_description_text());
+            let description_text =
+                preprocess_description(&description.get_description_text(), None);
             if !description_text.is_empty() {
                 Some(description_text)
             } else {

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

@@ -11,7 +11,7 @@ use super::AnalyzeContext;
 use crate::{
     db_index::{DbIndex, LuaTypeDeclId},
     profile::Profile,
-    FileId,
+    FileId, LuaSemanticDeclId,
 };
 use emmylua_parser::{LuaAstNode, LuaComment, LuaSyntaxNode};
 use file_generic_index::FileGenericIndex;
@@ -44,8 +44,10 @@ fn analyze_comment(analyzer: &mut DocAnalyzer) -> Option<()> {
     }
 
     let owenr = get_owner_id(analyzer)?;
-    let comment_description =
-        preprocess_description(&comment.get_description()?.get_description_text());
+    let comment_description = preprocess_description(
+        &comment.get_description()?.get_description_text(),
+        Some(&owenr),
+    );
     analyzer.db.get_property_index_mut().add_description(
         analyzer.file_id,
         owenr,
@@ -90,9 +92,16 @@ impl<'a> DocAnalyzer<'a> {
     }
 }
 
-pub fn preprocess_description(mut description: &str) -> String {
-    if description.starts_with(['#', '@']) {
-        description = description.trim_start_matches(|c| c == '#' || c == '@');
+pub fn preprocess_description(mut description: &str, owner: Option<&LuaSemanticDeclId>) -> String {
+    let has_remove_start_char = if let Some(owner) = owner {
+        !matches!(owner, LuaSemanticDeclId::Signature(_))
+    } else {
+        true
+    };
+    if has_remove_start_char {
+        if description.starts_with(['#', '@']) {
+            description = description.trim_start_matches(|c| c == '#' || c == '@');
+        }
     }
 
     let mut result = String::new();

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

@@ -74,8 +74,16 @@ fn add_description_for_type_decl(
 ) {
     let mut description_text = String::new();
 
+    // let comment = analyzer.comment.clone();
+    // if let Some(description) = comment.get_description() {
+    //     let description = preprocess_description(&description.get_description_text(), None);
+    //     if !description.is_empty() {
+    //         description_text.push_str(&description);
+    //     }
+    // }
+
     for description in descriptions {
-        let description = preprocess_description(&description.get_description_text());
+        let description = preprocess_description(&description.get_description_text(), None);
         if !description.is_empty() {
             if !description_text.is_empty() {
                 description_text.push_str("\n\n");

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

@@ -116,7 +116,7 @@ pub fn analyze_param(analyzer: &mut DocAnalyzer, tag: LuaDocTagParam) -> Option<
     }
 
     let description = if let Some(des) = tag.get_description() {
-        Some(preprocess_description(&des.get_description_text()))
+        Some(preprocess_description(&des.get_description_text(), None))
     } else {
         None
     };
@@ -155,7 +155,7 @@ pub fn analyze_param(analyzer: &mut DocAnalyzer, tag: LuaDocTagParam) -> Option<
 
 pub fn analyze_return(analyzer: &mut DocAnalyzer, tag: LuaDocTagReturn) -> Option<()> {
     let description = if let Some(des) = tag.get_description() {
-        Some(preprocess_description(&des.get_description_text()))
+        Some(preprocess_description(&des.get_description_text(), None))
     } else {
         None
     };
@@ -383,7 +383,7 @@ pub fn analyze_other(analyzer: &mut DocAnalyzer, other: LuaDocTagOther) -> Optio
     let owner = get_owner_id(analyzer)?;
     let tag_name = other.get_tag_name()?;
     let description = if let Some(des) = other.get_description() {
-        let description = preprocess_description(&des.get_description_text());
+        let description = preprocess_description(&des.get_description_text(), None);
         format!("@*{}* {}", tag_name, description)
     } else {
         format!("@*{}*", tag_name)