修改索引别名实现

Author: xuhuanzy

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

@@ -109,6 +109,14 @@ impl LuaCommonProperty {
     pub fn attribute_uses(&self) -> Option<&Arc<Vec<LuaAttributeUse>>> {
         self.attribute_uses.as_ref()
     }
+
+    pub fn find_attribute_use(&self, id: LuaTypeDeclId) -> Option<&LuaAttributeUse> {
+        self.attribute_uses.as_ref().and_then(|attribute_uses| {
+            attribute_uses
+                .iter()
+                .find(|attribute_use| attribute_use.id == id)
+        })
+    }
 }
 
 #[derive(Debug, Clone, PartialEq, Eq)]

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, SemanticModel,
+    DbIndex, LuaMemberInfo, LuaMemberKey, LuaSemanticDeclId, LuaType, LuaTypeDeclId, SemanticModel,
     try_extract_signature_id_from_field,
 };
 use emmylua_parser::{
@@ -131,8 +131,8 @@ pub fn add_member_completion(
         );
     }
 
-    // 尝试添加别名补全项, 如果添加成功, 则不添加原本 `[index]` 补全项
-    if !try_add_alias_completion_item(builder, &member_info, &completion_item, &label)
+    // 尝试添加别名补全项, 如果添加成功, 则不添加原来的 `[index]` 补全项
+    if !try_add_alias_completion_item_new(builder, &member_info, &completion_item, &label)
         .unwrap_or(false)
     {
         builder.add_completion_item(completion_item)?;
@@ -312,13 +312,77 @@ fn get_resolve_function_params_str(typ: &LuaType, display: CallDisplay) -> Optio
     }
 }
 
+fn try_add_alias_completion_item_new(
+    builder: &mut CompletionBuilder,
+    member_info: &LuaMemberInfo,
+    completion_item: &CompletionItem,
+    label: &String,
+) -> Option<bool> {
+    let alias_label = get_index_alias_name(&builder.semantic_model, member_info)?;
+    let mut alias_completion_item = completion_item.clone();
+    alias_completion_item.label = alias_label;
+    alias_completion_item.insert_text = Some(label.clone());
+
+    // 更新 label_details 添加别名提示
+    let index_hint = t!("completion.index %{label}", label = label).to_string();
+    let label_details = alias_completion_item
+        .label_details
+        .get_or_insert_with(Default::default);
+    label_details.description = match label_details.description.take() {
+        Some(desc) => Some(format!("({}) {} ", index_hint, desc)),
+        None => Some(index_hint),
+    };
+    builder.add_completion_item(alias_completion_item)?;
+    Some(true)
+}
+
+pub fn get_index_alias_name(
+    semantic_model: &SemanticModel,
+    member_info: &LuaMemberInfo,
+) -> Option<String> {
+    let db = semantic_model.get_db();
+    let LuaMemberKey::Integer(_) = member_info.key else {
+        return None;
+    };
+
+    let property_owner_id = member_info.property_owner_id.as_ref()?;
+    let LuaSemanticDeclId::Member(member_id) = property_owner_id else {
+        return None;
+    };
+    let common_property = match db.get_property_index().get_property(property_owner_id) {
+        Some(common_property) => common_property,
+        None => {
+            // field定义的`signature`的`common_property`绑定位置稍有不同, 需要特殊处理
+            let member = db.get_member_index().get_member(member_id)?;
+            let signature_id =
+                try_extract_signature_id_from_field(semantic_model.get_db(), member)?;
+            db.get_property_index()
+                .get_property(&LuaSemanticDeclId::Signature(signature_id))?
+        }
+    };
+
+    let alias_label = common_property
+        .find_attribute_use(LuaTypeDeclId::new("index_alias"))?
+        .params
+        .get(0)
+        .map(|param| match param {
+            LuaType::DocStringConst(s) => s.as_ref(),
+            _ => "",
+        })?
+        .to_string();
+    Some(alias_label)
+}
+
+#[deprecated]
+#[allow(dead_code)]
 /// 添加索引成员的别名补全项
 fn try_add_alias_completion_item(
     builder: &mut CompletionBuilder,
     member_info: &LuaMemberInfo,
     completion_item: &CompletionItem,
     label: &String,
 ) -> Option<bool> {
+    #[allow(deprecated)]
     let alias_label = extract_index_member_alias(&builder.semantic_model, member_info)?;
 
     let mut alias_completion_item = completion_item.clone();
@@ -338,9 +402,10 @@ fn try_add_alias_completion_item(
     Some(true)
 }
 
+#[deprecated]
 /// 从注释中提取索引成员的别名, 只处理整数成员.
 /// 格式为`-- [nameX]`.
-pub fn extract_index_member_alias(
+fn extract_index_member_alias(
     semantic_model: &SemanticModel,
     member_info: &LuaMemberInfo,
 ) -> Option<String> {

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

@@ -3,7 +3,7 @@ mod add_member_completion;
 mod check_match_word;
 
 pub use add_decl_completion::add_decl_completion;
-pub use add_member_completion::extract_index_member_alias;
+pub use add_member_completion::get_index_alias_name;
 pub use add_member_completion::{CompletionTriggerStatus, add_member_completion};
 pub use check_match_word::check_match_word;
 use emmylua_code_analysis::{LuaSemanticDeclId, LuaType, RenderLevel};

crates/emmylua_ls/src/handlers/completion/mod.rs

@@ -5,7 +5,7 @@ mod data;
 mod providers;
 mod resolve_completion;
 
-pub use add_completions::extract_index_member_alias;
+pub use add_completions::get_index_alias_name;
 use completion_builder::CompletionBuilder;
 use completion_data::CompletionData;
 use emmylua_code_analysis::{EmmyLuaAnalysis, FileId};

crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs

@@ -17,7 +17,7 @@ use rowan::NodeOrToken;
 
 use rowan::TokenAtOffset;
 
-use crate::handlers::completion::extract_index_member_alias;
+use crate::handlers::completion::get_index_alias_name;
 use crate::handlers::definition::compare_function_types;
 use crate::handlers::inlay_hint::build_function_hint::{build_closure_hint, build_label_parts};
 
@@ -645,7 +645,7 @@ fn build_index_expr_hint(
     let member_infos = semantic_model.get_member_info_with_key(&prefix_type, member_key, false)?;
     let member_info = member_infos.first()?;
     // 尝试提取别名
-    let alias = extract_index_member_alias(semantic_model, member_info)?;
+    let alias = get_index_alias_name(semantic_model, member_info)?;
     // 创建 hint
     let document = semantic_model.get_document();
     let position = {

crates/emmylua_ls/src/handlers/test/completion_test.rs

@@ -1146,10 +1146,11 @@ mod tests {
     #[gtest]
     fn test_index_key_alias() -> Result<()> {
         let mut ws = ProviderVirtualWorkspace::new();
+        ws.def(" ---@attribute index_alias(name: string)");
         check!(ws.check_completion(
             r#"
                 local export = {
-                    [1] = 1, -- [nameX]
+                    [1] = 1, ---@[index_alias("nameX")]
                 }
 
                 export.<??>
@@ -1215,11 +1216,12 @@ mod tests {
 
     #[gtest]
     fn test_field_index_function() -> Result<()> {
-        let mut ws = ProviderVirtualWorkspace::new();
+        let mut ws = ProviderVirtualWorkspace::new_with_init_std_lib();
         ws.def(
             r#"
                 ---@class A<T>
-                ---@field [1] fun() # [next]
+                ---@[index_alias("next")]
+                ---@field [1] fun()
                 A = {}
             "#,
         );

crates/emmylua_ls/src/handlers/test/inlay_hint_test.rs

@@ -167,16 +167,18 @@ mod tests {
     #[gtest]
     fn test_index_key_alias_hint() -> Result<()> {
         let mut ws = ProviderVirtualWorkspace::new();
+        ws.def(" ---@attribute index_alias(name: string)");
         check!(ws.check_inlay_hint(
             r#"
                 local export = {
-                    [1] = 1, -- [nameX]
+                    ---@[index_alias("nameX")]
+                    [1] = 1,
                 }
                 print(export[1])
             "#,
             vec![VirtualInlayHint {
                 label: ": nameX".to_string(),
-                line: 4,
+                line: 5,
                 pos: 30,
                 ref_file: Some("".to_string()),
             }]