feature: 索引访问现在会在 hint 显示别名

Author: xuhuanzy

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

@@ -316,7 +316,7 @@ fn try_add_alias_completion_item(
     completion_item: &CompletionItem,
     label: &String,
 ) -> Option<bool> {
-    let alias_label = extract_index_member_alias(builder, member_info)?;
+    let alias_label = extract_index_member_alias(builder.semantic_model.get_db(), member_info)?;
 
     let mut alias_completion_item = completion_item.clone();
     alias_completion_item.label = alias_label;
@@ -337,10 +337,7 @@ fn try_add_alias_completion_item(
 
 /// 从注释中提取索引成员的别名, 只处理整数成员.
 /// 格式为`-- [nameX]`.
-fn extract_index_member_alias(
-    builder: &mut CompletionBuilder,
-    member_info: &LuaMemberInfo,
-) -> Option<String> {
+pub fn extract_index_member_alias(db: &DbIndex, member_info: &LuaMemberInfo) -> Option<String> {
     let LuaMemberKey::Integer(_) = member_info.key else {
         return None;
     };
@@ -350,9 +347,7 @@ fn extract_index_member_alias(
         return None;
     };
 
-    let description = builder
-        .semantic_model
-        .get_db()
+    let description = db
         .get_property_index()
         .get_property(property_owner_id)?
         .description

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

@@ -3,6 +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::{add_member_completion, CompletionTriggerStatus};
 pub use check_match_word::check_match_word;
 use emmylua_code_analysis::{LuaSemanticDeclId, LuaType, RenderLevel};

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

@@ -18,6 +18,7 @@ use providers::add_completions;
 use resolve_completion::resolve_completion;
 use rowan::TokenAtOffset;
 use tokio_util::sync::CancellationToken;
+pub use add_completions::extract_index_member_alias;
 
 use crate::context::{ClientId, ServerContextSnapshot};
 

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

@@ -15,6 +15,7 @@ use rowan::NodeOrToken;
 
 use rowan::TokenAtOffset;
 
+use crate::handlers::completion::extract_index_member_alias;
 use crate::handlers::definition::compare_function_types;
 use crate::handlers::inlay_hint::build_function_hint::{build_closure_hint, build_label_parts};
 
@@ -37,6 +38,9 @@ pub fn build_inlay_hints(semantic_model: &SemanticModel) -> Option<Vec<InlayHint
             LuaAst::LuaFuncStat(func_stat) => {
                 build_func_stat_override_hint(semantic_model, &mut result, func_stat);
             }
+            LuaAst::LuaIndexExpr(index_expr) => {
+                build_index_expr_hint(semantic_model, &mut result, index_expr);
+            }
             _ => {}
         }
     }
@@ -612,3 +616,57 @@ fn find_match_meta_call_operator_id(
     }
     operator_ids.first().cloned().map(|id| (id, call_func))
 }
+
+fn build_index_expr_hint(
+    semantic_model: &SemanticModel,
+    result: &mut Vec<InlayHint>,
+    index_expr: LuaIndexExpr,
+) -> Option<()> {
+    if !semantic_model.get_emmyrc().hint.index_hint {
+        return Some(());
+    }
+
+    // 只处理整数索引
+    let index_key = index_expr.get_index_key()?;
+
+    // 获取前缀表达式的类型信息
+    let prefix_expr = index_expr.get_prefix_expr()?;
+    let prefix_type = semantic_model.infer_expr(prefix_expr.into()).ok()?;
+    let member_key = semantic_model.get_member_key(&index_key)?;
+    let member_infos = semantic_model.get_member_infos(&prefix_type)?;
+    let member_info = member_infos.iter().find(|m| m.key == member_key)?;
+    // 尝试提取别名
+    let alias = extract_index_member_alias(semantic_model.get_db(), member_info)?;
+    // 创建 hint
+    let document = semantic_model.get_document();
+    let position = {
+        let index_token = index_expr.get_index_name_token()?;
+        let range = index_token.text_range();
+        let lsp_range = document.to_lsp_range(range)?;
+        lsp_range.end
+    };
+
+    let label_location = {
+        let range = index_expr.get_index_key()?.get_range()?;
+        let lsp_range = document.to_lsp_range(range)?;
+        Location::new(document.get_uri(), lsp_range)
+    };
+
+    let hint = InlayHint {
+        kind: Some(InlayHintKind::TYPE),
+        label: InlayHintLabel::LabelParts(vec![InlayHintLabelPart {
+            value: format!(">{}", alias),
+            location: Some(label_location),
+            ..Default::default()
+        }]),
+        position,
+        text_edits: None,
+        tooltip: None,
+        padding_left: Some(true),
+        padding_right: None,
+        data: None,
+    };
+
+    result.push(hint);
+    Some(())
+}

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

@@ -119,7 +119,7 @@ fn rename_references(
     new_name: String,
 ) -> Option<WorkspaceEdit> {
     let mut result = HashMap::new();
-    let semantic_decl = match try_get_table_field(token.clone()) {
+    let semantic_decl = match get_literal_expr_parent(token.clone()) {
         Some(node) => semantic_model.find_decl(node.into(), SemanticDeclLevel::NoTrace),
         None => semantic_model.find_decl(token.into(), SemanticDeclLevel::NoTrace),
     }?;
@@ -168,7 +168,7 @@ fn rename_references(
     })
 }
 
-fn try_get_table_field(token: LuaSyntaxToken) -> Option<LuaSyntaxNode> {
+fn get_literal_expr_parent(token: LuaSyntaxToken) -> Option<LuaSyntaxNode> {
     let parent = token.parent()?;
     let literal_expr = LuaLiteralExpr::cast(parent)?;
     literal_expr.syntax().parent()

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

@@ -159,4 +159,20 @@ mod tests {
             Range::new(Position::new(4, 27), Position::new(4, 33))
         );
     }
+
+    #[test]
+    fn test_index_key_alias_hint() {
+        let mut ws = ProviderVirtualWorkspace::new();
+        let result = ws
+            .check_inlay_hint(
+                r#"
+                local export = {
+                    [1] = 1, -- [nameX]
+                }
+                print(export[1])
+            "#,
+            )
+            .unwrap();
+        assert!(result.len() == 1);
+    }
 }