Merge pull request #155 from xuhuanzy/diagnostic

CppCXY · web-flow · commit e780561c0cd9 · 2025-03-07T19:52:14.000+08:00
diagnostic
diff --git a/crates/emmylua_code_analysis/locales/lint.yml b/crates/emmylua_code_analysis/locales/lint.yml
@@ -113,3 +113,16 @@ Annotations specify that at least %{min} return value(s) are required, found %{r
   en: 'Annotations specify that at least %{min} return value(s) are required, found %{rmin} returned here instead.'
   zh_CN: '至少需要 %{min} 个返回值，但此处只返回了 %{rmin} 个'
   zh_HK: '至少需要 %{min} 個回傳值，但此處只返回 %{rmin} 個'
+Cannot use `...` outside a vararg function.:
+  en: Cannot use `...` outside a vararg function.
+  zh_CN: '不能在非可变参数函数中使用 `...`'
+  zh_HK: '不能在非可變參數函數中使用 `...`'
+'Undefined doc param: `%{name}`':
+  en: 'Undefined doc param: `%{name}`'
+  zh_CN: '指向了未定义的参数 `%{name}`'
+  zh_HK: '指向了未定義的參數 `%{name}`'
+'Undefined field: `%{name}`':
+  en: 'Undefined field: `%{name}`'
+  zh_CN: '未定义字段 `%{name}`'
+  zh_HK: '未定義字段 `%{name}`'
+
diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/missing_return_value.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/missing_return_value.rs
@@ -28,17 +28,21 @@ fn check_return_stat(
 
     let signature_id = LuaSignatureId::from_closure(semantic_model.get_file_id(), &closure_expr);
     let signature = context.db.get_signature_index().get(&signature_id)?;
-    let return_types = signature.get_return_types();
+    let min_return_types = signature
+        .get_return_types()
+        .iter()
+        .filter(|ty| !ty.is_optional())
+        .cloned()
+        .collect::<Vec<_>>();
 
-    // 如果没有返回值注解, 则不检查
     if signature.resolve_return != SignatureReturnStatus::DocResolve {
-        return Some(());
+        return None;
     }
 
-    let disable_return_count_check = return_types.iter().any(|ty| ty.is_variadic());
+    let disable_return_count_check = min_return_types.iter().any(|ty| ty.is_variadic());
 
     let expr_return_len = return_stat.get_expr_list().collect::<Vec<_>>().len();
-    let return_types_len = return_types.len();
+    let return_types_len = min_return_types.len();
     if !disable_return_count_check && expr_return_len < return_types_len {
         context.add_diagnostic(
             DiagnosticCode::MissingReturnValue,
diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/mod.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/mod.rs
@@ -13,9 +13,11 @@ mod redundant_parameter;
 mod redundant_return_value;
 mod return_type_mismatch;
 mod syntax_error;
+mod undefined_doc_param;
 mod undefined_global;
 mod unused;
 
+use emmylua_parser::{LuaAstNode, LuaClosureExpr, LuaComment, LuaStat, LuaSyntaxKind};
 use lsp_types::{Diagnostic, DiagnosticSeverity, DiagnosticTag, NumberOrString};
 use rowan::TextRange;
 use std::sync::Arc;
@@ -57,6 +59,7 @@ pub fn check_file(context: &mut DiagnosticContext, semantic_model: &SemanticMode
     check!(redundant_return_value);
     check!(missing_return_value);
     check!(return_type_mismatch);
+    check!(undefined_doc_param);
 
     Some(())
 }
@@ -203,3 +206,18 @@ impl<'a> DiagnosticContext<'a> {
         is_code_default_enable(&code)
     }
 }
+
+pub fn get_closure_expr_comment(closure_expr: &LuaClosureExpr) -> Option<LuaComment> {
+    let comment = closure_expr
+        .ancestors::<LuaStat>()
+        .next()?
+        .syntax()
+        .prev_sibling()?;
+    match comment.kind().into() {
+        LuaSyntaxKind::Comment => {
+            let comment = LuaComment::cast(comment)?;
+            Some(comment)
+        }
+        _ => None,
+    }
+}
diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/redundant_return_value.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/redundant_return_value.rs
@@ -28,10 +28,10 @@ fn check_return_stat(
     let signature = context.db.get_signature_index().get(&signature_id)?;
     let return_types = signature.get_return_types();
 
-    // 如果没有返回值注解, 则不检查
     if signature.resolve_return != SignatureReturnStatus::DocResolve {
-        return Some(());
+        return None;
     }
+
     let disable_return_count_check = return_types.iter().any(|ty| ty.is_variadic());
     let expr_return_len = return_stat.get_expr_list().collect::<Vec<_>>().len();
     let return_types_len = return_types.len();
diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs
@@ -33,9 +33,8 @@ fn check_return_stat(
     let signature_id = LuaSignatureId::from_closure(semantic_model.get_file_id(), &closure_expr);
     let signature = context.db.get_signature_index().get(&signature_id)?;
     let return_types = signature.get_return_types();
-    // 如果没有返回值注解, 则不检查
     if signature.resolve_return != SignatureReturnStatus::DocResolve {
-        return Some(());
+        return None;
     }
 
     for (index, expr) in return_stat.get_expr_list().enumerate() {
diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/syntax_error.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/syntax_error.rs
@@ -1,12 +1,13 @@
 use emmylua_parser::{
-    float_token_value, int_token_value, LuaAstNode, LuaSyntaxToken, LuaTokenKind,
+    float_token_value, int_token_value, LuaAstNode, LuaClosureExpr, LuaLiteralExpr, LuaSyntaxKind,
+    LuaSyntaxToken, LuaTokenKind,
 };
 
-use crate::{DiagnosticCode, SemanticModel};
+use crate::{DiagnosticCode, LuaSignatureId, SemanticModel};
 
 use super::DiagnosticContext;
 
-pub const CODES: &[DiagnosticCode] = &[DiagnosticCode::SyntaxError];
+pub const CODES: &[DiagnosticCode] = &[DiagnosticCode::SyntaxError, DiagnosticCode::LuaSyntaxError];
 
 pub fn check(context: &mut DiagnosticContext, semantic_model: &SemanticModel) -> Option<()> {
     if let Some(parse_errors) = semantic_model.get_file_parse_error() {
@@ -54,6 +55,9 @@ pub fn check(context: &mut DiagnosticContext, semantic_model: &SemanticModel) ->
                         );
                     }
                 }
+                LuaTokenKind::TkDots => {
+                    check_dots_literal_error(context, semantic_model, &token);
+                }
                 _ => {}
             }
         }
@@ -149,3 +153,32 @@ fn check_normal_string_error(string_token: &LuaSyntaxToken) -> Result<(), String
     }
     Ok(())
 }
+
+fn check_dots_literal_error(
+    context: &mut DiagnosticContext,
+    semantic_model: &SemanticModel,
+    dots_token: &LuaSyntaxToken,
+) -> Option<()> {
+    if let Some(literal_expr) = dots_token.parent() {
+        match literal_expr.kind().into() {
+            LuaSyntaxKind::LiteralExpr => {
+                let literal_expr = LuaLiteralExpr::cast(literal_expr)?;
+                let closure_expr = literal_expr.ancestors::<LuaClosureExpr>().next()?;
+                let signature_id =
+                    LuaSignatureId::from_closure(semantic_model.get_file_id(), &closure_expr);
+                let signature = context.db.get_signature_index().get(&signature_id)?;
+                if !signature.params.iter().any(|param| param == "...") {
+                    context.add_diagnostic(
+                        DiagnosticCode::LuaSyntaxError,
+                        literal_expr.get_range(),
+                        t!("Cannot use `...` outside a vararg function.").to_string(),
+                        None,
+                    );
+                }
+            }
+            _ => {}
+        }
+    }
+
+    Some(())
+}
diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/undefined_doc_param.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/undefined_doc_param.rs
@@ -0,0 +1,45 @@
+use emmylua_parser::{LuaAstNode, LuaAstToken, LuaClosureExpr, LuaDocTagParam};
+
+use crate::{DiagnosticCode, LuaSignatureId, SemanticModel};
+
+use super::{get_closure_expr_comment, DiagnosticContext};
+
+pub const CODES: &[DiagnosticCode] = &[DiagnosticCode::UndefinedDocParam];
+
+pub fn check(context: &mut DiagnosticContext, semantic_model: &SemanticModel) -> Option<()> {
+    let root = semantic_model.get_root().clone();
+    for return_stat in root.descendants::<LuaClosureExpr>() {
+        check_doc_param(context, semantic_model, &return_stat);
+    }
+    Some(())
+}
+
+fn check_doc_param(
+    context: &mut DiagnosticContext,
+    semantic_model: &SemanticModel,
+    closure_expr: &LuaClosureExpr,
+) -> Option<()> {
+    let signature_id = LuaSignatureId::from_closure(semantic_model.get_file_id(), &closure_expr);
+    let signature = context.db.get_signature_index().get(&signature_id)?;
+
+    get_closure_expr_comment(closure_expr)?
+        .children::<LuaDocTagParam>()
+        .for_each(|tag| {
+            if let Some(name_token) = tag.get_name_token() {
+                let info = signature.get_param_info_by_name(&name_token.get_name_text());
+                if info.is_none() {
+                    context.add_diagnostic(
+                        DiagnosticCode::UndefinedDocParam,
+                        name_token.get_range(),
+                        t!(
+                            "Undefined doc param: `%{name}`",
+                            name = name_token.get_name_text()
+                        )
+                        .to_string(),
+                        None,
+                    );
+                }
+            }
+        });
+    Some(())
+}
diff --git a/crates/emmylua_code_analysis/src/diagnostic/lua_diagnostic_code.rs b/crates/emmylua_code_analysis/src/diagnostic/lua_diagnostic_code.rs
@@ -10,6 +10,8 @@ use serde::{Deserialize, Serialize};
 pub enum DiagnosticCode {
     /// Syntax error
     SyntaxError,
+    /// Lua syntax error
+    LuaSyntaxError,
     /// Type not found
     TypeNotFound,
     /// Missing return statement
@@ -64,6 +66,10 @@ pub enum DiagnosticCode {
     MissingReturnValue,
     /// Redundant return value
     RedundantReturnValue,
+    /// Undefined Doc Param
+    UndefinedDocParam,
+    /// Duplicate doc field
+    DuplicateDocField,
 
     #[serde(other)]
     None,
@@ -97,7 +103,7 @@ pub fn is_code_default_enable(code: &DiagnosticCode) -> bool {
     match code {
         DiagnosticCode::InjectFieldFail => false,
         DiagnosticCode::DisableGlobalDefine => false,
-        DiagnosticCode::UndefinedField => false,
+        // DiagnosticCode::UndefinedField => false,
         DiagnosticCode::IterVariableReassign => false,
         DiagnosticCode::CodeStyleCheck => false,
         // ... handle other variants
diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/duplicate_doc_field_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/duplicate_doc_field_test.rs
@@ -0,0 +1,19 @@
+#[cfg(test)]
+mod test {
+    // use crate::{DiagnosticCode, VirtualWorkspace};
+
+    // #[test]
+    // fn test() {
+    //     let mut ws = VirtualWorkspace::new();
+
+    //     assert!(!ws.check_code_for(
+    //         DiagnosticCode::DuplicateDocField,
+    //         r#"
+    //         ---@class (partial) Test
+    //         ---@field name string
+    //         ---@field name string
+    //         local Test = {}
+    //         "#
+    //     ));
+    // }
+}
diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/missing_return_value_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/missing_return_value_test.rs
@@ -27,4 +27,20 @@ mod tests {
         "#
         ));
     }
+
+    #[test]
+    fn test_missing_return_value_variadic() {
+        let mut ws = VirtualWorkspace::new();
+
+        assert!(ws.check_code_for(
+            DiagnosticCode::MissingReturnValue,
+            r#"
+            --- @return integer?
+            --- @return integer?
+            function bar()
+                return
+            end
+        "#
+        ));
+    }
 }
diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/mod.rs b/crates/emmylua_code_analysis/src/diagnostic/test/mod.rs
@@ -1,8 +1,10 @@
 mod await_in_sync_test;
 mod disable_line_test;
+mod duplicate_doc_field_test;
 mod missing_parameter_test;
 mod missing_return_value_test;
 mod param_type_check_test;
 mod redundant_parameter_test;
 mod redundant_return_value_test;
 mod return_type_mismatch_test;
+mod undefined_field_test;
diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs
@@ -106,4 +106,26 @@ mod tests {
             "#
         ));
     }
+
+    #[test]
+    fn test_return_dots_syntax_error() {
+        let mut ws = VirtualWorkspace::new();
+
+        assert!(!ws.check_code_for(
+            DiagnosticCode::LuaSyntaxError,
+            r#"
+            function bar()
+                return ...
+            end
+            "#
+        ));
+        assert!(!ws.check_code_for(
+            DiagnosticCode::LuaSyntaxError,
+            r#"
+            function bar()
+                local args = {...}
+            end
+            "#
+        ));
+    }
 }
diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/undefined_doc_param_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/undefined_doc_param_test.rs
@@ -0,0 +1,30 @@
+
+#[cfg(test)]
+mod tests {
+    use crate::{DiagnosticCode, VirtualWorkspace};
+
+
+    #[test]
+    fn test_undefined_doc_param() {
+        let mut ws = VirtualWorkspace::new();
+        assert!(!ws.check_code_for(
+            DiagnosticCode::UndefinedDocParam,
+            r#"
+            ---@param a number
+            ---@param b number
+            function bar(a)
+            end
+        "#
+        ));
+
+        assert!(!ws.check_code_for(
+            DiagnosticCode::UndefinedDocParam,
+            r#"
+            ---@param a string
+            ---@param ccc string
+            local d = call(function(a, b, c)
+            end)
+        "#
+        ));
+    }
+}
diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs
diff --git a/crates/emmylua_ls/locales/action/zh_CN.yaml b/crates/emmylua_ls/locales/action/zh_CN.yaml
diff --git a/crates/emmylua_ls/src/handlers/code_actions/build_actions.rs b/crates/emmylua_ls/src/handlers/code_actions/build_actions.rs
diff --git a/crates/emmylua_parser/src/syntax/node/doc/tag.rs b/crates/emmylua_parser/src/syntax/node/doc/tag.rs
diff --git a/crates/emmylua_parser/src/syntax/node/lua/mod.rs b/crates/emmylua_parser/src/syntax/node/lua/mod.rs
