attribute: add field_accessor

Author: xuhuanzy

Cargo.lock

@@ -147,7 +147,7 @@
 --- Skip partial diagnostics, typically used to optimize diagnostic performance.
 ---
 --- Receives a parameter, the options are:
---- - `table_field` - Skip diagnostic for `table` fields
+--- - `table_field` - Skip diagnostic for `table` fields. Usually attached to configuration tables that do not require actual diagnostic fields.
 ---@attribute skip_diagnostic(code: string)
 
 --- Index field alias, will be displayed in `hint` and `completion`.
@@ -163,3 +163,12 @@
 --- - `strip_self` - Whether the `self` parameter can be omitted when calling the constructor, defaults to `true`
 --- - `return_self` - Whether the constructor is forced to return `self`, defaults to `true`
 ---@attribute constructor(name: string, strip_self: boolean?, return_self: boolean?)
+
+--- Associates `getter` and `setter` methods with a field. Currently provides only definition navigation functionality,
+--- and the target methods must reside within the same class.
+---
+--- params:
+--- - convention: Naming convention, defaults to `camelCase`. Implicitly adds `get` and `set` prefixes. eg: `_age` -> `getAge`, `setAge`.
+--- - getter: Getter method name. Takes precedence over `convention`.
+--- - setter: Setter method name. Takes precedence over `convention`.
+---@attribute field_accessor(convention: "camelCase"|"PascalCase"|"snake_case"|nil, getter: string?, setter: string?)

crates/emmylua_code_analysis/resources/std/builtin.lua

@@ -43,15 +43,47 @@ pub fn infer_attribute_uses(
     let attribute_uses = tag_use.get_attribute_uses();
     let mut result = Vec::new();
     for attribute_use in attribute_uses {
-        let mut params = Vec::new();
-        if let Some(attribute_call_arg_list) = attribute_use.get_arg_list() {
-            for arg in attribute_call_arg_list.get_args() {
-                let arg_type = infer_attribute_arg_type(arg);
-                params.push(arg_type);
-            }
-        }
         let attribute_type = infer_type(analyzer, LuaDocType::Name(attribute_use.get_type()?));
         if let LuaType::Ref(type_id) = attribute_type {
+            let arg_types: Vec<LuaType> = attribute_use
+                .get_arg_list()
+                .map(|arg_list| arg_list.get_args().map(infer_attribute_arg_type).collect())
+                .unwrap_or_default();
+            let param_names = analyzer
+                .db
+                .get_type_index()
+                .get_type_decl(&type_id)
+                .and_then(|decl| decl.get_attribute_type())
+                .and_then(|typ| match typ {
+                    LuaType::DocAttribute(attr_type) => Some(
+                        attr_type
+                            .get_params()
+                            .iter()
+                            .map(|(name, _)| name.clone())
+                            .collect::<Vec<_>>(),
+                    ),
+                    _ => None,
+                })
+                .unwrap_or_default();
+
+            let mut params = Vec::new();
+            for (idx, arg_type) in arg_types.into_iter().enumerate() {
+                let param_name = param_names
+                    .get(idx)
+                    .cloned()
+                    .or_else(|| {
+                        param_names.last().and_then(|last| {
+                            if last == "..." {
+                                Some(last.clone())
+                            } else {
+                                None
+                            }
+                        })
+                    })
+                    .unwrap_or_default();
+                params.push((param_name, Some(arg_type)));
+            }
+
             result.push(LuaAttributeUse::new(type_id, params));
         }
     }

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

@@ -270,9 +270,12 @@ pub fn try_resolve_constructor(
         .flatten()
         .find(|attr| attr.id.get_name() == "constructor")
         .ok_or(InferFailReason::None)?;
-    let LuaType::DocStringConst(target_signature_name) =
-        constructor_use.args.first().ok_or(InferFailReason::None)?
-    else {
+    let target_signature_type = constructor_use
+        .args
+        .first()
+        .and_then(|(_, typ)| typ.as_ref())
+        .ok_or(InferFailReason::None)?;
+    let LuaType::DocStringConst(target_signature_name) = target_signature_type else {
         return Err(InferFailReason::None);
     };
     let target_type_decl_id = get_constructor_target_type(
@@ -288,20 +291,24 @@ pub fn try_resolve_constructor(
     let members =
         find_members_with_key(db, &target_type, member_key, false).ok_or(InferFailReason::None)?;
     let ctor_signature_member = members.first().ok_or(InferFailReason::None)?;
-    let strip_self = {
-        if let Some(LuaType::DocBooleanConst(strip_self)) = constructor_use.args.get(1) {
-            *strip_self
-        } else {
-            true
-        }
-    };
-    let return_self = {
-        if let Some(LuaType::DocBooleanConst(return_self)) = constructor_use.args.get(2) {
-            *return_self
-        } else {
-            true
-        }
-    };
+    let strip_self = constructor_use
+        .args
+        .get(1)
+        .and_then(|(_, typ)| typ.as_ref())
+        .and_then(|typ| match typ {
+            LuaType::DocBooleanConst(value) => Some(*value),
+            _ => None,
+        })
+        .unwrap_or(true);
+    let return_self = constructor_use
+        .args
+        .get(2)
+        .and_then(|(_, typ)| typ.as_ref())
+        .and_then(|typ| match typ {
+            LuaType::DocBooleanConst(value) => Some(*value),
+            _ => None,
+        })
+        .unwrap_or(true);
     set_signature_to_default_call(db, cache, ctor_signature_member, strip_self, return_self)
         .ok_or(InferFailReason::None)?;
 

crates/emmylua_code_analysis/src/compilation/analyzer/unresolve/resolve.rs

@@ -1,69 +1,6 @@
 #[cfg(test)]
 mod test {
-    use crate::VirtualWorkspace;
-
-    #[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#"
-        // ---@attribute check_point(x: string, y: number)
-        // "#,
-        // );
-
-        // ws.def(
-        //     r#"
-        // ---@attribute SkipDiagnosticTable()
-
-        // ---@[SkipDiagnosticTable, Skip]
-        // local config = {}
-        // "#,
-        // );
-
-        ws.def(
-            r#"
-        ---@class A
-        ---@field a string
-        ---@[Deprecated]
-        ---@field b string
-        "#,
-        );
-
-        // ws.def(
-        //     r#"
-
-        // ---@[deprecated]
-        // local a
-        // "#,
-        // );
-    }
-
-    #[test]
-    fn test_attribute_attach() {
-        let mut ws = VirtualWorkspace::new();
-        // ws.def(
-        //     r#"
-        //     ---@generic [attribute] T
-        //     local function f()
-        //     end
-        // "#,
-        // );
-        ws.def(
-            r#"
-            ---@generic [attribute] T
-            local function f()
-            end
-        "#,
-        );
-    }
+    use crate::{DiagnosticCode, VirtualWorkspace};
 
     #[test]
     fn test_constructor() {
@@ -89,25 +26,18 @@ mod test {
                 "#,
             ),
         ]);
+    }
 
-        // ws.def(
-        //     r#"
-        //     ---@attribute constructor(name: string, strip_self: boolean?, return_self: boolean?)
-
-        //     ---@generic T
-        //     ---@param [constructor("__init")] name `T`
-        //     ---@return T
-        //     function meta(name)
-        //     end
-        // "#,
-        // );
-        // ws.def(
-        //     r#"
-        //     A = meta("A")
+    #[test]
+    fn test_def_attribute() {
+        let mut ws = VirtualWorkspace::new_with_init_std_lib();
 
-        //     function A:__init(a)
-        //     end
-        // "#,
-        // );
+        ws.check_code_for(
+            DiagnosticCode::AssignTypeMismatch,
+            r#"
+        ---@[skip_diagnostic("table_field")]
+        local config = {}
+        "#,
+        );
     }
 }

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

@@ -175,11 +175,18 @@ impl LuaPropertyId {
 #[derive(Debug, Clone, Hash, PartialEq, Eq)]
 pub struct LuaAttributeUse {
     pub id: LuaTypeDeclId,
-    pub args: Vec<LuaType>,
+    pub args: Vec<(String, Option<LuaType>)>,
 }
 
 impl LuaAttributeUse {
-    pub fn new(name: LuaTypeDeclId, args: Vec<LuaType>) -> Self {
-        Self { id: name, args }
+    pub fn new(id: LuaTypeDeclId, args: Vec<(String, Option<LuaType>)>) -> Self {
+        Self { id, args }
+    }
+
+    pub fn get_param_by_name(&self, name: &str) -> Option<&LuaType> {
+        self.args
+            .iter()
+            .find(|(n, _)| n == name)
+            .and_then(|(_, typ)| typ.as_ref())
     }
 }

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

@@ -8,8 +8,8 @@ use rowan::{NodeOrToken, TextRange};
 
 use crate::{
     DiagnosticCode, LuaDeclExtra, LuaDeclId, LuaMemberKey, LuaSemanticDeclId, LuaType,
-    SemanticDeclLevel, SemanticModel, TypeCheckFailReason, TypeCheckResult, VariadicType,
-    infer_index_expr,
+    LuaTypeDeclId, SemanticDeclLevel, SemanticModel, TypeCheckFailReason, TypeCheckResult,
+    VariadicType, infer_index_expr,
 };
 
 use super::{Checker, DiagnosticContext, humanize_lint_type};
@@ -204,6 +204,7 @@ fn check_local_stat(
     Some(())
 }
 
+/// 检查整个表, 返回`true`表示诊断出异常.
 pub fn check_table_expr(
     context: &mut DiagnosticContext,
     semantic_model: &SemanticModel,
@@ -218,16 +219,16 @@ pub fn check_table_expr(
             .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.args.first() {
-                            if code.as_ref() == "table_field" {
-                                return Some(false);
-                            }
-                        };
+            if let Some(skip_diagnostic) =
+                property.find_attribute_use(LuaTypeDeclId::new("skip_diagnostic"))
+            {
+                if let Some(LuaType::DocStringConst(code)) =
+                    skip_diagnostic.get_param_by_name("code")
+                {
+                    if code.as_ref() == "table_field" {
+                        return Some(false);
                     }
-                }
+                };
             }
         }
     }

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

@@ -99,10 +99,11 @@ fn check_deprecated(
     if let Some(attribute_uses) = property.attribute_uses() {
         for attribute_use in attribute_uses.iter() {
             if attribute_use.id.get_name() == "deprecated" {
-                let deprecated_message = match attribute_use.args.first() {
-                    Some(LuaType::DocStringConst(message)) => message.as_ref().to_string(),
-                    _ => "deprecated".to_string(),
-                };
+                let deprecated_message =
+                    match attribute_use.args.first().and_then(|(_, typ)| typ.as_ref()) {
+                        Some(LuaType::DocStringConst(message)) => message.as_ref().to_string(),
+                        _ => "deprecated".to_string(),
+                    };
                 context.add_diagnostic(DiagnosticCode::Deprecated, range, deprecated_message, None);
             }
         }

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

@@ -39,6 +39,7 @@ serde_yml.workspace = true
 itertools.workspace = true
 dirs.workspace = true
 wax.workspace = true
+internment.workspace = true
 
 [dependencies.clap]
 workspace = true

crates/emmylua_ls/Cargo.toml

@@ -363,9 +363,10 @@ pub fn get_index_alias_name(
         .find_attribute_use(LuaTypeDeclId::new("index_alias"))?
         .args
         .first()
-        .map(|param| match param {
-            LuaType::DocStringConst(s) => s.as_ref(),
-            _ => "",
+        .and_then(|(_, typ)| typ.as_ref())
+        .and_then(|param| match param {
+            LuaType::DocStringConst(s) => Some(s.as_ref()),
+            _ => None,
         })?
         .to_string();
     Some(alias_label)