Add built-in feature impl: deprecated, skip_diagnostic

Author: xuhuanzy

crates/emmylua_code_analysis/resources/std/builtin.lua

@@ -138,3 +138,19 @@
 ---@alias TypeGuard<T> boolean
 
 ---@alias Language<T: string> string
+
+--- attribute
+
+--- Deprecated. Receives an optional message parameter.
+---@attribute deprecated(message: string?)
+
+--- Skip partial diagnostics, typically used to optimize diagnostic performance.
+---
+--- Receives a parameter, the options are:
+--- - `table_field` - Skip diagnostic for `table` fields
+---@attribute skip_diagnostic(code: string)
+
+--- Index field alias, will be displayed in `hint` and `completion`.
+---
+--- Receives a string parameter for the alias name.
+---@attribute index_alias(name: string)

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

@@ -1,13 +1,14 @@
 use emmylua_parser::{
-    LuaAst, LuaAstNode, LuaDocTagAttributeUse, LuaExpr, LuaKind, LuaLiteralExpr, LuaLiteralToken,
-    LuaSyntaxKind, LuaSyntaxNode,
+    LuaAst, LuaAstNode, LuaDocTagAttributeUse, LuaDocType, LuaExpr, LuaKind, LuaLiteralExpr,
+    LuaLiteralToken, LuaSyntaxKind, LuaSyntaxNode,
 };
 use smol_str::SmolStr;
 
 use crate::{
     LuaAttributeUse, LuaType,
     compilation::analyzer::doc::{
         DocAnalyzer,
+        infer_type::infer_type,
         tags::{get_owner_id, report_orphan_tag},
     },
 };
@@ -33,14 +34,14 @@ pub fn analyze_tag_attribute_use(
                 params.push(arg_type);
             }
         }
-        analyzer.db.get_property_index_mut().add_attribute_use(
-            analyzer.file_id,
-            owner_id.clone(),
-            LuaAttributeUse::new(
-                attribute_use.get_name_token()?.get_name_text().to_string(),
-                params,
-            ),
-        );
+        let attribute_type = infer_type(analyzer, LuaDocType::Name(attribute_use.get_type()?));
+        if let LuaType::Ref(type_id) = attribute_type {
+            analyzer.db.get_property_index_mut().add_attribute_use(
+                analyzer.file_id,
+                owner_id.clone(),
+                LuaAttributeUse::new(type_id, params),
+            );
+        }
     }
     Some(())
 }

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

@@ -5,6 +5,13 @@ mod test {
     #[test]
     fn test_def_attribute() {
         let mut ws = VirtualWorkspace::new();
+        ws.def(
+            r#"
+        ---@attribute Deprecated(message: string?)
+        ---@attribute SkipDiagnosticTable() -- 跳过对表的部分诊断, 用于优化性能, 通常来说对巨型配置表使用.
+        ---@attribute IndexFieldAlias(name: string) -- 索引字段别名, 将在`hint`与`completion`中显示别名.
+        "#,
+        );
 
         // ws.def(
         //     r#"
@@ -25,7 +32,7 @@ mod test {
             r#"
         ---@class A
         ---@field a string
-        ---@[deprecated]
+        ---@[Deprecated]
         ---@field b string
         "#,
         );

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

@@ -3,7 +3,7 @@ use std::sync::Arc;
 use emmylua_parser::{LuaVersionCondition, VisibilityKind};
 
 use crate::{
-    LuaType,
+    LuaType, LuaTypeDeclId,
     db_index::property::decl_feature::{DeclFeatureFlag, PropertyDeclFeature},
 };
 
@@ -105,6 +105,10 @@ impl LuaCommonProperty {
         )
         .push(attribute_use);
     }
+
+    pub fn attribute_uses(&self) -> Option<&Arc<Vec<LuaAttributeUse>>> {
+        self.attribute_uses.as_ref()
+    }
 }
 
 #[derive(Debug, Clone, PartialEq, Eq)]
@@ -162,12 +166,12 @@ impl LuaPropertyId {
 
 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
 pub struct LuaAttributeUse {
-    pub name: String,
+    pub id: LuaTypeDeclId,
     pub params: Vec<LuaType>,
 }
 
 impl LuaAttributeUse {
-    pub fn new(name: String, params: Vec<LuaType>) -> Self {
-        Self { name, params }
+    pub fn new(name: LuaTypeDeclId, params: Vec<LuaType>) -> Self {
+        Self { id: name, params }
     }
 }

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

@@ -2,9 +2,9 @@ use std::ops::Deref;
 
 use emmylua_parser::{
     LuaAssignStat, LuaAst, LuaAstNode, LuaAstToken, LuaExpr, LuaIndexExpr, LuaLocalStat,
-    LuaNameExpr, LuaTableExpr, LuaVarExpr,
+    LuaNameExpr, LuaSyntaxNode, LuaSyntaxToken, LuaTableExpr, LuaVarExpr,
 };
-use rowan::TextRange;
+use rowan::{NodeOrToken, TextRange};
 
 use crate::{
     DiagnosticCode, LuaDeclExtra, LuaDeclId, LuaMemberKey, LuaSemanticDeclId, LuaType,
@@ -78,7 +78,7 @@ fn check_name_expr(
         rowan::NodeOrToken::Node(name_expr.syntax().clone()),
         SemanticDeclLevel::default(),
     )?;
-    let source_type = match semantic_decl {
+    let source_type = match semantic_decl.clone() {
         LuaSemanticDeclId::LuaDecl(decl_id) => {
             let decl = semantic_model
                 .get_db()
@@ -116,9 +116,9 @@ fn check_name_expr(
         check_table_expr(
             context,
             semantic_model,
+            rowan::NodeOrToken::Node(name_expr.syntax().clone()),
             &expr,
             source_type.as_ref(),
-            Some(&value_type),
         );
     }
 
@@ -152,9 +152,9 @@ fn check_index_expr(
         check_table_expr(
             context,
             semantic_model,
+            rowan::NodeOrToken::Node(index_expr.syntax().clone()),
             &expr,
             source_type.as_ref(),
-            Some(&value_type),
         );
     }
     Some(())
@@ -195,9 +195,9 @@ fn check_local_stat(
             check_table_expr(
                 context,
                 semantic_model,
+                rowan::NodeOrToken::Node(var.syntax().clone()),
                 expr,
                 Some(&var_type),
-                Some(&value_type),
             );
         }
     }
@@ -207,19 +207,32 @@ fn check_local_stat(
 pub fn check_table_expr(
     context: &mut DiagnosticContext,
     semantic_model: &SemanticModel,
+    decl_node: NodeOrToken<LuaSyntaxNode, LuaSyntaxToken>,
     table_expr: &LuaExpr,
     table_type: Option<&LuaType>, // 记录的类型
-    _expr_type: Option<&LuaType>, // 实际表达式推导出的类型
 ) -> Option<bool> {
-    // 需要进行一些过滤
-    // if table_type == expr_type {
-    //     return Some(false);
-    // }
+    // 检查是否附加了元数据以跳过诊断
+    if let Some(semantic_decl) = semantic_model.find_decl(decl_node, SemanticDeclLevel::default()) {
+        if let Some(property) = semantic_model
+            .get_db()
+            .get_property_index()
+            .get_property(&semantic_decl)
+        {
+            if let Some(attribute_uses) = property.attribute_uses() {
+                for attribute_use in attribute_uses.iter() {
+                    if attribute_use.id.get_name() == "skip_diagnostic" {
+                        if let Some(LuaType::DocStringConst(code)) = attribute_use.params.get(0) {
+                            if code.as_ref() == "table_field" {
+                                return Some(false);
+                            }
+                        };
+                    }
+                }
+            }
+        }
+    }
+
     let table_type = table_type?;
-    // match table_type {
-    //     LuaType::Def(_) => return Some(false),
-    //     _ => {}
-    // }
     if let Some(table_expr) = LuaTableExpr::cast(table_expr.syntax().clone()) {
         return check_table_expr_content(context, semantic_model, table_type, &table_expr);
     }

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

@@ -1,8 +1,8 @@
 use emmylua_parser::{LuaAst, LuaAstNode, LuaIndexExpr, LuaNameExpr};
 
 use crate::{
-    DiagnosticCode, LuaDeclId, LuaDeprecated, LuaMemberId, LuaSemanticDeclId, SemanticDeclLevel,
-    SemanticModel,
+    DiagnosticCode, LuaDeclId, LuaDeprecated, LuaMemberId, LuaSemanticDeclId, LuaType,
+    SemanticDeclLevel, SemanticModel,
 };
 
 use super::{Checker, DiagnosticContext};
@@ -45,23 +45,12 @@ fn check_name_expr(
         return Some(());
     }
 
-    let property = semantic_model
-        .get_db()
-        .get_property_index()
-        .get_property(&semantic_decl)?;
-    if let Some(deprecated) = property.deprecated() {
-        let depreacated_message = match deprecated {
-            LuaDeprecated::Deprecated => "deprecated".to_string(),
-            LuaDeprecated::DeprecatedWithMessage(message) => message.to_string(),
-        };
-
-        context.add_diagnostic(
-            DiagnosticCode::Deprecated,
-            name_expr.get_range(),
-            depreacated_message,
-            None,
-        );
-    }
+    check_deprecated(
+        context,
+        semantic_model,
+        &semantic_decl,
+        name_expr.get_range(),
+    );
     Some(())
 }
 
@@ -80,24 +69,47 @@ fn check_index_expr(
     {
         return Some(());
     }
+    let index_name_range = index_expr.get_index_name_token()?.text_range();
+    check_deprecated(context, semantic_model, &semantic_decl, index_name_range);
+    Some(())
+}
+
+fn check_deprecated(
+    context: &mut DiagnosticContext,
+    semantic_model: &SemanticModel,
+    semantic_decl: &LuaSemanticDeclId,
+    range: rowan::TextRange,
+) {
     let property = semantic_model
         .get_db()
         .get_property_index()
-        .get_property(&semantic_decl)?;
+        .get_property(semantic_decl);
+    let Some(property) = property else {
+        return;
+    };
     if let Some(deprecated) = property.deprecated() {
         let depreacated_message = match deprecated {
             LuaDeprecated::Deprecated => "deprecated".to_string(),
             LuaDeprecated::DeprecatedWithMessage(message) => message.to_string(),
         };
 
-        let index_name_range = index_expr.get_index_name_token()?.text_range();
-
-        context.add_diagnostic(
-            DiagnosticCode::Deprecated,
-            index_name_range,
-            depreacated_message,
-            None,
-        );
+        context.add_diagnostic(DiagnosticCode::Deprecated, range, depreacated_message, None);
+    }
+    // 检查特性
+    if let Some(attribute_uses) = property.attribute_uses() {
+        for attribute_use in attribute_uses.iter() {
+            if attribute_use.id.get_name() == "deprecated" {
+                let depreacated_message = match attribute_use.params.first() {
+                    Some(LuaType::DocStringConst(message)) => message.as_ref().to_string(),
+                    _ => "deprecated".to_string(),
+                };
+                context.add_diagnostic(
+                    DiagnosticCode::Deprecated,
+                    range,
+                    depreacated_message,
+                    None,
+                );
+            }
+        }
     }
-    Some(())
 }

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

@@ -105,9 +105,9 @@ fn check_call_expr(
                         && let Some(add_diagnostic) = check_table_expr(
                             context,
                             semantic_model,
+                            rowan::NodeOrToken::Node(arg_expr.syntax().clone()),
                             arg_expr,
                             Some(&param_type),
-                            Some(arg_type),
                         )
                         && add_diagnostic
                     {

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

@@ -94,9 +94,9 @@ fn check_return_stat(
                         check_table_expr(
                             context,
                             semantic_model,
+                            rowan::NodeOrToken::Node(return_expr.syntax().clone()),
                             return_expr,
                             Some(check_type),
-                            Some(return_expr_type),
                         );
                     }
 
@@ -132,9 +132,9 @@ fn check_return_stat(
                     if let Some(add_diagnostic) = check_table_expr(
                         context,
                         semantic_model,
+                        rowan::NodeOrToken::Node(return_expr.syntax().clone()),
                         return_expr,
                         Some(return_type),
-                        Some(return_expr_type),
                     ) && add_diagnostic
                     {
                         return Some(());

crates/emmylua_parser/src/grammar/doc/tag.rs

@@ -708,7 +708,7 @@ pub fn parse_attribute_use(p: &mut LuaDocParser) -> DocParseResult {
 fn parse_doc_attribute_use(p: &mut LuaDocParser) -> DocParseResult {
     let m = p.mark(LuaSyntaxKind::DocAttributeUse);
 
-    expect_token(p, LuaTokenKind::TkName)?;
+    parse_type(p)?;
 
     // 解析参数列表, 允许没有参数的特性在使用时省略括号
     if p.current_token() == LuaTokenKind::TkLeftParen {

crates/emmylua_parser/src/grammar/doc/test.rs

@@ -2913,11 +2913,13 @@ Syntax(Chunk)@0..105
       Syntax(DocTagAttributeUse)@69..96
         Token(TkDocAttribute)@69..70 "["
         Syntax(DocAttributeUse)@70..74
-          Token(TkName)@70..74 "Skip"
+          Syntax(TypeName)@70..74
+            Token(TkName)@70..74 "Skip"
         Token(TkComma)@74..75 ","
         Token(TkWhitespace)@75..76 " "
         Syntax(DocAttributeUse)@76..95
-          Token(TkName)@76..87 "check_point"
+          Syntax(TypeName)@76..87
+            Token(TkName)@76..87 "check_point"
           Syntax(DocAttributeCallArgList)@87..95
             Token(TkLeftParen)@87..88 "("
             Syntax(LiteralExpr)@88..91