update attribute: rename lsp_perf_optim to lsp_optimization, add delayed_definition

Author: xuhuanzy

CHANGELOG.md

@@ -12,14 +12,17 @@
 ### ✨ Added
 - **Attribute**: 实现了新的特性`---@attribute`，用于定义附加元数据，内置多个特性：
 ```lua
+
 --- Deprecated. Receives an optional message parameter.
 ---@attribute deprecated(message: string?)
 
---- Language Server Performance Optimization Items.
+--- Language Server Optimization Items.
 ---
---- Receives a parameter, the options are:
---- - `check_table_field` - Skip the assign check for table fields. It is recommended to use this option for all large configuration tables.
----@attribute lsp_perf_optim(code: "check_table_field"|string)
+--- Parameters:
+--- - `check_table_field`: Skip the assign check for table fields. It is recommended to use this option for all large configuration tables.
+--- - `delayed_definition`: Indicates that the type of the variable is determined by the first assignment.
+---    Only valid for `local` declarations with no initial value.
+---@attribute lsp_optimization(code: "check_table_field"|"delayed_definition")
 
 --- Index field alias, will be displayed in `hint` and `completion`.
 ---
@@ -30,19 +33,19 @@
 --- used to specify the default constructor of a class.
 ---
 --- Parameters:
---- - `name` - The name of the method as a constructor.
---- - `root_class` - Used to mark the root class, will implicitly inherit this class, such as `System.Object` in c#. Defaults to empty.
---- - `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`
+--- - `name`: The name of the method as a constructor.
+--- - `root_class`: Used to mark the root class, will implicitly inherit this class, such as `System.Object` in c#. Defaults to empty.
+--- - `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, root_class: 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.
 ---
 --- Parameters:
---- - 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`.
+--- - `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

@@ -144,11 +144,13 @@
 --- Deprecated. Receives an optional message parameter.
 ---@attribute deprecated(message: string?)
 
---- Language Server Performance Optimization Items.
+--- Language Server Optimization Items.
 ---
---- Receives a parameter, the options are:
---- - `check_table_field` - Skip the assign check for table fields. It is recommended to use this option for all large configuration tables.
----@attribute lsp_perf_optim(code: "check_table_field"|string)
+--- Parameters:
+--- - `check_table_field`: Skip the assign check for table fields. It is recommended to use this option for all large configuration tables.
+--- - `delayed_definition`: Indicates that the type of the variable is determined by the first assignment.
+---    Only valid for `local` declarations with no initial value.
+---@attribute lsp_optimization(code: "check_table_field"|"delayed_definition")
 
 --- Index field alias, will be displayed in `hint` and `completion`.
 ---
@@ -159,17 +161,17 @@
 --- used to specify the default constructor of a class.
 ---
 --- Parameters:
---- - `name` - The name of the method as a constructor.
---- - `root_class` - Used to mark the root class, will implicitly inherit this class, such as `System.Object` in c#. Defaults to empty.
---- - `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`
+--- - `name`: The name of the method as a constructor.
+--- - `root_class`: Used to mark the root class, will implicitly inherit this class, such as `System.Object` in c#. Defaults to empty.
+--- - `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, root_class: 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.
 ---
 --- Parameters:
---- - 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`.
+--- - `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/src/compilation/analyzer/lua/stats.rs

@@ -1,10 +1,10 @@
 use emmylua_parser::{
     BinaryOperator, LuaAssignStat, LuaAstNode, LuaExpr, LuaFuncStat, LuaIndexExpr,
-    LuaLocalFuncStat, LuaLocalStat, LuaTableField, LuaVarExpr, PathTrait,
+    LuaLocalFuncStat, LuaLocalStat, LuaNameExpr, LuaTableField, LuaVarExpr, PathTrait,
 };
 
 use crate::{
-    InFiled, InferFailReason, LuaTypeCache, LuaTypeOwner,
+    InFiled, InferFailReason, LuaSemanticDeclId, LuaTypeCache, LuaTypeOwner,
     compilation::analyzer::{
         common::{add_member, bind_type},
         unresolve::{UnResolveDecl, UnResolveMember},
@@ -23,6 +23,10 @@ pub fn analyze_local_stat(analyzer: &mut LuaAnalyzer, local_stat: LuaLocalStat)
         for local_name in name_list {
             let position = local_name.get_position();
             let decl_id = LuaDeclId::new(analyzer.file_id, position);
+            // 标记了延迟定义属性, 此时将跳过绑定类型, 等待第一次赋值时再绑定类型
+            if has_delayed_definition_attribute(analyzer, decl_id) {
+                return Some(());
+            }
             analyzer
                 .db
                 .get_type_index_mut()
@@ -304,6 +308,17 @@ pub fn analyze_assign_stat(analyzer: &mut LuaAnalyzer, assign_stat: LuaAssignSta
                 continue;
             }
         };
+
+        // 如果具有延迟定义属性, 则先绑定最初的定义
+        if let LuaVarExpr::NameExpr(name_expr) = var {
+            if let Some(decl_id) = get_delayed_definition_decl_id(analyzer, name_expr) {
+                bind_type(
+                    analyzer.db,
+                    decl_id.into(),
+                    LuaTypeCache::InferType(expr_type.clone()),
+                );
+            }
+        }
         assign_merge_type_owner_and_expr_type(analyzer, type_owner, &expr_type, 0);
     }
 
@@ -500,3 +515,37 @@ fn special_assign_pattern(
 
     Some(())
 }
+
+fn has_delayed_definition_attribute(analyzer: &LuaAnalyzer, decl_id: LuaDeclId) -> bool {
+    if let Some(property) = analyzer
+        .db
+        .get_property_index()
+        .get_property(&LuaSemanticDeclId::LuaDecl(decl_id))
+    {
+        if let Some(lsp_optimization) = property.find_attribute_use("lsp_optimization") {
+            if let Some(LuaType::DocStringConst(code)) = lsp_optimization.get_param_by_name("code")
+            {
+                if code.as_ref() == "delayed_definition" {
+                    return true;
+                }
+            };
+        }
+    }
+    false
+}
+
+// 获取延迟定义的声明id
+fn get_delayed_definition_decl_id(
+    analyzer: &LuaAnalyzer,
+    name_expr: &LuaNameExpr,
+) -> Option<LuaDeclId> {
+    let file_id = analyzer.file_id;
+    let references_index = analyzer.db.get_reference_index();
+    let range = name_expr.get_range();
+    let file_ref = references_index.get_local_reference(&file_id)?;
+    let decl_id = file_ref.get_decl_id(&range)?;
+    if !has_delayed_definition_attribute(analyzer, decl_id) {
+        return None;
+    }
+    Some(decl_id)
+}

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

@@ -36,9 +36,31 @@ mod test {
         ws.check_code_for(
             DiagnosticCode::AssignTypeMismatch,
             r#"
-        ---@[lsp_perf_optim("check_table_field")]
+        ---@[lsp_optimization("check_table_field")]
         local config = {}
         "#,
         );
     }
+
+    #[test]
+    fn test_delayed_definition() {
+        let mut ws = VirtualWorkspace::new_with_init_std_lib();
+
+        ws.def(
+            r#"
+        ---@[lsp_optimization("delayed_definition")]
+        local config
+
+        function func()
+            A = config
+        end
+
+        config = 1
+        "#,
+        );
+
+        let ty = ws.expr_ty("A");
+        let ty_desc = ws.humanize_type(ty);
+        assert_eq!(ty_desc, "integer");
+    }
 }

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

@@ -110,11 +110,11 @@ impl LuaCommonProperty {
         self.attribute_uses.as_ref()
     }
 
-    pub fn find_attribute_use(&self, id: LuaTypeDeclId) -> Option<&LuaAttributeUse> {
+    pub fn find_attribute_use(&self, id: &str) -> Option<&LuaAttributeUse> {
         self.attribute_uses.as_ref().and_then(|attribute_uses| {
             attribute_uses
                 .iter()
-                .find(|attribute_use| attribute_use.id == id)
+                .find(|attribute_use| attribute_use.id.get_name() == id)
         })
     }
 }

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

@@ -8,8 +8,8 @@ use rowan::{NodeOrToken, TextRange};
 
 use crate::{
     DiagnosticCode, LuaDeclExtra, LuaDeclId, LuaMemberKey, LuaSemanticDeclId, LuaType,
-    LuaTypeDeclId, SemanticDeclLevel, SemanticModel, TypeCheckFailReason, TypeCheckResult,
-    VariadicType, infer_index_expr,
+    SemanticDeclLevel, SemanticModel, TypeCheckFailReason, TypeCheckResult, VariadicType,
+    infer_index_expr,
 };
 
 use super::{Checker, DiagnosticContext, humanize_lint_type};
@@ -219,11 +219,9 @@ pub fn check_table_expr(
             .get_property_index()
             .get_property(&semantic_decl)
         {
-            if let Some(lsp_perf_optim) =
-                property.find_attribute_use(LuaTypeDeclId::new("lsp_perf_optim"))
-            {
+            if let Some(lsp_optimization) = property.find_attribute_use("lsp_optimization") {
                 if let Some(LuaType::DocStringConst(code)) =
-                    lsp_perf_optim.get_param_by_name("code")
+                    lsp_optimization.get_param_by_name("code")
                 {
                     if code.as_ref() == "check_table_field" {
                         return Some(false);

crates/emmylua_ls/src/handlers/completion/add_completions/add_member_completion.rs

@@ -1,5 +1,5 @@
 use emmylua_code_analysis::{
-    DbIndex, LuaMemberInfo, LuaMemberKey, LuaSemanticDeclId, LuaType, LuaTypeDeclId, SemanticModel,
+    DbIndex, LuaMemberInfo, LuaMemberKey, LuaSemanticDeclId, LuaType, SemanticModel,
     try_extract_signature_id_from_field,
 };
 use emmylua_parser::{
@@ -360,7 +360,7 @@ pub fn get_index_alias_name(
     };
 
     let alias_label = common_property
-        .find_attribute_use(LuaTypeDeclId::new("index_alias"))?
+        .find_attribute_use("index_alias")?
         .args
         .first()
         .and_then(|(_, typ)| typ.as_ref())

crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs

@@ -473,7 +473,7 @@ fn try_set_accessor_locations(
         .get_property_index()
         .get_property(&semantic_decl_id)?;
 
-    let attribute_use = property.find_attribute_use(LuaTypeDeclId::new("field_accessor"))?;
+    let attribute_use = property.find_attribute_use("field_accessor")?;
     let has_getter =
         if let Some(LuaType::DocStringConst(getter)) = attribute_use.get_param_by_name("getter") {
             try_add_accessor_location(