feature: 索引成员允许定义一个别名, 补全时将使用该别名作为显示

如果注释以 [xxx] 开头则认为为索引添加了一个补全用别名, 在`[]`内部也允许前后存在空白字符.
```lua
---@Class Point
---@field [1] number # 	[ x ]
---@field [2] number # [y]
---@field [3] number # [z]
---@field [4] number # 前面存在非空白字符则不是在定义补全用别名. [error]

local test = {
    [1] = 1, -- [nameA]
}

```

Author: xuhuanzy

crates/emmylua_ls/locales/misc.yaml

@@ -0,0 +1,5 @@
+_version: 2
+completion.index %{label}:
+  en: index %{label}
+  zh_CN: 索引 %{label}
+  zh_HK: 索引 %{label}

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

@@ -18,14 +18,14 @@ pub fn add_decl_completion(
     let property_owner = LuaSemanticDeclId::LuaDecl(decl_id);
     check_visibility(builder, property_owner.clone())?;
 
-    let function_overload_count = count_function_overloads(builder.semantic_model.get_db(), typ);
+    let overload_count = count_function_overloads(builder.semantic_model.get_db(), typ);
     let mut completion_item = CompletionItem {
         label: name.to_string(),
         kind: Some(get_completion_kind(&typ)),
         data: CompletionData::from_property_owner_id(
             builder,
             decl_id.into(),
-            function_overload_count,
+            overload_count,
         ),
         label_details: Some(lsp_types::CompletionItemLabelDetails {
             detail: get_detail(builder, &typ, CallDisplay::None),

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

@@ -26,7 +26,7 @@ pub fn add_member_completion(
     builder: &mut CompletionBuilder,
     member_info: LuaMemberInfo,
     status: CompletionTriggerStatus,
-    function_overload_count: Option<usize>,
+    overload_count: Option<usize>,
 ) -> Option<()> {
     if builder.is_cancelled() {
         return None;
@@ -58,28 +58,19 @@ pub fn add_member_completion(
         },
     };
 
-    let typ = member_info.typ;
+    let typ = &member_info.typ;
     let remove_nil_type =
-        get_function_remove_nil(&builder.semantic_model.get_db(), &typ).unwrap_or(typ);
+        get_function_remove_nil(&builder.semantic_model.get_db(), typ).unwrap_or(typ.clone());
     if status == CompletionTriggerStatus::Colon && !remove_nil_type.is_function() {
         return None;
     }
 
     // 附加数据, 用于在`resolve`时进一步处理
     let completion_data = if let Some(id) = &property_owner {
         if let Some(index) = member_info.overload_index {
-            CompletionData::from_overload(
-                builder,
-                id.clone().into(),
-                index,
-                function_overload_count,
-            )
+            CompletionData::from_overload(builder, id.clone().into(), index, overload_count)
         } else {
-            CompletionData::from_property_owner_id(
-                builder,
-                id.clone().into(),
-                function_overload_count,
-            )
+            CompletionData::from_property_owner_id(builder, id.clone().into(), overload_count)
         }
     } else {
         None
@@ -137,7 +128,12 @@ pub fn add_member_completion(
         );
     }
 
-    builder.add_completion_item(completion_item)?;
+    // 尝试添加别名补全项, 如果添加成功, 则不添加原本 `[index]` 补全项
+    if !try_add_alias_completion_item(builder, &member_info, &completion_item, &label)
+        .unwrap_or(false)
+    {
+        builder.add_completion_item(completion_item)?;
+    }
 
     // add overloads if the type is function
     add_signature_overloads(
@@ -147,7 +143,7 @@ pub fn add_member_completion(
         call_display,
         deprecated,
         label,
-        function_overload_count,
+        overload_count,
     );
 
     Some(())
@@ -312,3 +308,82 @@ fn get_resolve_function_params_str(typ: &LuaType, display: CallDisplay) -> Optio
         _ => None,
     }
 }
+
+/// 添加索引成员的别名补全项
+fn try_add_alias_completion_item(
+    builder: &mut CompletionBuilder,
+    member_info: &LuaMemberInfo,
+    completion_item: &CompletionItem,
+    label: &String,
+) -> Option<bool> {
+    let alias_label = extract_index_member_alias(builder, 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)
+}
+
+/// 从注释中提取索引成员的别名, 只处理整数成员.
+/// 格式为`-- [nameX]`.
+fn extract_index_member_alias(
+    builder: &mut CompletionBuilder,
+    member_info: &LuaMemberInfo,
+) -> Option<String> {
+    let LuaMemberKey::Integer(_) = member_info.key else {
+        return None;
+    };
+
+    let property_owner_id = member_info.property_owner_id.as_ref()?;
+    let LuaSemanticDeclId::Member(_) = property_owner_id else {
+        return None;
+    };
+
+    let description = builder
+        .semantic_model
+        .get_db()
+        .get_property_index()
+        .get_property(property_owner_id)?
+        .description
+        .as_ref()?;
+
+    // 只去掉左侧空白字符，保留右侧内容以支持后续文本
+    let left_trimmed = description.trim_start();
+    if !left_trimmed.starts_with('[') {
+        return None;
+    }
+
+    // 找到对应的右方括号
+    let close_bracket_pos = left_trimmed.find(']')?;
+
+    let content = left_trimmed[1..close_bracket_pos].trim();
+
+    if content.is_empty() {
+        return None;
+    }
+
+    let first_char = content.chars().next()?;
+    if !first_char.is_alphabetic() && first_char != '_' {
+        return None;
+    }
+
+    if !content.chars().all(|c| c.is_alphanumeric() || c == '_') {
+        return None;
+    }
+    if content.parse::<i64>().is_ok() || content.parse::<f64>().is_ok() {
+        return None;
+    }
+
+    Some(content.to_string())
+}

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

@@ -9,20 +9,20 @@ pub struct CompletionData {
     pub field_id: FileId,
     pub typ: CompletionDataType,
     /// Total count of function overloads
-    pub function_overload_count: Option<usize>,
+    pub overload_count: Option<usize>,
 }
 
 #[allow(unused)]
 impl CompletionData {
     pub fn from_property_owner_id(
         builder: &CompletionBuilder,
         id: LuaSemanticDeclId,
-        function_overload_count: Option<usize>,
+        overload_count: Option<usize>,
     ) -> Option<Value> {
         let data = Self {
             field_id: builder.semantic_model.get_file_id(),
             typ: CompletionDataType::PropertyOwnerId(id),
-            function_overload_count,
+            overload_count,
         };
         Some(serde_json::to_value(data).unwrap())
     }
@@ -31,12 +31,12 @@ impl CompletionData {
         builder: &CompletionBuilder,
         id: LuaSemanticDeclId,
         index: usize,
-        function_overload_count: Option<usize>,
+        overload_count: Option<usize>,
     ) -> Option<Value> {
         let data = Self {
             field_id: builder.semantic_model.get_file_id(),
             typ: CompletionDataType::Overload((id, index)),
-            function_overload_count,
+            overload_count,
         };
         Some(serde_json::to_value(data).unwrap())
     }
@@ -45,7 +45,7 @@ impl CompletionData {
         let data = Self {
             field_id: builder.semantic_model.get_file_id(),
             typ: CompletionDataType::Module(module),
-            function_overload_count: None,
+            overload_count: None,
         };
         Some(serde_json::to_value(data).unwrap())
     }
@@ -81,7 +81,7 @@ pub enum CompletionDataType {
 //             },
 //         };
 
-//         let overload_part = match self.function_overload_count {
+//         let overload_part = match self.overload_count {
 //             Some(count) => format!("|{}", count),
 //             None => String::new(),
 //         };
@@ -160,8 +160,8 @@ pub enum CompletionDataType {
 //                     return Err(E::custom("expected ':' separator in type part"));
 //                 };
 
-//                 // Parse function_overload_count
-//                 let function_overload_count = if parts.len() == 3 {
+//                 // Parse overload_count
+//                 let overload_count = if parts.len() == 3 {
 //                     if parts[2].is_empty() {
 //                         None
 //                     } else {
@@ -178,7 +178,7 @@ pub enum CompletionDataType {
 //                 Ok(CompletionData {
 //                     field_id,
 //                     typ,
-//                     function_overload_count,
+//                     overload_count,
 //                 })
 //             }
 //         }
@@ -199,7 +199,7 @@ pub enum CompletionDataType {
 //         let data = CompletionData {
 //             field_id: FileId::new(1),
 //             typ: CompletionDataType::PropertyOwnerId(LuaSemanticDeclId::TypeDecl(type_id)),
-//             function_overload_count: Some(3),
+//             overload_count: Some(3),
 //         };
 
 //         // Test serialization
@@ -219,7 +219,7 @@ pub enum CompletionDataType {
 //         let data = CompletionData {
 //             field_id: FileId::new(42),
 //             typ: CompletionDataType::Module("socket.core".to_string()),
-//             function_overload_count: None,
+//             overload_count: None,
 //         };
 
 //         let json = serde_json::to_string(&data).unwrap();
@@ -235,7 +235,7 @@ pub enum CompletionDataType {
 //         let data = CompletionData {
 //             field_id: FileId::new(10),
 //             typ: CompletionDataType::Overload((LuaSemanticDeclId::TypeDecl(type_id), 2)),
-//             function_overload_count: Some(5),
+//             overload_count: Some(5),
 //         };
 
 //         let json = serde_json::to_string(&data).unwrap();
@@ -251,7 +251,7 @@ pub enum CompletionDataType {
 //         let data = CompletionData {
 //             field_id: FileId::new(999),
 //             typ: CompletionDataType::PropertyOwnerId(LuaSemanticDeclId::TypeDecl(type_id.clone())),
-//             function_overload_count: Some(10),
+//             overload_count: Some(10),
 //         };
 
 //         // Our compact serialization
@@ -262,13 +262,13 @@ pub enum CompletionDataType {
 //         struct DefaultSerialized {
 //             field_id: u32,
 //             typ: CompletionDataType,
-//             function_overload_count: Option<usize>,
+//             overload_count: Option<usize>,
 //         }
 
 //         let default_data = DefaultSerialized {
 //             field_id: data.field_id.id,
 //             typ: data.typ.clone(),
-//             function_overload_count: data.function_overload_count,
+//             overload_count: data.overload_count,
 //         };
 
 //         let default_json = serde_json::to_string(&default_data).unwrap();

crates/emmylua_ls/src/handlers/completion/providers/member_provider.rs

@@ -104,7 +104,7 @@ fn add_resolve_member_infos(
         .iter()
         .all(|info| matches!(info.typ, LuaType::DocFunction(_)));
 
-    let function_count = count_function_overloads(builder.semantic_model.get_db(), &member_infos);
+    let overload_count = count_function_overloads(builder.semantic_model.get_db(), &member_infos);
 
     for member_info in member_infos {
         match resolve_state {
@@ -113,7 +113,7 @@ fn add_resolve_member_infos(
                     builder,
                     member_info.clone(),
                     completion_status,
-                    function_count,
+                    overload_count,
                 );
                 if limit_doc_function {
                     break;
@@ -126,7 +126,7 @@ fn add_resolve_member_infos(
                             builder,
                             member_info.clone(),
                             completion_status,
-                            function_count,
+                            overload_count,
                         );
                         if limit_doc_function {
                             break;
@@ -141,7 +141,7 @@ fn add_resolve_member_infos(
                             builder,
                             member_info.clone(),
                             completion_status,
-                            function_count,
+                            overload_count,
                         );
                         if limit_doc_function {
                             break;

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

@@ -39,7 +39,7 @@ pub fn add_completions(builder: &mut CompletionBuilder) -> Option<()> {
 
     for (index, item) in builder.get_completion_items_mut().iter_mut().enumerate() {
         if item.sort_text.is_none() {
-            item.sort_text = Some(format!("{:04}", index + 1));
+            item.sort_text = Some(format!("{:04}", index + 32));
         }
     }
 

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

@@ -24,7 +24,7 @@ pub fn resolve_completion(
             if let Some(mut hover_builder) = hover_builder {
                 update_function_signature_info(
                     &mut hover_builder,
-                    completion_data.function_overload_count,
+                    completion_data.overload_count,
                 );
                 if client_id.is_vscode() {
                     build_vscode_completion_item(completion_item, hover_builder, None);
@@ -39,7 +39,7 @@ pub fn resolve_completion(
             if let Some(mut hover_builder) = hover_builder {
                 update_function_signature_info(
                     &mut hover_builder,
-                    completion_data.function_overload_count,
+                    completion_data.overload_count,
                 );
                 if client_id.is_vscode() {
                     build_vscode_completion_item(completion_item, hover_builder, Some(index));
@@ -55,19 +55,19 @@ pub fn resolve_completion(
 
 pub fn update_function_signature_info(
     hover_builder: &mut HoverBuilder,
-    function_overload_count: Option<usize>,
+    overload_count: Option<usize>,
 ) {
-    if let Some(function_overload_count) = function_overload_count {
-        if function_overload_count > 0 {
+    if let Some(overload_count) = overload_count {
+        if overload_count > 0 {
             if let Some(signature_overload) = &mut hover_builder.signature_overload {
                 for signature in signature_overload.iter_mut() {
                     if let MarkedString::LanguageString(s) = signature {
-                        s.value = format!("{} (+{} overloads)", s.value, function_overload_count);
+                        s.value = format!("{} (+{} overloads)", s.value, overload_count);
                     }
                 }
             }
             if let MarkedString::LanguageString(s) = &mut hover_builder.type_description {
-                s.value = format!("{} (+{} overloads)", s.value, function_overload_count);
+                s.value = format!("{} (+{} overloads)", s.value, overload_count);
             }
         }
     }