From 4b31005bebff74518d053b480acc7bf911b2da7b Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Fri, 27 Jun 2025 16:50:24 +0800 Subject: [PATCH 01/54] feature: add tag `---@export` --- .../compilation/analyzer/doc/property_tags.rs | 31 ++++++- .../src/compilation/analyzer/doc/tags.rs | 7 +- .../src/db_index/property/mod.rs | 19 ++++- .../src/db_index/property/property.rs | 13 +++ crates/emmylua_ls/locales/tags/en.yaml | 14 ++++ crates/emmylua_ls/locales/tags/zh_CN.yaml | 14 ++++ crates/emmylua_ls/locales/tags/zh_HK.yaml | 12 +++ .../src/handlers/completion/data/doc_tags.rs | 1 + .../providers/auto_require_provider.rs | 38 ++++++--- .../src/handlers/test/completion_test.rs | 62 ++++++++------ crates/emmylua_parser/src/grammar/doc/tag.rs | 14 ++++ crates/emmylua_parser/src/grammar/doc/test.rs | 82 +++++++++++++++++++ .../src/kind/lua_syntax_kind.rs | 1 + .../emmylua_parser/src/kind/lua_token_kind.rs | 1 + .../emmylua_parser/src/lexer/lua_doc_lexer.rs | 1 + .../emmylua_parser/src/syntax/node/doc/tag.rs | 48 +++++++++++ crates/emmylua_parser/src/syntax/node/mod.rs | 6 ++ 17 files changed, 324 insertions(+), 40 deletions(-) diff --git a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs index 5cb9c3b0d..96f4de6ae 100644 --- a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs +++ b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs @@ -1,12 +1,12 @@ -use crate::{LuaNoDiscard, LuaSignatureId}; +use crate::{LuaExport, LuaExportScope, LuaNoDiscard, LuaSignatureId}; use super::{ tags::{find_owner_closure, get_owner_id}, DocAnalyzer, }; use emmylua_parser::{ - LuaDocDescriptionOwner, LuaDocTagDeprecated, LuaDocTagNodiscard, LuaDocTagSource, - LuaDocTagVersion, LuaDocTagVisibility, + LuaDocDescriptionOwner, LuaDocTagDeprecated, LuaDocTagExport, LuaDocTagNodiscard, + LuaDocTagSource, LuaDocTagVersion, LuaDocTagVisibility, }; pub fn analyze_visibility( @@ -110,3 +110,28 @@ pub fn analyze_async(analyzer: &mut DocAnalyzer) -> Option<()> { Some(()) } + +pub fn analyze_export(analyzer: &mut DocAnalyzer, tag: LuaDocTagExport) -> Option<()> { + let owner_id = get_owner_id(analyzer)?; + + let export_scope = if let Some(scope_text) = tag.get_export_scope() { + match scope_text.as_str() { + "namespace" => LuaExportScope::Namespace, + "global" => LuaExportScope::Global, + _ => LuaExportScope::Global, // 默认为 global + } + } else { + LuaExportScope::Global // 没有参数时默认为 global + }; + + let export = LuaExport { + scope: export_scope, + }; + + analyzer + .db + .get_property_index_mut() + .add_export(analyzer.file_id, owner_id, export); + + Some(()) +} diff --git a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/tags.rs b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/tags.rs index 7ef1948c2..eb804c489 100644 --- a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/tags.rs +++ b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/tags.rs @@ -11,8 +11,8 @@ use super::{ diagnostic_tags::analyze_diagnostic, field_or_operator_def_tags::{analyze_field, analyze_operator}, property_tags::{ - analyze_async, analyze_deprecated, analyze_nodiscard, analyze_source, analyze_version, - analyze_visibility, + analyze_async, analyze_deprecated, analyze_export, analyze_nodiscard, analyze_source, + analyze_version, analyze_visibility, }, type_def_tags::{analyze_alias, analyze_class, analyze_enum, analyze_func_generic}, type_ref_tags::{ @@ -104,6 +104,9 @@ pub fn analyze_tag(analyzer: &mut DocAnalyzer, tag: LuaDocTag) -> Option<()> { LuaDocTag::Other(other) => { analyze_other(analyzer, other)?; } + LuaDocTag::Export(export) => { + analyze_export(analyzer, export)?; + } _ => {} } diff --git a/crates/emmylua_code_analysis/src/db_index/property/mod.rs b/crates/emmylua_code_analysis/src/db_index/property/mod.rs index 49f46ce2d..4e91767f3 100644 --- a/crates/emmylua_code_analysis/src/db_index/property/mod.rs +++ b/crates/emmylua_code_analysis/src/db_index/property/mod.rs @@ -4,7 +4,7 @@ use std::collections::{HashMap, HashSet}; use emmylua_parser::{LuaVersionCondition, VisibilityKind}; use property::LuaCommonProperty; -pub use property::{LuaDeprecated, LuaPropertyId}; +pub use property::{LuaDeprecated, LuaExport, LuaExportScope, LuaPropertyId}; use crate::FileId; @@ -195,6 +195,23 @@ impl LuaPropertyIndex { Some(()) } + pub fn add_export( + &mut self, + file_id: FileId, + owner_id: LuaSemanticDeclId, + export: property::LuaExport, + ) -> Option<()> { + let property = self.get_or_create_property(owner_id.clone())?; + property.export = Some(Box::new(export)); + + self.in_filed_owner + .entry(file_id) + .or_insert_with(HashSet::new) + .insert(owner_id); + + Some(()) + } + pub fn get_property(&self, owner_id: &LuaSemanticDeclId) -> Option<&LuaCommonProperty> { self.property_owners_map .get(&owner_id) diff --git a/crates/emmylua_code_analysis/src/db_index/property/property.rs b/crates/emmylua_code_analysis/src/db_index/property/property.rs index 2076638a6..83b167405 100644 --- a/crates/emmylua_code_analysis/src/db_index/property/property.rs +++ b/crates/emmylua_code_analysis/src/db_index/property/property.rs @@ -10,6 +10,7 @@ pub struct LuaCommonProperty { pub version_conds: Option>>, pub see_content: Option>, pub other_content: Option>, + pub export: Option>, } #[derive(Debug, Clone, PartialEq, Eq)] @@ -18,6 +19,17 @@ pub enum LuaDeprecated { DeprecatedWithMessage(Box), } +#[derive(Debug, Clone, PartialEq, Eq)] +pub enum LuaExportScope { + Global, + Namespace, +} + +#[derive(Debug, Clone, PartialEq, Eq)] +pub struct LuaExport { + pub scope: LuaExportScope, +} + impl LuaCommonProperty { pub fn new(id: LuaPropertyId) -> Self { Self { @@ -29,6 +41,7 @@ impl LuaCommonProperty { version_conds: None, see_content: None, other_content: None, + export: None, } } } diff --git a/crates/emmylua_ls/locales/tags/en.yaml b/crates/emmylua_ls/locales/tags/en.yaml index a94c76a8c..ebddccde2 100644 --- a/crates/emmylua_ls/locales/tags/en.yaml +++ b/crates/emmylua_ls/locales/tags/en.yaml @@ -218,3 +218,17 @@ tags.readonly: | ---@readonly MyClass.readonlyField = "constant" ``` +tags.export: | + The `export` tag is used to indicate that a variable is exported, supporting quick import. + It accepts `namespace` or `global` as parameters. If no parameter is provided, it defaults to `global`. + Example: + ```lua + ---@export namespace -- When set to `namespace`, only allows import within the same namespace + local export = {} + + export.func = function() + -- When typing `func` in other files, import suggestions will be shown + end + + return export + ``` diff --git a/crates/emmylua_ls/locales/tags/zh_CN.yaml b/crates/emmylua_ls/locales/tags/zh_CN.yaml index 38805e109..28f86874d 100644 --- a/crates/emmylua_ls/locales/tags/zh_CN.yaml +++ b/crates/emmylua_ls/locales/tags/zh_CN.yaml @@ -218,3 +218,17 @@ tags.readonly: | ---@readonly MyClass.readonlyField = "constant" ``` +tags.export: | + `export` 标签用于表示一个变量为导出的，用于支持快速导入。 + 接收的参数为 `namespace` 或 `global`，不输入参数默认为 `global`。 + 示例: + ```lua + ---@export namespace -- 当为`namespace`时仅允许同命名空间引入 + local export = {} + + export.func = function() + -- 在其他文件输入`func`时会提示导入 + end + + return export + ``` \ No newline at end of file diff --git a/crates/emmylua_ls/locales/tags/zh_HK.yaml b/crates/emmylua_ls/locales/tags/zh_HK.yaml index 033134ce0..3fe165c54 100644 --- a/crates/emmylua_ls/locales/tags/zh_HK.yaml +++ b/crates/emmylua_ls/locales/tags/zh_HK.yaml @@ -218,3 +218,15 @@ tags.readonly: | ---@readonly MyClass.readonlyField = "constant" ``` +tags.export: | + `export` 標籤用於表示一個變量為導出的，用於支持快速導入。 + 接收的參數為 `namespace` 或 `global`，不輸入參數默認為 `global`。 + 示例: + ```lua + ---@export namespace -- 當為`namespace`時僅允許同命名空間引入 + local export = {} + + export.func = function() + -- 在其他文件輸入`func`時會提示導入 + end + ``` \ No newline at end of file diff --git a/crates/emmylua_ls/src/handlers/completion/data/doc_tags.rs b/crates/emmylua_ls/src/handlers/completion/data/doc_tags.rs index 4e084d505..6b7e7cffd 100644 --- a/crates/emmylua_ls/src/handlers/completion/data/doc_tags.rs +++ b/crates/emmylua_ls/src/handlers/completion/data/doc_tags.rs @@ -30,4 +30,5 @@ pub const DOC_TAGS: &[&str] = &[ "source", "readonly", "return_cast", + "export", ]; diff --git a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs index 1f4e741c0..19e22b2db 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs @@ -1,4 +1,4 @@ -use emmylua_code_analysis::{EmmyrcFilenameConvention, LuaType, ModuleInfo}; +use emmylua_code_analysis::{EmmyrcFilenameConvention, LuaExportScope, LuaType, ModuleInfo}; use emmylua_parser::{LuaAstNode, LuaNameExpr}; use lsp_types::{CompletionItem, Position}; @@ -70,14 +70,14 @@ fn add_module_completion_item( ) -> Option<()> { let completion_name = module_name_convert(module_info, file_conversion); if !completion_name.to_lowercase().starts_with(prefix) { - // try_add_member_completion_items( - // builder, - // prefix, - // module_info, - // file_conversion, - // position, - // completions, - // ); + try_add_member_completion_items( + builder, + prefix, + module_info, + file_conversion, + position, + completions, + ); return None; } @@ -122,6 +122,24 @@ fn try_add_member_completion_items( position: Position, completions: &mut Vec, ) -> Option<()> { + let property_owner_id = module_info.property_owner_id.clone()?; + let property = builder + .semantic_model + .get_db() + .get_property_index() + .get_property(&property_owner_id)? + .export + .as_ref()?; + if property.scope == LuaExportScope::Namespace { + let file_id = builder.semantic_model.get_file_id(); + let type_index = builder.semantic_model.get_db().get_type_index(); + if type_index.get_file_namespace(&file_id) + != type_index.get_file_namespace(&module_info.file_id) + { + return None; + } + } + if let Some(export_type) = &module_info.export_type { match export_type { LuaType::TableConst(_) | LuaType::Def(_) => { @@ -133,7 +151,7 @@ fn try_add_member_completion_items( file_conversion, ); match member_info.typ { - LuaType::Ref(_) | LuaType::Def(_) => {} + LuaType::Def(_) => {} LuaType::Signature(_) => {} _ => { continue; diff --git a/crates/emmylua_ls/src/handlers/test/completion_test.rs b/crates/emmylua_ls/src/handlers/test/completion_test.rs index 36115f01e..dc477daa3 100644 --- a/crates/emmylua_ls/src/handlers/test/completion_test.rs +++ b/crates/emmylua_ls/src/handlers/test/completion_test.rs @@ -918,16 +918,17 @@ mod tests { )); } - // #[test] - // fn test_auto_require_table_field() { - // let mut ws = ProviderVirtualWorkspace::new(); - // let mut emmyrc = ws.analysis.emmyrc.deref().clone(); - // emmyrc.completion.auto_require_naming_convention = EmmyrcFilenameConvention::KeepClass; - // ws.analysis.update_config(Arc::new(emmyrc)); - // ws.def_file( - // "aaaa.lua", - // r#" - // local export = {} + #[test] + fn test_auto_require_table_field() { + let mut ws = ProviderVirtualWorkspace::new(); + let mut emmyrc = ws.analysis.emmyrc.deref().clone(); + emmyrc.completion.auto_require_naming_convention = EmmyrcFilenameConvention::KeepClass; + ws.analysis.update_config(Arc::new(emmyrc)); + ws.def_file( + "aaaa.lua", + r#" + ---@export + local export = {} // ---@enum MapName // export.MapName = { @@ -935,20 +936,33 @@ mod tests { // B = 2, // } - // return export - // "#, - // ); - // assert!(ws.check_completion( - // r#" - // mapn - // "#, - // vec![VirtualCompletionItem { - // label: "MapName".to_string(), - // kind: CompletionItemKind::MODULE, - // label_detail: Some(" (in aaaa)".to_string()), - // },], - // )); - // } + return export + "#, + ); + ws.def_file( + "bbbb.lua", + r#" + local export = {} + + ---@enum PA + export.PA = { + A = 1, + } + + return export + "#, + ); + assert!(ws.check_completion( + r#" + mapn + "#, + vec![VirtualCompletionItem { + label: "MapName".to_string(), + kind: CompletionItemKind::MODULE, + label_detail: Some(" (in aaaa)".to_string()), + },], + )); + } #[test] fn test_field_is_alias_function() { diff --git a/crates/emmylua_parser/src/grammar/doc/tag.rs b/crates/emmylua_parser/src/grammar/doc/tag.rs index 736d39aee..0af5b686d 100644 --- a/crates/emmylua_parser/src/grammar/doc/tag.rs +++ b/crates/emmylua_parser/src/grammar/doc/tag.rs @@ -55,6 +55,7 @@ fn parse_tag_detail(p: &mut LuaDocParser) -> ParseResult { LuaTokenKind::TkTagNamespace => parse_tag_namespace(p), LuaTokenKind::TkTagUsing => parse_tag_using(p), LuaTokenKind::TkTagMeta => parse_tag_meta(p), + LuaTokenKind::TkTagExport => parse_tag_export(p), // simple tag LuaTokenKind::TkTagVisibility => parse_tag_simple(p, LuaSyntaxKind::DocTagVisibility), @@ -614,3 +615,16 @@ fn parse_tag_meta(p: &mut LuaDocParser) -> ParseResult { if_token_bump(p, LuaTokenKind::TkName); Ok(m.complete(p)) } + +fn parse_tag_export(p: &mut LuaDocParser) -> ParseResult { + p.set_state(LuaDocLexerState::Normal); + let m = p.mark(LuaSyntaxKind::DocTagExport); + p.bump(); + // @export 可以有可选的参数，如 @export namespace 或 @export global + if p.current_token() == LuaTokenKind::TkName { + p.bump(); + } + p.set_state(LuaDocLexerState::Description); + parse_description(p); + Ok(m.complete(p)) +} diff --git a/crates/emmylua_parser/src/grammar/doc/test.rs b/crates/emmylua_parser/src/grammar/doc/test.rs index 1d0eddfa6..7712392f6 100644 --- a/crates/emmylua_parser/src/grammar/doc/test.rs +++ b/crates/emmylua_parser/src/grammar/doc/test.rs @@ -2793,4 +2793,86 @@ Syntax(Chunk)@0..263 assert_ast_eq!(code, result); } + + #[test] + fn test_export_doc() { + let code = r#" + ---@export + local a = 1 + + ---@export namespace + local b = 2 + + ---@export global + local c = 3 +"#; + + let result = r#" +Syntax(Chunk)@0..137 + Syntax(Block)@0..137 + Token(TkEndOfLine)@0..1 "\n" + Token(TkWhitespace)@1..9 " " + Syntax(Comment)@9..19 + Token(TkDocStart)@9..13 "---@" + Syntax(DocTagExport)@13..19 + Token(TkTagExport)@13..19 "export" + Token(TkEndOfLine)@19..20 "\n" + Token(TkWhitespace)@20..28 " " + Syntax(LocalStat)@28..39 + Token(TkLocal)@28..33 "local" + Token(TkWhitespace)@33..34 " " + Syntax(LocalName)@34..35 + Token(TkName)@34..35 "a" + Token(TkWhitespace)@35..36 " " + Token(TkAssign)@36..37 "=" + Token(TkWhitespace)@37..38 " " + Syntax(LiteralExpr)@38..39 + Token(TkInt)@38..39 "1" + Token(TkEndOfLine)@39..40 "\n" + Token(TkEndOfLine)@40..41 "\n" + Token(TkWhitespace)@41..49 " " + Syntax(Comment)@49..69 + Token(TkDocStart)@49..53 "---@" + Syntax(DocTagExport)@53..69 + Token(TkTagExport)@53..59 "export" + Token(TkWhitespace)@59..60 " " + Token(TkName)@60..69 "namespace" + Token(TkEndOfLine)@69..70 "\n" + Token(TkWhitespace)@70..78 " " + Syntax(LocalStat)@78..89 + Token(TkLocal)@78..83 "local" + Token(TkWhitespace)@83..84 " " + Syntax(LocalName)@84..85 + Token(TkName)@84..85 "b" + Token(TkWhitespace)@85..86 " " + Token(TkAssign)@86..87 "=" + Token(TkWhitespace)@87..88 " " + Syntax(LiteralExpr)@88..89 + Token(TkInt)@88..89 "2" + Token(TkEndOfLine)@89..90 "\n" + Token(TkEndOfLine)@90..91 "\n" + Token(TkWhitespace)@91..99 " " + Syntax(Comment)@99..116 + Token(TkDocStart)@99..103 "---@" + Syntax(DocTagExport)@103..116 + Token(TkTagExport)@103..109 "export" + Token(TkWhitespace)@109..110 " " + Token(TkName)@110..116 "global" + Token(TkEndOfLine)@116..117 "\n" + Token(TkWhitespace)@117..125 " " + Syntax(LocalStat)@125..136 + Token(TkLocal)@125..130 "local" + Token(TkWhitespace)@130..131 " " + Syntax(LocalName)@131..132 + Token(TkName)@131..132 "c" + Token(TkWhitespace)@132..133 " " + Token(TkAssign)@133..134 "=" + Token(TkWhitespace)@134..135 " " + Syntax(LiteralExpr)@135..136 + Token(TkInt)@135..136 "3" + Token(TkEndOfLine)@136..137 "\n" + "#; + + assert_ast_eq!(code, result); + } } diff --git a/crates/emmylua_parser/src/kind/lua_syntax_kind.rs b/crates/emmylua_parser/src/kind/lua_syntax_kind.rs index baa5a3f84..a3974838a 100644 --- a/crates/emmylua_parser/src/kind/lua_syntax_kind.rs +++ b/crates/emmylua_parser/src/kind/lua_syntax_kind.rs @@ -90,6 +90,7 @@ pub enum LuaSyntaxKind { DocTagSource, DocTagReadonly, DocTagReturnCast, + DocTagExport, // doc Type TypeArray, // baseType [] diff --git a/crates/emmylua_parser/src/kind/lua_token_kind.rs b/crates/emmylua_parser/src/kind/lua_token_kind.rs index 09693cde4..2a327d921 100644 --- a/crates/emmylua_parser/src/kind/lua_token_kind.rs +++ b/crates/emmylua_parser/src/kind/lua_token_kind.rs @@ -118,6 +118,7 @@ pub enum LuaTokenKind { TkTagUsing, // using TkTagSource, // source TkTagReturnCast, // return cast + TkTagExport, // export TkDocOr, // | TkDocAnd, // & diff --git a/crates/emmylua_parser/src/lexer/lua_doc_lexer.rs b/crates/emmylua_parser/src/lexer/lua_doc_lexer.rs index 43263a91c..aa3b09a5d 100644 --- a/crates/emmylua_parser/src/lexer/lua_doc_lexer.rs +++ b/crates/emmylua_parser/src/lexer/lua_doc_lexer.rs @@ -596,6 +596,7 @@ fn to_tag(text: &str) -> LuaTokenKind { "namespace" => LuaTokenKind::TkTagNamespace, "using" => LuaTokenKind::TkTagUsing, "source" => LuaTokenKind::TkTagSource, + "export" => LuaTokenKind::TkTagExport, _ => LuaTokenKind::TkTagOther, } } diff --git a/crates/emmylua_parser/src/syntax/node/doc/tag.rs b/crates/emmylua_parser/src/syntax/node/doc/tag.rs index e36475748..5f2d966a8 100644 --- a/crates/emmylua_parser/src/syntax/node/doc/tag.rs +++ b/crates/emmylua_parser/src/syntax/node/doc/tag.rs @@ -41,6 +41,7 @@ pub enum LuaDocTag { As(LuaDocTagAs), Visibility(LuaDocTagVisibility), ReturnCast(LuaDocTagReturnCast), + Export(LuaDocTagExport), } impl LuaAstNode for LuaDocTag { @@ -73,6 +74,7 @@ impl LuaAstNode for LuaDocTag { LuaDocTag::As(it) => it.syntax(), LuaDocTag::Visibility(it) => it.syntax(), LuaDocTag::ReturnCast(it) => it.syntax(), + LuaDocTag::Export(it) => it.syntax(), } } @@ -107,6 +109,7 @@ impl LuaAstNode for LuaDocTag { || kind == LuaSyntaxKind::DocTagAs || kind == LuaSyntaxKind::DocTagVisibility || kind == LuaSyntaxKind::DocTagReturnCast + || kind == LuaSyntaxKind::DocTagExport } fn cast(syntax: LuaSyntaxNode) -> Option @@ -191,6 +194,9 @@ impl LuaAstNode for LuaDocTag { LuaSyntaxKind::DocTagReturnCast => Some(LuaDocTag::ReturnCast( LuaDocTagReturnCast::cast(syntax).unwrap(), )), + LuaSyntaxKind::DocTagExport => { + Some(LuaDocTag::Export(LuaDocTagExport::cast(syntax).unwrap())) + } _ => None, } } @@ -1454,3 +1460,45 @@ impl LuaDocTagReturnCast { self.token() } } + +#[derive(Debug, Clone, PartialEq, Eq, Hash)] +pub struct LuaDocTagExport { + syntax: LuaSyntaxNode, +} + +impl LuaAstNode for LuaDocTagExport { + fn syntax(&self) -> &LuaSyntaxNode { + &self.syntax + } + + fn can_cast(kind: LuaSyntaxKind) -> bool + where + Self: Sized, + { + kind == LuaSyntaxKind::DocTagExport + } + + fn cast(syntax: LuaSyntaxNode) -> Option + where + Self: Sized, + { + if Self::can_cast(syntax.kind().into()) { + Some(Self { syntax }) + } else { + None + } + } +} + +impl LuaDocDescriptionOwner for LuaDocTagExport {} + +impl LuaDocTagExport { + pub fn get_name_token(&self) -> Option { + self.token() + } + + pub fn get_export_scope(&self) -> Option { + self.get_name_token() + .map(|token| token.get_name_text().to_string()) + } +} diff --git a/crates/emmylua_parser/src/syntax/node/mod.rs b/crates/emmylua_parser/src/syntax/node/mod.rs index 4d716ecf4..274bba66e 100644 --- a/crates/emmylua_parser/src/syntax/node/mod.rs +++ b/crates/emmylua_parser/src/syntax/node/mod.rs @@ -86,6 +86,7 @@ pub enum LuaAst { LuaDocTagAsync(LuaDocTagAsync), LuaDocTagAs(LuaDocTagAs), LuaDocTagReturnCast(LuaDocTagReturnCast), + LuaDocTagExport(LuaDocTagExport), // doc type LuaDocNameType(LuaDocNameType), @@ -169,6 +170,7 @@ impl LuaAstNode for LuaAst { LuaAst::LuaDocTagAsync(node) => node.syntax(), LuaAst::LuaDocTagAs(node) => node.syntax(), LuaAst::LuaDocTagReturnCast(node) => node.syntax(), + LuaAst::LuaDocTagExport(node) => node.syntax(), LuaAst::LuaDocNameType(node) => node.syntax(), LuaAst::LuaDocArrayType(node) => node.syntax(), LuaAst::LuaDocFuncType(node) => node.syntax(), @@ -259,6 +261,7 @@ impl LuaAstNode for LuaAst { LuaSyntaxKind::DocTagAsync => true, LuaSyntaxKind::DocTagAs => true, LuaSyntaxKind::DocTagReturnCast => true, + LuaSyntaxKind::DocTagExport => true, LuaSyntaxKind::TypeName => true, LuaSyntaxKind::TypeArray => true, LuaSyntaxKind::TypeFun => true, @@ -394,6 +397,9 @@ impl LuaAstNode for LuaAst { LuaSyntaxKind::DocTagReturnCast => { LuaDocTagReturnCast::cast(syntax).map(LuaAst::LuaDocTagReturnCast) } + LuaSyntaxKind::DocTagExport => { + LuaDocTagExport::cast(syntax).map(LuaAst::LuaDocTagExport) + } LuaSyntaxKind::TypeName => LuaDocNameType::cast(syntax).map(LuaAst::LuaDocNameType), LuaSyntaxKind::TypeArray => LuaDocArrayType::cast(syntax).map(LuaAst::LuaDocArrayType), LuaSyntaxKind::TypeFun => LuaDocFuncType::cast(syntax).map(LuaAst::LuaDocFuncType), From f7511bbd41a8ba6ba760cf1411d174dd37bb0503 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Fri, 27 Jun 2025 17:58:21 +0800 Subject: [PATCH 02/54] add `---@export` diagnostic & semantic_token --- .../src/diagnostic/checker/check_field.rs | 70 ++++++++++++++++-- .../diagnostic/test/undefined_field_test.rs | 21 ++++++ .../src/semantic/decl/mod.rs | 48 ++++++++++++- .../emmylua_code_analysis/src/semantic/mod.rs | 2 +- .../semantic_token/build_semantic_tokens.rs | 72 +++++++++---------- .../src/handlers/test/completion_test.rs | 10 +-- 6 files changed, 172 insertions(+), 51 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs index 52d220db8..69b2fe690 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs @@ -6,7 +6,8 @@ use emmylua_parser::{ }; use crate::{ - enum_variable_is_param, DiagnosticCode, InferFailReason, LuaMemberKey, LuaType, SemanticModel, + enum_variable_is_param, parse_require_module_info, DiagnosticCode, InferFailReason, + LuaExportScope, LuaMemberKey, LuaSemanticDeclId, LuaType, SemanticModel, }; use super::{humanize_lint_type, Checker, DiagnosticContext}; @@ -63,8 +64,18 @@ fn check_index_expr( .infer_expr(index_expr.get_prefix_expr()?) .unwrap_or(LuaType::Unknown); - if !is_valid_prefix_type(&prefix_typ) { - return Some(()); + if is_invalid_prefix_type(&prefix_typ) { + // 检查是否为 require 导入且具有 export 标记的变量 + if matches!(code, DiagnosticCode::UndefinedField) + && matches!(prefix_typ, LuaType::TableConst(_)) + { + // 如果是 require 导入且具有 export 标记的变量, 那么不应该跳过检查 + if check_is_require_with_export(semantic_model, &prefix_typ, index_expr).is_none() { + return Some(()); + } + } else { + return Some(()); + } } let index_key = index_expr.get_index_key()?; @@ -102,7 +113,7 @@ fn check_index_expr( Some(()) } -fn is_valid_prefix_type(typ: &LuaType) -> bool { +fn is_invalid_prefix_type(typ: &LuaType) -> bool { let mut current_typ = typ; loop { match current_typ { @@ -111,11 +122,11 @@ fn is_valid_prefix_type(typ: &LuaType) -> bool { | LuaType::Table | LuaType::TplRef(_) | LuaType::StrTplRef(_) - | LuaType::TableConst(_) => return false, + | LuaType::TableConst(_) => return true, LuaType::Instance(instance_typ) => { current_typ = instance_typ.get_base(); } - _ => return true, + _ => return false, } } } @@ -439,3 +450,50 @@ fn check_enum_is_param( prefix_typ, ) } + +/// 检查变量是否为 require 导入且具有 export 标记 +fn check_is_require_with_export( + semantic_model: &SemanticModel, + _prefix_typ: &LuaType, + index_expr: &LuaIndexExpr, +) -> Option<()> { + // 获取前缀表达式的语义信息 + let prefix_expr = index_expr.get_prefix_expr()?; + let semantic_info = semantic_model.get_semantic_info(prefix_expr.syntax().clone().into())?; + + // 检查是否是声明引用 + let decl_id = match semantic_info.semantic_decl? { + LuaSemanticDeclId::LuaDecl(decl_id) => decl_id, + _ => return None, + }; + + // 获取声明 + let decl = semantic_model + .get_db() + .get_decl_index() + .get_decl(&decl_id)?; + + // 检查是否是 require 导入的模块 + let module_info = parse_require_module_info(semantic_model, &decl)?; + + // 检查模块是否有 export 标记 + let property_owner_id = module_info.property_owner_id.clone()?; + let property = semantic_model + .get_db() + .get_property_index() + .get_property(&property_owner_id)? + .export + .as_ref()?; + + // 如果是 namespace 类型的 export，需要检查是否在同一个命名空间 + if property.scope == LuaExportScope::Namespace { + let type_index = semantic_model.get_db().get_type_index(); + if type_index.get_file_namespace(&semantic_model.get_file_id()) + != type_index.get_file_namespace(&module_info.file_id) + { + return None; + } + } + + Some(()) +} diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs index 31afce6b8..e9155cd4a 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs @@ -735,4 +735,25 @@ mod test { "# )); } + + #[test] + fn test_export() { + let mut ws = VirtualWorkspace::new(); + ws.def_file( + "a.lua", + r#" + ---@export + local export = {} + + return export + "#, + ); + assert!(!ws.check_code_for( + DiagnosticCode::UndefinedField, + r#" + local a = require("a") + a.func() + "#, + )); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/decl/mod.rs b/crates/emmylua_code_analysis/src/semantic/decl/mod.rs index dfa065087..2a2d96d0c 100644 --- a/crates/emmylua_code_analysis/src/semantic/decl/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/decl/mod.rs @@ -1,11 +1,12 @@ use std::collections::HashSet; -use emmylua_parser::{LuaAstNode, LuaIndexExpr}; +use emmylua_parser::{LuaAstNode, LuaCallExpr, LuaIndexExpr, LuaSyntaxKind}; use rowan::NodeOrToken; use crate::{ - infer_node_semantic_decl, semantic::semantic_info::infer_token_semantic_decl, DbIndex, - LuaDeclId, LuaInferCache, LuaSemanticDeclId, LuaType, SemanticDeclLevel, + infer_node_semantic_decl, semantic::semantic_info::infer_token_semantic_decl, DbIndex, LuaDecl, + LuaDeclId, LuaInferCache, LuaSemanticDeclId, LuaType, ModuleInfo, SemanticDeclLevel, + SemanticModel, }; pub fn enum_variable_is_param( @@ -106,3 +107,44 @@ fn find_enum_origin( _ => None, } } + +/// 解析 require 调用表达式并获取模块信息 +pub fn parse_require_module_info<'a>( + semantic_model: &'a SemanticModel, + decl: &LuaDecl, +) -> Option<&'a ModuleInfo> { + let value_syntax_id = decl.get_value_syntax_id()?; + if value_syntax_id.get_kind() != LuaSyntaxKind::RequireCallExpr { + return None; + } + + let node = semantic_model + .get_db() + .get_vfs() + .get_syntax_tree(&decl.get_file_id()) + .and_then(|tree| { + let root = tree.get_red_root(); + semantic_model + .get_db() + .get_decl_index() + .get_decl(&decl.get_id()) + .and_then(|decl| decl.get_value_syntax_id()) + .and_then(|syntax_id| syntax_id.to_node_from_root(&root)) + })?; + + let call_expr = LuaCallExpr::cast(node)?; + let arg_list = call_expr.get_args_list()?; + let first_arg = arg_list.get_args().next()?; + let require_path_type = semantic_model.infer_expr(first_arg.clone()).ok()?; + let module_path: String = match &require_path_type { + LuaType::StringConst(module_path) => module_path.as_ref().to_string(), + _ => { + return None; + } + }; + + semantic_model + .get_db() + .get_module_index() + .find_module(&module_path) +} diff --git a/crates/emmylua_code_analysis/src/semantic/mod.rs b/crates/emmylua_code_analysis/src/semantic/mod.rs index 49101b655..c2182e086 100644 --- a/crates/emmylua_code_analysis/src/semantic/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/mod.rs @@ -14,7 +14,7 @@ use std::collections::HashMap; use std::{collections::HashSet, sync::Arc}; pub use cache::{CacheEntry, CacheKey, CacheOptions, LuaAnalysisPhase, LuaInferCache}; -pub use decl::enum_variable_is_param; +pub use decl::{enum_variable_is_param, parse_require_module_info}; use emmylua_parser::{ LuaCallExpr, LuaChunk, LuaExpr, LuaIndexKey, LuaParseError, LuaSyntaxNode, LuaSyntaxToken, LuaTableExpr, diff --git a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs index bce810206..7c418c4e6 100644 --- a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs +++ b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs @@ -1,11 +1,11 @@ use emmylua_code_analysis::{ - LuaDecl, LuaDeclExtra, LuaMemberId, LuaMemberOwner, LuaSemanticDeclId, LuaType, LuaTypeDeclId, - SemanticDeclLevel, SemanticModel, + parse_require_module_info, LuaDecl, LuaDeclExtra, LuaExportScope, LuaMemberId, LuaMemberOwner, + LuaSemanticDeclId, LuaType, LuaTypeDeclId, SemanticDeclLevel, SemanticModel, }; use emmylua_parser::{ - LuaAst, LuaAstNode, LuaAstToken, LuaCallExpr, LuaDocFieldKey, LuaDocObjectFieldKey, LuaExpr, - LuaGeneralToken, LuaKind, LuaLiteralToken, LuaNameToken, LuaSyntaxKind, LuaSyntaxNode, - LuaSyntaxToken, LuaTokenKind, LuaVarExpr, + LuaAst, LuaAstNode, LuaAstToken, LuaDocFieldKey, LuaDocObjectFieldKey, LuaExpr, + LuaGeneralToken, LuaKind, LuaLiteralToken, LuaNameToken, LuaSyntaxNode, LuaSyntaxToken, + LuaTokenKind, LuaVarExpr, }; use lsp_types::{SemanticToken, SemanticTokenModifier, SemanticTokenType}; use rowan::NodeOrToken; @@ -579,6 +579,14 @@ fn handle_name_node( .get_decl_index() .get_decl(&decl_id)?; let decl_type = semantic_model.get_type(decl_id.into()); + if let Some(true) = check_import_decl(semantic_model, &decl) { + builder.push_with_modifier( + name_token.syntax(), + SemanticTokenType::CLASS, + SemanticTokenModifier::READONLY, + ); + return Some(()); + } let (token_type, modifier) = match decl_type { LuaType::Def(_) => (SemanticTokenType::CLASS, None), @@ -683,37 +691,7 @@ fn check_ref_is_require_def( decl: &LuaDecl, ref_id: &LuaTypeDeclId, ) -> Option { - let value_syntax_id = decl.get_value_syntax_id()?; - if value_syntax_id.get_kind() != LuaSyntaxKind::RequireCallExpr { - return None; - } - let node = semantic_model - .get_db() - .get_vfs() - .get_syntax_tree(&decl.get_file_id()) - .and_then(|tree| { - let root = tree.get_red_root(); - semantic_model - .get_db() - .get_decl_index() - .get_decl(&decl.get_id()) - .and_then(|decl| decl.get_value_syntax_id()) - .and_then(|syntax_id| syntax_id.to_node_from_root(&root)) - })?; - let call_expr = LuaCallExpr::cast(node)?; - let arg_list = call_expr.get_args_list()?; - let first_arg = arg_list.get_args().next()?; - let require_path_type = semantic_model.infer_expr(first_arg.clone()).ok()?; - let module_path: String = match &require_path_type { - LuaType::StringConst(module_path) => module_path.as_ref().to_string(), - _ => { - return None; - } - }; - let module_info = semantic_model - .get_db() - .get_module_index() - .find_module(&module_path)?; + let module_info = parse_require_module_info(semantic_model, decl)?; match &module_info.export_type { Some(ty) => match ty { LuaType::Def(id) => Some(id == ref_id), @@ -722,3 +700,25 @@ fn check_ref_is_require_def( None => None, } } + +/// 检查是否是导入语句 +fn check_import_decl(semantic_model: &SemanticModel, decl: &LuaDecl) -> Option { + let module_info = parse_require_module_info(semantic_model, decl)?; + + let property_owner_id = module_info.property_owner_id.clone()?; + let property = semantic_model + .get_db() + .get_property_index() + .get_property(&property_owner_id)? + .export + .as_ref()?; + if property.scope == LuaExportScope::Namespace { + let type_index = semantic_model.get_db().get_type_index(); + if type_index.get_file_namespace(&semantic_model.get_file_id()) + != type_index.get_file_namespace(&module_info.file_id) + { + return None; + } + } + Some(true) +} diff --git a/crates/emmylua_ls/src/handlers/test/completion_test.rs b/crates/emmylua_ls/src/handlers/test/completion_test.rs index dc477daa3..e4ec03cad 100644 --- a/crates/emmylua_ls/src/handlers/test/completion_test.rs +++ b/crates/emmylua_ls/src/handlers/test/completion_test.rs @@ -930,11 +930,11 @@ mod tests { ---@export local export = {} - // ---@enum MapName - // export.MapName = { - // A = 1, - // B = 2, - // } + ---@enum MapName + export.MapName = { + A = 1, + B = 2, + } return export "#, From d84281feb94ec31e50d9ad43d48e510eb2b0166c Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 05:07:26 +0800 Subject: [PATCH 03/54] update ---@export --- .../src/db_index/property/mod.rs | 4 +- .../src/db_index/property/property.rs | 2 +- .../src/diagnostic/checker/check_field.rs | 29 +++----------- .../emmylua_code_analysis/src/semantic/mod.rs | 1 + .../src/semantic/visibility/export.rs | 39 +++++++++++++++++++ .../src/semantic/visibility/mod.rs | 4 ++ .../providers/auto_require_provider.rs | 23 +++-------- .../semantic_token/build_semantic_tokens.rs | 23 +++-------- 8 files changed, 64 insertions(+), 61 deletions(-) create mode 100644 crates/emmylua_code_analysis/src/semantic/visibility/export.rs diff --git a/crates/emmylua_code_analysis/src/db_index/property/mod.rs b/crates/emmylua_code_analysis/src/db_index/property/mod.rs index 4e91767f3..9029ab12f 100644 --- a/crates/emmylua_code_analysis/src/db_index/property/mod.rs +++ b/crates/emmylua_code_analysis/src/db_index/property/mod.rs @@ -202,7 +202,9 @@ impl LuaPropertyIndex { export: property::LuaExport, ) -> Option<()> { let property = self.get_or_create_property(owner_id.clone())?; - property.export = Some(Box::new(export)); + property.export = Some(LuaExport { + scope: export.scope, + }); self.in_filed_owner .entry(file_id) diff --git a/crates/emmylua_code_analysis/src/db_index/property/property.rs b/crates/emmylua_code_analysis/src/db_index/property/property.rs index 83b167405..6dd6c2c1d 100644 --- a/crates/emmylua_code_analysis/src/db_index/property/property.rs +++ b/crates/emmylua_code_analysis/src/db_index/property/property.rs @@ -10,7 +10,7 @@ pub struct LuaCommonProperty { pub version_conds: Option>>, pub see_content: Option>, pub other_content: Option>, - pub export: Option>, + pub export: Option, } #[derive(Debug, Clone, PartialEq, Eq)] diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs index 69b2fe690..81b3716ec 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs @@ -6,8 +6,8 @@ use emmylua_parser::{ }; use crate::{ - enum_variable_is_param, parse_require_module_info, DiagnosticCode, InferFailReason, - LuaExportScope, LuaMemberKey, LuaSemanticDeclId, LuaType, SemanticModel, + check_export_visibility, enum_variable_is_param, parse_require_module_info, DiagnosticCode, + InferFailReason, LuaMemberKey, LuaSemanticDeclId, LuaType, SemanticModel, }; use super::{humanize_lint_type, Checker, DiagnosticContext}; @@ -66,9 +66,7 @@ fn check_index_expr( if is_invalid_prefix_type(&prefix_typ) { // 检查是否为 require 导入且具有 export 标记的变量 - if matches!(code, DiagnosticCode::UndefinedField) - && matches!(prefix_typ, LuaType::TableConst(_)) - { + if matches!(prefix_typ, LuaType::TableConst(_)) { // 如果是 require 导入且具有 export 标记的变量, 那么不应该跳过检查 if check_is_require_with_export(semantic_model, &prefix_typ, index_expr).is_none() { return Some(()); @@ -476,24 +474,9 @@ fn check_is_require_with_export( // 检查是否是 require 导入的模块 let module_info = parse_require_module_info(semantic_model, &decl)?; - // 检查模块是否有 export 标记 - let property_owner_id = module_info.property_owner_id.clone()?; - let property = semantic_model - .get_db() - .get_property_index() - .get_property(&property_owner_id)? - .export - .as_ref()?; - - // 如果是 namespace 类型的 export，需要检查是否在同一个命名空间 - if property.scope == LuaExportScope::Namespace { - let type_index = semantic_model.get_db().get_type_index(); - if type_index.get_file_namespace(&semantic_model.get_file_id()) - != type_index.get_file_namespace(&module_info.file_id) - { - return None; - } + if check_export_visibility(semantic_model, &module_info).unwrap_or(false) { + return Some(()); } - Some(()) + None } diff --git a/crates/emmylua_code_analysis/src/semantic/mod.rs b/crates/emmylua_code_analysis/src/semantic/mod.rs index c2182e086..f65ad9c6d 100644 --- a/crates/emmylua_code_analysis/src/semantic/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/mod.rs @@ -36,6 +36,7 @@ use semantic_info::{ }; pub(crate) use type_check::check_type_compact; use type_check::is_sub_type_of; +pub use visibility::check_export_visibility; use visibility::check_visibility; use crate::{db_index::LuaTypeDeclId, Emmyrc, LuaDocument, LuaSemanticDeclId}; diff --git a/crates/emmylua_code_analysis/src/semantic/visibility/export.rs b/crates/emmylua_code_analysis/src/semantic/visibility/export.rs new file mode 100644 index 000000000..7cfc2bba4 --- /dev/null +++ b/crates/emmylua_code_analysis/src/semantic/visibility/export.rs @@ -0,0 +1,39 @@ +use crate::{LuaExportScope, ModuleInfo, SemanticModel}; + +pub fn check_export_visibility( + semantic_model: &SemanticModel, + module_info: &ModuleInfo, +) -> Option { + // 检查模块是否有 export 标记 + let property_owner_id = module_info.property_owner_id.clone()?; + let property = semantic_model + .get_db() + .get_property_index() + .get_property(&property_owner_id)? + .export + .as_ref()?; + match property.scope { + LuaExportScope::Namespace => { + let type_index = semantic_model.get_db().get_type_index(); + let module_namespace = type_index.get_file_namespace(&module_info.file_id)?; + + if let Some(using_namespaces) = + type_index.get_file_using_namespace(&semantic_model.get_file_id()) + { + for using_namespace in using_namespaces { + if using_namespace == module_namespace { + return Some(true); + } + } + } + if type_index.get_file_namespace(&semantic_model.get_file_id())? == module_namespace { + return Some(true); + } + } + _ => { + return Some(true); + } + } + + Some(false) +} diff --git a/crates/emmylua_code_analysis/src/semantic/visibility/mod.rs b/crates/emmylua_code_analysis/src/semantic/visibility/mod.rs index 6415d8547..ac35909ad 100644 --- a/crates/emmylua_code_analysis/src/semantic/visibility/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/visibility/mod.rs @@ -1,3 +1,5 @@ +mod export; + use emmylua_parser::{ LuaAstNode, LuaAstToken, LuaBlock, LuaClosureExpr, LuaFuncStat, LuaGeneralToken, LuaIndexExpr, LuaSyntaxToken, LuaVarExpr, VisibilityKind, @@ -7,6 +9,8 @@ use crate::{DbIndex, Emmyrc, FileId, LuaMemberOwner, LuaSemanticDeclId, LuaType} use super::{infer_expr, type_check::is_sub_type_of, LuaInferCache}; +pub use export::check_export_visibility; + pub fn check_visibility( db: &DbIndex, file_id: FileId, diff --git a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs index 19e22b2db..969f5acc5 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs @@ -1,4 +1,6 @@ -use emmylua_code_analysis::{EmmyrcFilenameConvention, LuaExportScope, LuaType, ModuleInfo}; +use emmylua_code_analysis::{ + check_export_visibility, EmmyrcFilenameConvention, LuaType, ModuleInfo, +}; use emmylua_parser::{LuaAstNode, LuaNameExpr}; use lsp_types::{CompletionItem, Position}; @@ -113,7 +115,6 @@ fn add_module_completion_item( Some(()) } -#[allow(unused)] fn try_add_member_completion_items( builder: &CompletionBuilder, prefix: &str, @@ -122,22 +123,8 @@ fn try_add_member_completion_items( position: Position, completions: &mut Vec, ) -> Option<()> { - let property_owner_id = module_info.property_owner_id.clone()?; - let property = builder - .semantic_model - .get_db() - .get_property_index() - .get_property(&property_owner_id)? - .export - .as_ref()?; - if property.scope == LuaExportScope::Namespace { - let file_id = builder.semantic_model.get_file_id(); - let type_index = builder.semantic_model.get_db().get_type_index(); - if type_index.get_file_namespace(&file_id) - != type_index.get_file_namespace(&module_info.file_id) - { - return None; - } + if !check_export_visibility(&builder.semantic_model, &module_info).unwrap_or(false) { + return None; } if let Some(export_type) = &module_info.export_type { diff --git a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs index 7c418c4e6..ed657f7f2 100644 --- a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs +++ b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs @@ -1,6 +1,6 @@ use emmylua_code_analysis::{ - parse_require_module_info, LuaDecl, LuaDeclExtra, LuaExportScope, LuaMemberId, LuaMemberOwner, - LuaSemanticDeclId, LuaType, LuaTypeDeclId, SemanticDeclLevel, SemanticModel, + check_export_visibility, parse_require_module_info, LuaDecl, LuaDeclExtra, LuaMemberId, + LuaMemberOwner, LuaSemanticDeclId, LuaType, LuaTypeDeclId, SemanticDeclLevel, SemanticModel, }; use emmylua_parser::{ LuaAst, LuaAstNode, LuaAstToken, LuaDocFieldKey, LuaDocObjectFieldKey, LuaExpr, @@ -704,21 +704,8 @@ fn check_ref_is_require_def( /// 检查是否是导入语句 fn check_import_decl(semantic_model: &SemanticModel, decl: &LuaDecl) -> Option { let module_info = parse_require_module_info(semantic_model, decl)?; - - let property_owner_id = module_info.property_owner_id.clone()?; - let property = semantic_model - .get_db() - .get_property_index() - .get_property(&property_owner_id)? - .export - .as_ref()?; - if property.scope == LuaExportScope::Namespace { - let type_index = semantic_model.get_db().get_type_index(); - if type_index.get_file_namespace(&semantic_model.get_file_id()) - != type_index.get_file_namespace(&module_info.file_id) - { - return None; - } + if check_export_visibility(semantic_model, &module_info).unwrap_or(false) { + return Some(true); } - Some(true) + None } From ac41c083daa97bb80e2973bfe373842fea91bed2 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 07:02:22 +0800 Subject: [PATCH 04/54] update @export diagnostic --- .../src/compilation/test/export_test.rs | 34 ++++++++++ .../src/compilation/test/mod.rs | 1 + .../src/diagnostic/checker/check_field.rs | 68 +++++++++++++------ .../src/diagnostic/test/inject_field_test.rs | 46 ++++++++++--- 4 files changed, 122 insertions(+), 27 deletions(-) create mode 100644 crates/emmylua_code_analysis/src/compilation/test/export_test.rs diff --git a/crates/emmylua_code_analysis/src/compilation/test/export_test.rs b/crates/emmylua_code_analysis/src/compilation/test/export_test.rs new file mode 100644 index 000000000..0bbc2f28e --- /dev/null +++ b/crates/emmylua_code_analysis/src/compilation/test/export_test.rs @@ -0,0 +1,34 @@ +#[cfg(test)] +mod test { + use crate::VirtualWorkspace; + + #[test] + fn test_1() { + let mut ws = VirtualWorkspace::new(); + ws.def_file( + "A.lua", + r#" + ---@export + local A = {} + + return A + "#, + ); + + ws.def( + r#" + local A = require("A") + A.newField = 1 + "#, + ); + + ws.def( + r#" + E = require("A").newField + + "#, + ); + let res = ws.expr_ty("E"); + dbg!(&res); + } +} diff --git a/crates/emmylua_code_analysis/src/compilation/test/mod.rs b/crates/emmylua_code_analysis/src/compilation/test/mod.rs index 68097e23b..bd84cf1ab 100644 --- a/crates/emmylua_code_analysis/src/compilation/test/mod.rs +++ b/crates/emmylua_code_analysis/src/compilation/test/mod.rs @@ -5,6 +5,7 @@ mod closure_param_infer_test; mod closure_return_test; mod decl_test; mod diagnostic_disable_test; +mod export_test; mod flow; mod for_range_var_infer_test; mod infer_str_tpl_test; diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs index 81b3716ec..19d0989f5 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs @@ -6,8 +6,8 @@ use emmylua_parser::{ }; use crate::{ - check_export_visibility, enum_variable_is_param, parse_require_module_info, DiagnosticCode, - InferFailReason, LuaMemberKey, LuaSemanticDeclId, LuaType, SemanticModel, + enum_variable_is_param, parse_require_module_info, DiagnosticCode, InferFailReason, + LuaMemberKey, LuaSemanticDeclId, LuaType, ModuleInfo, SemanticModel, }; use super::{humanize_lint_type, Checker, DiagnosticContext}; @@ -63,12 +63,13 @@ fn check_index_expr( let prefix_typ = semantic_model .infer_expr(index_expr.get_prefix_expr()?) .unwrap_or(LuaType::Unknown); + let mut module_info = None; if is_invalid_prefix_type(&prefix_typ) { - // 检查是否为 require 导入且具有 export 标记的变量 if matches!(prefix_typ, LuaType::TableConst(_)) { - // 如果是 require 导入且具有 export 标记的变量, 那么不应该跳过检查 - if check_is_require_with_export(semantic_model, &prefix_typ, index_expr).is_none() { + // 如果导入了被 @export 标记的表常量, 那么不应该跳过检查 + module_info = check_import_table_const(semantic_model, index_expr); + if module_info.is_none() { return Some(()); } } else { @@ -78,7 +79,16 @@ fn check_index_expr( let index_key = index_expr.get_index_key()?; - if is_valid_member(semantic_model, &prefix_typ, index_expr, &index_key, code).is_some() { + if is_valid_member( + semantic_model, + &prefix_typ, + index_expr, + &index_key, + code, + module_info, + ) + .is_some() + { return Some(()); } @@ -135,6 +145,7 @@ fn is_valid_member( index_expr: &LuaIndexExpr, index_key: &LuaIndexKey, code: DiagnosticCode, + module_info: Option<&ModuleInfo>, ) -> Option<()> { match prefix_typ { LuaType::Global | LuaType::Userdata => return Some(()), @@ -181,6 +192,25 @@ fn is_valid_member( match semantic_model.get_semantic_info(index_expr.syntax().clone().into()) { Some(info) => { let need = info.semantic_decl.is_none() && info.typ.is_unknown(); + // TODO: 元组类型的检查或许需要独立出来 + if !need && matches!(code, DiagnosticCode::InjectField) { + // if let LuaType::Tuple(tuple) = prefix_typ { + // if tuple.is_infer_resolve() { + // return Some(()); + // } else { + // // 元组类型禁止修改 + // return None; + // } + // } + // 前缀是导入的表常量, 检查定义的文件是否与导入的表常量相同, 不同则认为是非法的 + if let Some(module_info) = module_info { + if let Some(LuaSemanticDeclId::Member(member_id)) = info.semantic_decl { + if module_info.file_id != member_id.file_id { + return None; + } + } + } + } need } None => true, @@ -216,6 +246,14 @@ fn is_valid_member( // 一些类型组合需要特殊处理 match (prefix_typ, &key_type) { + // (LuaType::Tuple(tuple), LuaType::Integer | LuaType::IntegerConst(_)) => { + // if tuple.is_infer_resolve() { + // return Some(()); + // } else { + // // 元组类型禁止修改 + // return None; + // } + // } (LuaType::Def(id), _) => { if let Some(decl) = semantic_model.get_db().get_type_index().get_type_decl(id) { if decl.is_class() { @@ -449,12 +487,11 @@ fn check_enum_is_param( ) } -/// 检查变量是否为 require 导入且具有 export 标记 -fn check_is_require_with_export( - semantic_model: &SemanticModel, - _prefix_typ: &LuaType, +/// 检查导入的表常量 +fn check_import_table_const<'a>( + semantic_model: &'a SemanticModel, index_expr: &LuaIndexExpr, -) -> Option<()> { +) -> Option<&'a ModuleInfo> { // 获取前缀表达式的语义信息 let prefix_expr = index_expr.get_prefix_expr()?; let semantic_info = semantic_model.get_semantic_info(prefix_expr.syntax().clone().into())?; @@ -471,12 +508,5 @@ fn check_is_require_with_export( .get_decl_index() .get_decl(&decl_id)?; - // 检查是否是 require 导入的模块 - let module_info = parse_require_module_info(semantic_model, &decl)?; - - if check_export_visibility(semantic_model, &module_info).unwrap_or(false) { - return Some(()); - } - - None + parse_require_module_info(semantic_model, &decl) } diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs index 68019c4a0..bf4dfe7bf 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs @@ -141,13 +141,43 @@ mod test { // "# // )); - // // assert!(!ws.check_code_for( - // // DiagnosticCode::InjectField, - // // r#" - // // ---@type [ 'a' ] - // // local a = { 'a' } - // // a[#a + 1] = 'b' - // // "# - // // )); + // assert!(!ws.check_code_for( + // DiagnosticCode::InjectField, + // r#" + // ---@type [ 'a' ] + // local a = { 'a' } + // a[#a + 1] = 'b' + // "# + // )); // } + + #[test] + fn test_export() { + let mut ws = VirtualWorkspace::new(); + ws.def_file( + "a.lua", + r#" + ---@export + local export = {} + + export.a = 1 + + return export + "#, + ); + assert!(!ws.check_code_for( + DiagnosticCode::InjectField, + r#" + local a = require("a") + a.newField = 1 + "#, + )); + assert!(ws.check_code_for( + DiagnosticCode::InjectField, + r#" + local a = require("a") + a.a = 2 + "#, + )); + } } From 15db17318652bcf23acc4066907746f26fe016b8 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 07:27:05 +0800 Subject: [PATCH 05/54] =?UTF-8?q?update=20@export:=20=E5=AF=B9=E6=A0=87?= =?UTF-8?q?=E8=AE=B0=E4=BA=86`@export`=E7=9A=84=E5=AF=BC=E5=87=BA=E5=8F=98?= =?UTF-8?q?=E9=87=8F=E5=AE=9E=E6=96=BD=E8=87=AA=E5=8A=A8=E5=AF=BC=E5=85=A5?= =?UTF-8?q?=E6=8E=A7=E5=88=B6?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/semantic/visibility/export.rs | 15 +++++++++++---- .../completion/providers/auto_require_provider.rs | 8 ++++---- 2 files changed, 15 insertions(+), 8 deletions(-) diff --git a/crates/emmylua_code_analysis/src/semantic/visibility/export.rs b/crates/emmylua_code_analysis/src/semantic/visibility/export.rs index 7cfc2bba4..640b8f294 100644 --- a/crates/emmylua_code_analysis/src/semantic/visibility/export.rs +++ b/crates/emmylua_code_analysis/src/semantic/visibility/export.rs @@ -6,12 +6,19 @@ pub fn check_export_visibility( ) -> Option { // 检查模块是否有 export 标记 let property_owner_id = module_info.property_owner_id.clone()?; - let property = semantic_model + let common_property = semantic_model .get_db() .get_property_index() - .get_property(&property_owner_id)? - .export - .as_ref()?; + .get_property(&property_owner_id); + let Some(common_property) = common_property else { + return Some(true); + }; + + let Some(property) = common_property.export.as_ref() else { + // 没有 export 标记, 视为可见 + return Some(true); + }; + match property.scope { LuaExportScope::Namespace => { let type_index = semantic_model.get_db().get_type_index(); diff --git a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs index 969f5acc5..5504f93ce 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs @@ -70,6 +70,10 @@ fn add_module_completion_item( position: Position, completions: &mut Vec, ) -> Option<()> { + if !check_export_visibility(&builder.semantic_model, &module_info).unwrap_or(false) { + return None; + } + let completion_name = module_name_convert(module_info, file_conversion); if !completion_name.to_lowercase().starts_with(prefix) { try_add_member_completion_items( @@ -123,10 +127,6 @@ fn try_add_member_completion_items( position: Position, completions: &mut Vec, ) -> Option<()> { - if !check_export_visibility(&builder.semantic_model, &module_info).unwrap_or(false) { - return None; - } - if let Some(export_type) = &module_info.export_type { match export_type { LuaType::TableConst(_) | LuaType::Def(_) => { From 1ebdda132b42943649025b69c04bba76c5837f2e Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 08:11:02 +0800 Subject: [PATCH 06/54] add diagnostic: RequireModuleNotVisible --- crates/emmylua_code_analysis/locales/lint.yml | 6 +- .../src/diagnostic/checker/mod.rs | 2 + .../checker/require_module_visibility.rs | 60 ++++++++++++++ .../src/diagnostic/lua_diagnostic_code.rs | 2 + .../src/diagnostic/test/mod.rs | 1 + .../test/require_module_visibility_test.rs | 80 +++++++++++++++++++ .../src/semantic/visibility/export.rs | 33 +++++--- 7 files changed, 170 insertions(+), 14 deletions(-) create mode 100644 crates/emmylua_code_analysis/src/diagnostic/checker/require_module_visibility.rs create mode 100644 crates/emmylua_code_analysis/src/diagnostic/test/require_module_visibility_test.rs diff --git a/crates/emmylua_code_analysis/locales/lint.yml b/crates/emmylua_code_analysis/locales/lint.yml index 43c11f8fa..bdc019bd9 100644 --- a/crates/emmylua_code_analysis/locales/lint.yml +++ b/crates/emmylua_code_analysis/locales/lint.yml @@ -260,4 +260,8 @@ Cannot use `...` outside a vararg function.: "type recursion": en: "type recursion" zh_CN: "类型递归" - zh_HK: "類型遞歸" \ No newline at end of file + zh_HK: "類型遞歸" +"Module '%{module}' is not visible. It has @export restrictions.": + en: "Module '%{module}' is not visible. It has @export restrictions." + zh_CN: "模块 '%{module}' 不可见。它有 @export 限制。" + zh_HK: "模組 '%{module}' 不可見。它有 @export 限制。" \ No newline at end of file diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/mod.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/mod.rs index 791e686b7..6f11c6ffe 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/mod.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/mod.rs @@ -22,6 +22,7 @@ mod missing_fields; mod need_check_nil; mod param_type_check; mod redefined_local; +mod require_module_visibility; mod return_type_mismatch; mod syntax_error; mod unbalanced_assignments; @@ -98,6 +99,7 @@ pub fn check_file(context: &mut DiagnosticContext, semantic_model: &SemanticMode semantic_model, ); run_check::(context, semantic_model); + run_check::(context, semantic_model); run_check::( context, diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/require_module_visibility.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/require_module_visibility.rs new file mode 100644 index 000000000..52bae4f91 --- /dev/null +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/require_module_visibility.rs @@ -0,0 +1,60 @@ +use emmylua_parser::{LuaAstNode, LuaCallExpr}; + +use crate::{check_export_visibility, DiagnosticCode, LuaType, SemanticModel}; + +use super::{Checker, DiagnosticContext}; + +pub struct RequireModuleVisibilityChecker; + +impl Checker for RequireModuleVisibilityChecker { + const CODES: &[DiagnosticCode] = &[DiagnosticCode::RequireModuleNotVisible]; + + fn check(context: &mut DiagnosticContext, semantic_model: &SemanticModel) { + let root = semantic_model.get_root().clone(); + for call_expr in root.descendants::() { + if call_expr.is_require() { + check_require_call_expr(context, semantic_model, call_expr); + } + } + } +} + +fn check_require_call_expr( + context: &mut DiagnosticContext, + semantic_model: &SemanticModel, + call_expr: LuaCallExpr, +) -> Option<()> { + let args_list = call_expr.get_args_list()?; + let arg_expr = args_list.get_args().next()?; + + // 获取模块路径 + let ty = semantic_model + .infer_expr(arg_expr.clone()) + .unwrap_or(LuaType::Any); + let module_path = match ty { + LuaType::StringConst(s) => s.as_ref().to_string(), + _ => return Some(()), + }; + + // 查找模块信息 + let module_info = semantic_model + .get_db() + .get_module_index() + .find_module(&module_path)?; + + // 检查可见性 + if !check_export_visibility(semantic_model, module_info).unwrap_or(false) { + context.add_diagnostic( + DiagnosticCode::RequireModuleNotVisible, + arg_expr.get_range(), + t!( + "Module '%{module}' is not visible. It has @export restrictions.", + module = module_info.full_module_name + ) + .to_string(), + None, + ); + } + + Some(()) +} diff --git a/crates/emmylua_code_analysis/src/diagnostic/lua_diagnostic_code.rs b/crates/emmylua_code_analysis/src/diagnostic/lua_diagnostic_code.rs index fe3a3d616..d22afd160 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/lua_diagnostic_code.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/lua_diagnostic_code.rs @@ -94,6 +94,8 @@ pub enum DiagnosticCode { GenericConstraintMismatch, /// cast-type-mismatch CastTypeMismatch, + /// require-module-not-visible + RequireModuleNotVisible, #[serde(other)] None, diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/mod.rs b/crates/emmylua_code_analysis/src/diagnostic/test/mod.rs index 29cb8a599..b3ddd73e1 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/mod.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/mod.rs @@ -17,6 +17,7 @@ mod need_check_nil_test; mod param_type_check_test; mod redefined_local_test; mod redundant_parameter_test; +mod require_module_visibility_test; mod return_type_mismatch_test; mod syntax_error_test; mod unbalanced_assignments_test; diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/require_module_visibility_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/require_module_visibility_test.rs new file mode 100644 index 000000000..3cf273def --- /dev/null +++ b/crates/emmylua_code_analysis/src/diagnostic/test/require_module_visibility_test.rs @@ -0,0 +1,80 @@ +#[cfg(test)] +mod tests { + use crate::{DiagnosticCode, VirtualWorkspace}; + + #[test] + fn test_1() { + let mut ws = VirtualWorkspace::new(); + ws.enable_check(DiagnosticCode::RequireModuleNotVisible); + + // 定义具有 @export namespace 限制的模块 + ws.def_file( + "test.lua", + r#" + ---@namespace Test + + ---@export namespace + local M = {} + + return M + "#, + ); + + assert!(!ws.check_code_for( + DiagnosticCode::RequireModuleNotVisible, + r#" + local a = require("test") + "#, + )); + } + + #[test] + fn test_2() { + let mut ws = VirtualWorkspace::new(); + ws.enable_check(DiagnosticCode::RequireModuleNotVisible); + + // `@export`没有命名空间限制 + ws.def_file( + "test.lua", + r#" + ---@namespace Test + + ---@export + local M = {} + + return M + "#, + ); + + assert!(ws.check_code_for( + DiagnosticCode::RequireModuleNotVisible, + r#" + ---@namespace AA + local a = require("test") + "#, + )); + } + #[test] + fn test_3() { + let mut ws = VirtualWorkspace::new(); + ws.enable_check(DiagnosticCode::RequireModuleNotVisible); + + // 如果是`@export namespace` 但当前文件没有命名空间, 则视为不可见 + ws.def_file( + "test.lua", + r#" + ---@export namespace + local M = {} + + return M + "#, + ); + + assert!(!ws.check_code_for( + DiagnosticCode::RequireModuleNotVisible, + r#" + local a = require("test") + "#, + )); + } +} diff --git a/crates/emmylua_code_analysis/src/semantic/visibility/export.rs b/crates/emmylua_code_analysis/src/semantic/visibility/export.rs index 640b8f294..c206b553d 100644 --- a/crates/emmylua_code_analysis/src/semantic/visibility/export.rs +++ b/crates/emmylua_code_analysis/src/semantic/visibility/export.rs @@ -1,25 +1,16 @@ -use crate::{LuaExportScope, ModuleInfo, SemanticModel}; +use crate::{LuaExport, LuaExportScope, ModuleInfo, SemanticModel}; +/// 检查模块是否可见, 如果没有 export 标记, 视为可见 pub fn check_export_visibility( semantic_model: &SemanticModel, module_info: &ModuleInfo, ) -> Option { // 检查模块是否有 export 标记 - let property_owner_id = module_info.property_owner_id.clone()?; - let common_property = semantic_model - .get_db() - .get_property_index() - .get_property(&property_owner_id); - let Some(common_property) = common_property else { + let Some(export) = get_export(semantic_model, module_info) else { return Some(true); }; - let Some(property) = common_property.export.as_ref() else { - // 没有 export 标记, 视为可见 - return Some(true); - }; - - match property.scope { + match export.scope { LuaExportScope::Namespace => { let type_index = semantic_model.get_db().get_type_index(); let module_namespace = type_index.get_file_namespace(&module_info.file_id)?; @@ -44,3 +35,19 @@ pub fn check_export_visibility( Some(false) } + +fn get_export<'a>( + semantic_model: &'a SemanticModel, + module_info: &ModuleInfo, +) -> Option<&'a LuaExport> { + // 检查模块是否有 export 标记 + let property_owner_id = module_info.property_owner_id.clone()?; + let export = semantic_model + .get_db() + .get_property_index() + .get_property(&property_owner_id)? + .export + .as_ref()?; + + Some(export) +} From 4e3ce74ad22ed36a58eeeddd57cea92fc048e911 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 08:16:38 +0800 Subject: [PATCH 07/54] update @export --- .../resources/schema.json | 5 +++++ .../providers/doc_name_token_provider.rs | 18 ++++++++++++++++++ .../completion/providers/env_provider.rs | 8 ++++++-- .../semantic_token/build_semantic_tokens.rs | 4 ++++ 4 files changed, 33 insertions(+), 2 deletions(-) diff --git a/crates/emmylua_code_analysis/resources/schema.json b/crates/emmylua_code_analysis/resources/schema.json index d96e8bd71..d272899b4 100644 --- a/crates/emmylua_code_analysis/resources/schema.json +++ b/crates/emmylua_code_analysis/resources/schema.json @@ -384,6 +384,11 @@ "description": "cast-type-mismatch", "type": "string", "const": "cast-type-mismatch" + }, + { + "description": "require-module-not-visible", + "type": "string", + "const": "require-module-not-visible" } ] }, diff --git a/crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs index 944aef766..7203106d9 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs @@ -38,6 +38,9 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> { DocCompletionExpected::Using => { add_tag_using_completion(builder); } + DocCompletionExpected::Export => { + add_tag_export_completion(builder); + } } builder.stop_here(); @@ -74,6 +77,7 @@ fn get_doc_completion_expected(trigger_token: &LuaSyntaxToken) -> Option Some(DocCompletionExpected::Namespace), LuaTokenKind::TkTagUsing => Some(DocCompletionExpected::Using), + LuaTokenKind::TkTagExport => Some(DocCompletionExpected::Export), LuaTokenKind::TkComma => { let parent = left_token.parent()?; match parent.kind().into() { @@ -122,6 +126,7 @@ enum DocCompletionExpected { ClassAttr, Namespace, Using, + Export, } fn add_tag_param_name_completion(builder: &mut CompletionBuilder) -> Option<()> { @@ -306,3 +311,16 @@ fn add_tag_using_completion(builder: &mut CompletionBuilder) { builder.add_completion_item(completion_item); } } + +fn add_tag_export_completion(builder: &mut CompletionBuilder) { + let key = vec!["namespace", "global"]; + for (sorted_index, key) in key.iter().enumerate() { + let completion_item = CompletionItem { + label: key.to_string(), + kind: Some(lsp_types::CompletionItemKind::ENUM_MEMBER), + sort_text: Some(format!("{:03}", sorted_index)), + ..Default::default() + }; + builder.add_completion_item(completion_item); + } +} diff --git a/crates/emmylua_ls/src/handlers/completion/providers/env_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/env_provider.rs index 70f3d5e4b..bb43e05ef 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/env_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/env_provider.rs @@ -59,9 +59,13 @@ fn check_can_add_completion(builder: &CompletionBuilder) -> Option<()> { } else if builder.trigger_kind == CompletionTriggerKind::INVOKED { let parent = builder.trigger_token.parent()?; let prev_token = builder.trigger_token.prev_token()?; - if prev_token.kind() == LuaTokenKind::TkTagUsing.into() { - return None; + match prev_token.kind().into() { + LuaTokenKind::TkTagUsing | LuaTokenKind::TkTagExport | LuaTokenKind::TkTagNamespace => { + return None; + } + _ => {} } + // 即时是主动触发, 也不允许在函数定义的参数列表中添加 if trigger_text == "(" { if LuaParamList::can_cast(parent.kind().into()) { diff --git a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs index ed657f7f2..23819541a 100644 --- a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs +++ b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs @@ -312,6 +312,10 @@ fn build_node_semantic_token( let name = doc_using.get_name_token()?; builder.push(name.syntax(), SemanticTokenType::NAMESPACE); } + LuaAst::LuaDocTagExport(doc_export) => { + let name = doc_export.get_name_token()?; + builder.push(name.syntax(), SemanticTokenType::NAMESPACE); + } LuaAst::LuaParamName(param_name) => { let name = param_name.get_name_token()?; if name.get_name_text() == "self" { From f8343abe6cbc8cd3b60ef56a9d4b2b99bb9f4432 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 16:09:35 +0800 Subject: [PATCH 08/54] =?UTF-8?q?update=20`@export`.=20=E6=94=AF=E6=8C=81`?= =?UTF-8?q?return=20{}`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../compilation/analyzer/doc/property_tags.rs | 20 +++++++++--- .../src/compilation/analyzer/lua/module.rs | 7 ++++- .../src/compilation/test/export_test.rs | 18 +++-------- .../src/db_index/module/module_info.rs | 24 +++++++++++++- .../src/diagnostic/checker/check_field.rs | 10 ++++-- .../src/diagnostic/test/inject_field_test.rs | 28 +++++++++++++++++ .../src/semantic/visibility/export.rs | 24 +++----------- .../providers/auto_require_provider.rs | 8 +++++ .../semantic_token/build_semantic_tokens.rs | 4 +-- .../src/handlers/test/completion_test.rs | 31 ++++++++++++++----- .../emmylua_ls/src/handlers/test_lib/mod.rs | 12 ++++++- 11 files changed, 135 insertions(+), 51 deletions(-) diff --git a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs index 96f4de6ae..9bece7123 100644 --- a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs +++ b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/property_tags.rs @@ -1,12 +1,14 @@ -use crate::{LuaExport, LuaExportScope, LuaNoDiscard, LuaSignatureId}; +use crate::{ + LuaDeclId, LuaExport, LuaExportScope, LuaNoDiscard, LuaSemanticDeclId, LuaSignatureId, +}; use super::{ tags::{find_owner_closure, get_owner_id}, DocAnalyzer, }; use emmylua_parser::{ - LuaDocDescriptionOwner, LuaDocTagDeprecated, LuaDocTagExport, LuaDocTagNodiscard, - LuaDocTagSource, LuaDocTagVersion, LuaDocTagVisibility, + LuaAst, LuaAstNode, LuaDocDescriptionOwner, LuaDocTagDeprecated, LuaDocTagExport, + LuaDocTagNodiscard, LuaDocTagSource, LuaDocTagVersion, LuaDocTagVisibility, LuaTableExpr, }; pub fn analyze_visibility( @@ -112,7 +114,17 @@ pub fn analyze_async(analyzer: &mut DocAnalyzer) -> Option<()> { } pub fn analyze_export(analyzer: &mut DocAnalyzer, tag: LuaDocTagExport) -> Option<()> { - let owner_id = get_owner_id(analyzer)?; + let owner = analyzer.comment.get_owner()?; + let owner_id = match owner { + LuaAst::LuaReturnStat(return_stat) => { + let return_table_expr = return_stat.child::()?; + LuaSemanticDeclId::LuaDecl(LuaDeclId::new( + analyzer.file_id, + return_table_expr.get_position(), + )) + } + _ => get_owner_id(analyzer)?, + }; let export_scope = if let Some(scope_text) = tag.get_export_scope() { match scope_text.as_str() { diff --git a/crates/emmylua_code_analysis/src/compilation/analyzer/lua/module.rs b/crates/emmylua_code_analysis/src/compilation/analyzer/lua/module.rs index 637ee55ed..12e076fa8 100644 --- a/crates/emmylua_code_analysis/src/compilation/analyzer/lua/module.rs +++ b/crates/emmylua_code_analysis/src/compilation/analyzer/lua/module.rs @@ -2,7 +2,7 @@ use emmylua_parser::{LuaAstNode, LuaChunk, LuaExpr}; use crate::{ compilation::analyzer::unresolve::UnResolveModule, db_index::LuaType, InferFailReason, - LuaSemanticDeclId, LuaSignatureId, + LuaDeclId, LuaSemanticDeclId, LuaSignatureId, }; use super::{func_body::analyze_func_body_returns, LuaAnalyzer, LuaReturnPoint}; @@ -67,6 +67,11 @@ fn get_property_owner_id(analyzer: &LuaAnalyzer, expr: LuaExpr) -> Option Some(LuaSemanticDeclId::Signature( LuaSignatureId::from_closure(analyzer.file_id, &closure), )), + // `return {}` + LuaExpr::TableExpr(table_expr) => Some(LuaSemanticDeclId::LuaDecl(LuaDeclId::new( + analyzer.file_id, + table_expr.get_position(), + ))), _ => None, } } diff --git a/crates/emmylua_code_analysis/src/compilation/test/export_test.rs b/crates/emmylua_code_analysis/src/compilation/test/export_test.rs index 0bbc2f28e..865501791 100644 --- a/crates/emmylua_code_analysis/src/compilation/test/export_test.rs +++ b/crates/emmylua_code_analysis/src/compilation/test/export_test.rs @@ -8,27 +8,19 @@ mod test { ws.def_file( "A.lua", r#" - ---@export - local A = {} - return A + ---@export + return { + newField = 1 + } "#, ); ws.def( r#" local A = require("A") - A.newField = 1 - "#, - ); - - ws.def( - r#" - E = require("A").newField - + A.newField = 2 "#, ); - let res = ws.expr_ty("E"); - dbg!(&res); } } diff --git a/crates/emmylua_code_analysis/src/db_index/module/module_info.rs b/crates/emmylua_code_analysis/src/db_index/module/module_info.rs index ffcef1a6f..7be34c1a4 100644 --- a/crates/emmylua_code_analysis/src/db_index/module/module_info.rs +++ b/crates/emmylua_code_analysis/src/db_index/module/module_info.rs @@ -1,6 +1,6 @@ use emmylua_parser::{LuaVersionCondition, LuaVersionNumber}; -use crate::{db_index::LuaType, FileId, LuaSemanticDeclId}; +use crate::{db_index::LuaType, DbIndex, FileId, LuaExport, LuaSemanticDeclId}; use super::{module_node::ModuleNodeId, workspace::WorkspaceId}; @@ -36,4 +36,26 @@ impl ModuleInfo { true } + + pub fn is_export(&self, db: &DbIndex) -> bool { + let Some(property_owner_id) = &self.property_owner_id else { + return false; + }; + + db.get_property_index() + .get_property(property_owner_id) + .and_then(|property| property.export.as_ref()) + .is_some() + } + + pub fn get_export<'a>(&self, db: &'a DbIndex) -> Option<&'a LuaExport> { + let property_owner_id = self.property_owner_id.as_ref()?; + let export = db + .get_property_index() + .get_property(property_owner_id)? + .export + .as_ref()?; + + Some(export) + } } diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs index 19d0989f5..199f05734 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs @@ -68,7 +68,7 @@ fn check_index_expr( if is_invalid_prefix_type(&prefix_typ) { if matches!(prefix_typ, LuaType::TableConst(_)) { // 如果导入了被 @export 标记的表常量, 那么不应该跳过检查 - module_info = check_import_table_const(semantic_model, index_expr); + module_info = check_require_table_const_with_export(semantic_model, index_expr); if module_info.is_none() { return Some(()); } @@ -488,7 +488,7 @@ fn check_enum_is_param( } /// 检查导入的表常量 -fn check_import_table_const<'a>( +fn check_require_table_const_with_export<'a>( semantic_model: &'a SemanticModel, index_expr: &LuaIndexExpr, ) -> Option<&'a ModuleInfo> { @@ -508,5 +508,9 @@ fn check_import_table_const<'a>( .get_decl_index() .get_decl(&decl_id)?; - parse_require_module_info(semantic_model, &decl) + let module_info = parse_require_module_info(semantic_model, &decl)?; + if module_info.is_export(semantic_model.get_db()) { + return Some(module_info); + } + None } diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs index bf4dfe7bf..3ad674bda 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/inject_field_test.rs @@ -180,4 +180,32 @@ mod test { "#, )); } + + #[test] + fn test_export_2() { + let mut ws = VirtualWorkspace::new(); + ws.def_file( + "a.lua", + r#" + ---@export + return { + a = 1 + } + "#, + ); + assert!(!ws.check_code_for( + DiagnosticCode::InjectField, + r#" + local a = require("a") + a.newField = 1 + "#, + )); + assert!(ws.check_code_for( + DiagnosticCode::InjectField, + r#" + local a = require("a") + a.a = 2 + "#, + )); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/visibility/export.rs b/crates/emmylua_code_analysis/src/semantic/visibility/export.rs index c206b553d..f35e348b9 100644 --- a/crates/emmylua_code_analysis/src/semantic/visibility/export.rs +++ b/crates/emmylua_code_analysis/src/semantic/visibility/export.rs @@ -1,12 +1,14 @@ -use crate::{LuaExport, LuaExportScope, ModuleInfo, SemanticModel}; +use crate::{LuaExportScope, ModuleInfo, SemanticModel}; -/// 检查模块是否可见, 如果没有 export 标记, 视为可见 +/// 检查模块是否可见. +/// +/// 如果没有 export 标记, 视为可见. pub fn check_export_visibility( semantic_model: &SemanticModel, module_info: &ModuleInfo, ) -> Option { // 检查模块是否有 export 标记 - let Some(export) = get_export(semantic_model, module_info) else { + let Some(export) = module_info.get_export(semantic_model.get_db()) else { return Some(true); }; @@ -35,19 +37,3 @@ pub fn check_export_visibility( Some(false) } - -fn get_export<'a>( - semantic_model: &'a SemanticModel, - module_info: &ModuleInfo, -) -> Option<&'a LuaExport> { - // 检查模块是否有 export 标记 - let property_owner_id = module_info.property_owner_id.clone()?; - let export = semantic_model - .get_db() - .get_property_index() - .get_property(&property_owner_id)? - .export - .as_ref()?; - - Some(export) -} diff --git a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs index 5504f93ce..a157299a4 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs @@ -127,6 +127,14 @@ fn try_add_member_completion_items( position: Position, completions: &mut Vec, ) -> Option<()> { + // 模块必须要有 export 标记 + if module_info + .get_export(builder.semantic_model.get_db()) + .is_none() + { + return None; + }; + if let Some(export_type) = &module_info.export_type { match export_type { LuaType::TableConst(_) | LuaType::Def(_) => { diff --git a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs index 23819541a..3f3803169 100644 --- a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs +++ b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs @@ -583,7 +583,7 @@ fn handle_name_node( .get_decl_index() .get_decl(&decl_id)?; let decl_type = semantic_model.get_type(decl_id.into()); - if let Some(true) = check_import_decl(semantic_model, &decl) { + if let Some(true) = check_require_decl(semantic_model, &decl) { builder.push_with_modifier( name_token.syntax(), SemanticTokenType::CLASS, @@ -706,7 +706,7 @@ fn check_ref_is_require_def( } /// 检查是否是导入语句 -fn check_import_decl(semantic_model: &SemanticModel, decl: &LuaDecl) -> Option { +fn check_require_decl(semantic_model: &SemanticModel, decl: &LuaDecl) -> Option { let module_info = parse_require_module_info(semantic_model, decl)?; if check_export_visibility(semantic_model, &module_info).unwrap_or(false) { return Some(true); diff --git a/crates/emmylua_ls/src/handlers/test/completion_test.rs b/crates/emmylua_ls/src/handlers/test/completion_test.rs index e4ec03cad..407ca8da1 100644 --- a/crates/emmylua_ls/src/handlers/test/completion_test.rs +++ b/crates/emmylua_ls/src/handlers/test/completion_test.rs @@ -1,8 +1,6 @@ #[cfg(test)] mod tests { - use std::{ops::Deref, sync::Arc}; - use emmylua_code_analysis::EmmyrcFilenameConvention; use lsp_types::{CompletionItemKind, CompletionTriggerKind}; @@ -894,9 +892,9 @@ mod tests { #[test] fn test_auto_require() { let mut ws = ProviderVirtualWorkspace::new(); - let mut emmyrc = ws.analysis.emmyrc.deref().clone(); + let mut emmyrc = ws.get_emmyrc(); emmyrc.completion.auto_require_naming_convention = EmmyrcFilenameConvention::KeepClass; - ws.analysis.update_config(Arc::new(emmyrc)); + ws.update_emmyrc(emmyrc); ws.def_file( "map.lua", r#" @@ -921,9 +919,6 @@ mod tests { #[test] fn test_auto_require_table_field() { let mut ws = ProviderVirtualWorkspace::new(); - let mut emmyrc = ws.analysis.emmyrc.deref().clone(); - emmyrc.completion.auto_require_naming_convention = EmmyrcFilenameConvention::KeepClass; - ws.analysis.update_config(Arc::new(emmyrc)); ws.def_file( "aaaa.lua", r#" @@ -1049,4 +1044,26 @@ mod tests { CompletionTriggerKind::INVOKED, )); } + + #[test] + fn test_auto_require_field_1() { + let mut ws = ProviderVirtualWorkspace::new(); + // 没有 export 标记, 不允许子字段自动导入 + ws.def_file( + "AAA.lua", + r#" + local function map() + end + return { + map = map, + } + "#, + ); + assert!(ws.check_completion( + r#" + map + "#, + vec![], + )); + } } diff --git a/crates/emmylua_ls/src/handlers/test_lib/mod.rs b/crates/emmylua_ls/src/handlers/test_lib/mod.rs index 2153b243f..1c6ff2e5a 100644 --- a/crates/emmylua_ls/src/handlers/test_lib/mod.rs +++ b/crates/emmylua_ls/src/handlers/test_lib/mod.rs @@ -1,4 +1,6 @@ -use emmylua_code_analysis::{EmmyLuaAnalysis, FileId, VirtualUrlGenerator}; +use std::{ops::Deref, sync::Arc}; + +use emmylua_code_analysis::{EmmyLuaAnalysis, Emmyrc, FileId, VirtualUrlGenerator}; use lsp_types::{ CodeActionResponse, CompletionItemKind, CompletionResponse, CompletionTriggerKind, GotoDefinitionResponse, Hover, HoverContents, InlayHint, MarkupContent, Position, @@ -104,6 +106,14 @@ impl ProviderVirtualWorkspace { file_id } + pub fn get_emmyrc(&self) -> Emmyrc { + self.analysis.emmyrc.deref().clone() + } + + pub fn update_emmyrc(&mut self, emmyrc: Emmyrc) { + self.analysis.update_config(Arc::new(emmyrc)); + } + /// 处理文件内容 fn handle_file_content(content: &str) -> Option<(String, Position)> { let content = content.to_string(); From 68c6ada97b0bdbd4ccc73154410e0e155dc494cc Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 16:46:40 +0800 Subject: [PATCH 09/54] fix #558 --- .../providers/table_field_provider.rs | 5 ++- .../src/handlers/test/completion_test.rs | 35 +++++++++++++++++++ 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs index 3961775b3..8d2e56618 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs @@ -1,6 +1,6 @@ use std::collections::HashSet; -use emmylua_code_analysis::{get_real_type, LuaMemberInfo, LuaMemberKey, LuaType}; +use emmylua_code_analysis::{get_real_type, InferGuard, LuaMemberInfo, LuaMemberKey, LuaType}; use emmylua_parser::{LuaAst, LuaAstNode, LuaKind, LuaTableExpr, LuaTableField, LuaTokenKind}; use lsp_types::{CompletionItem, InsertTextFormat, InsertTextMode}; use rowan::NodeOrToken; @@ -9,6 +9,7 @@ use crate::handlers::completion::{ add_completions::{check_visibility, is_deprecated}, completion_builder::CompletionBuilder, completion_data::CompletionData, + providers::function_provider::dispatch_type, }; pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> { @@ -252,6 +253,8 @@ fn add_field_value_completion( }; return builder.add_completion_item(item); + } else { + dispatch_type(builder, real_type.clone(), &mut InferGuard::new())?; } None diff --git a/crates/emmylua_ls/src/handlers/test/completion_test.rs b/crates/emmylua_ls/src/handlers/test/completion_test.rs index 407ca8da1..fed6582f4 100644 --- a/crates/emmylua_ls/src/handlers/test/completion_test.rs +++ b/crates/emmylua_ls/src/handlers/test/completion_test.rs @@ -1066,4 +1066,39 @@ mod tests { vec![], )); } + + #[test] + fn test_issue_558() { + let mut ws = ProviderVirtualWorkspace::new(); + ws.def_file( + "AAA.lua", + r#" + ---@class ability + ---@field t abilityType + + ---@enum (key) abilityType + local abilityType = { + passive = 1, + } + + ---@param a ability + function test(a) + + end + + "#, + ); + assert!(ws.check_completion( + r#" + test({ + t = + }) + "#, + vec![VirtualCompletionItem { + label: "\"passive\"".to_string(), + kind: CompletionItemKind::ENUM_MEMBER, + ..Default::default() + },], + )); + } } From ed5c5dfe47de8e14738f2e38c191950843093af5 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 17:23:38 +0800 Subject: [PATCH 10/54] completion: optimize class_attr_completion --- .../providers/doc_name_token_provider.rs | 79 +++++++++---------- .../src/handlers/test/completion_test.rs | 35 ++------ 2 files changed, 44 insertions(+), 70 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs index 7203106d9..ed0f8e2a6 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/doc_name_token_provider.rs @@ -2,8 +2,8 @@ use std::collections::HashSet; use emmylua_code_analysis::{DiagnosticCode, LuaTypeAttribute}; use emmylua_parser::{ - LuaAst, LuaAstNode, LuaClosureExpr, LuaComment, LuaDocAttribute, LuaSyntaxKind, LuaSyntaxToken, - LuaTokenKind, + LuaAst, LuaAstNode, LuaClosureExpr, LuaComment, LuaDocAttribute, LuaDocTag, LuaSyntaxKind, + LuaSyntaxToken, LuaTokenKind, }; use lsp_types::CompletionItem; @@ -29,8 +29,8 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> { DocCompletionExpected::DiagnosticCode => { add_tag_diagnostic_code_completion(builder); } - DocCompletionExpected::ClassAttr => { - add_tag_class_attr_completion(builder); + DocCompletionExpected::ClassAttr(node) => { + add_tag_class_attr_completion(builder, node); } DocCompletionExpected::Namespace => { add_tag_namespace_completion(builder); @@ -84,7 +84,10 @@ fn get_doc_completion_expected(trigger_token: &LuaSyntaxToken) -> Option { Some(DocCompletionExpected::DiagnosticCode) } - LuaSyntaxKind::DocAttribute => Some(DocCompletionExpected::ClassAttr), + LuaSyntaxKind::DocAttribute => { + let attr = LuaDocAttribute::cast(parent.clone().into())?; + Some(DocCompletionExpected::ClassAttr(attr)) + } _ => None, } } @@ -102,14 +105,20 @@ fn get_doc_completion_expected(trigger_token: &LuaSyntaxToken) -> Option Some(DocCompletionExpected::DiagnosticCode), - LuaSyntaxKind::DocAttribute => Some(DocCompletionExpected::ClassAttr), + LuaSyntaxKind::DocAttribute => { + let attr = LuaDocAttribute::cast(parent.clone().into())?; + Some(DocCompletionExpected::ClassAttr(attr)) + } _ => None, } } LuaTokenKind::TkLeftParen => { let parent = trigger_token.parent()?; match parent.kind().into() { - LuaSyntaxKind::DocAttribute => Some(DocCompletionExpected::ClassAttr), + LuaSyntaxKind::DocAttribute => { + let attr = LuaDocAttribute::cast(parent.clone().into())?; + Some(DocCompletionExpected::ClassAttr(attr)) + } _ => None, } } @@ -117,13 +126,13 @@ fn get_doc_completion_expected(trigger_token: &LuaSyntaxToken) -> Option Option<()> { + let mut attributes = vec![(LuaTypeAttribute::Partial, "partial")]; - // 已存在的属性 - let mut existing_attrs = HashSet::new(); - match builder.trigger_token.kind().into() { - LuaTokenKind::TkLeftParen | LuaTokenKind::TkComma => { - let parent = builder.trigger_token.parent().unwrap(); - let attr = LuaDocAttribute::cast(parent).unwrap(); - for token in attr.get_attrib_tokens() { - let name_text = token.get_name_text().to_string(); - existing_attrs.insert(name_text); - } + match LuaDocTag::cast(node.syntax().parent()?)? { + LuaDocTag::Alias(_) => {} + LuaDocTag::Class(_) => { + attributes.push((LuaTypeAttribute::Exact, "exact")); + attributes.push((LuaTypeAttribute::Constructor, "constructor")); } - LuaTokenKind::TkWhitespace => { - let left_token = builder.trigger_token.prev_token().unwrap(); - match left_token.kind().into() { - LuaTokenKind::TkComma => { - let parent = left_token.parent().unwrap(); - let attr = LuaDocAttribute::cast(parent).unwrap(); - for token in attr.get_attrib_tokens() { - let name_text = token.get_name_text().to_string(); - existing_attrs.insert(name_text); - } - } - _ => {} - } + LuaDocTag::Enum(_) => { + attributes.insert(0, (LuaTypeAttribute::Key, "key")); + attributes.push((LuaTypeAttribute::Exact, "exact")); } _ => {} } + // 已存在的属性 + let mut existing_attrs = HashSet::new(); + for token in node.get_attrib_tokens() { + let name_text = token.get_name_text().to_string(); + existing_attrs.insert(name_text); + } for (_, name) in attributes.iter() { if existing_attrs.contains(*name) { @@ -267,6 +264,8 @@ fn add_tag_class_attr_completion(builder: &mut CompletionBuilder) { }; builder.add_completion_item(completion_item); } + + Some(()) } fn add_tag_namespace_completion(builder: &mut CompletionBuilder) { diff --git a/crates/emmylua_ls/src/handlers/test/completion_test.rs b/crates/emmylua_ls/src/handlers/test/completion_test.rs index fed6582f4..6a4616b59 100644 --- a/crates/emmylua_ls/src/handlers/test/completion_test.rs +++ b/crates/emmylua_ls/src/handlers/test/completion_test.rs @@ -469,23 +469,13 @@ mod tests { kind: CompletionItemKind::ENUM_MEMBER, ..Default::default() }, - VirtualCompletionItem { - label: "key".to_string(), - kind: CompletionItemKind::ENUM_MEMBER, - ..Default::default() - }, - VirtualCompletionItem { - label: "constructor".to_string(), - kind: CompletionItemKind::ENUM_MEMBER, - ..Default::default() - }, VirtualCompletionItem { label: "exact".to_string(), kind: CompletionItemKind::ENUM_MEMBER, ..Default::default() }, VirtualCompletionItem { - label: "meta".to_string(), + label: "constructor".to_string(), kind: CompletionItemKind::ENUM_MEMBER, ..Default::default() }, @@ -499,23 +489,13 @@ mod tests { ---@field a string "#, vec![ - VirtualCompletionItem { - label: "key".to_string(), - kind: CompletionItemKind::ENUM_MEMBER, - ..Default::default() - }, - VirtualCompletionItem { - label: "constructor".to_string(), - kind: CompletionItemKind::ENUM_MEMBER, - ..Default::default() - }, VirtualCompletionItem { label: "exact".to_string(), kind: CompletionItemKind::ENUM_MEMBER, ..Default::default() }, VirtualCompletionItem { - label: "meta".to_string(), + label: "constructor".to_string(), kind: CompletionItemKind::ENUM_MEMBER, ..Default::default() }, @@ -525,8 +505,8 @@ mod tests { assert!(ws.check_completion_with_kind( r#" - ---@class (partial, ) C - ---@field a string + ---@enum () C + "#, vec![ VirtualCompletionItem { @@ -535,7 +515,7 @@ mod tests { ..Default::default() }, VirtualCompletionItem { - label: "constructor".to_string(), + label: "partial".to_string(), kind: CompletionItemKind::ENUM_MEMBER, ..Default::default() }, @@ -544,11 +524,6 @@ mod tests { kind: CompletionItemKind::ENUM_MEMBER, ..Default::default() }, - VirtualCompletionItem { - label: "meta".to_string(), - kind: CompletionItemKind::ENUM_MEMBER, - ..Default::default() - }, ], CompletionTriggerKind::TRIGGER_CHARACTER, )); From 3b1fff73fde05f4439fdbea9d72ae38423e91785 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sat, 28 Jun 2025 18:06:37 +0800 Subject: [PATCH 11/54] =?UTF-8?q?diagnostic:=20=E5=A2=9E=E5=BC=BA=E5=8F=82?= =?UTF-8?q?=E6=95=B0=E4=B8=8E=E8=BF=94=E5=9B=9E=E5=80=BC=E7=9A=84=E8=A1=A8?= =?UTF-8?q?=E6=A3=80=E6=9F=A5,=20=E5=BD=93=E8=A1=A8=E5=AD=97=E6=AE=B5?= =?UTF-8?q?=E4=B8=8D=E5=8C=B9=E9=85=8D=E6=97=B6=E5=8F=8D=E5=90=91=E6=8A=91?= =?UTF-8?q?=E5=88=B6=E5=8F=82=E6=95=B0=E4=B8=8E=E8=BF=94=E5=9B=9E=E5=80=BC?= =?UTF-8?q?=E6=A3=80=E6=9F=A5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../checker/assign_type_mismatch.rs | 74 +++++++++++-------- .../diagnostic/checker/param_type_check.rs | 39 +++++++++- .../checker/return_type_mismatch.rs | 42 +++++++++-- .../test/assign_type_mismatch_test.rs | 26 +++++++ 4 files changed, 143 insertions(+), 38 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/assign_type_mismatch.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/assign_type_mismatch.rs index eff80e95a..b07b7819b 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/assign_type_mismatch.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/assign_type_mismatch.rs @@ -113,9 +113,9 @@ fn check_name_expr( check_table_expr( context, semantic_model, + &expr, source_type.as_ref(), Some(&value_type), - &expr, ); } @@ -149,9 +149,9 @@ fn check_index_expr( check_table_expr( context, semantic_model, + &expr, source_type.as_ref(), Some(&value_type), - &expr, ); } Some(()) @@ -192,35 +192,35 @@ fn check_local_stat( check_table_expr( context, semantic_model, + &expr, Some(&var_type), Some(&value_type), - &expr, ); } } Some(()) } -fn check_table_expr( +pub fn check_table_expr( context: &mut DiagnosticContext, semantic_model: &SemanticModel, + table_expr: &LuaExpr, table_type: Option<&LuaType>, // 记录的类型 expr_type: Option<&LuaType>, // 实际表达式推导出的类型 - table_expr: &LuaExpr, -) -> Option<()> { +) -> Option { // 需要进行一些过滤 if table_type == expr_type { - return Some(()); + return Some(false); } let table_type = table_type?; match table_type { - LuaType::Def(_) => return Some(()), + LuaType::Def(_) => return Some(false), _ => {} } if let Some(table_expr) = LuaTableExpr::cast(table_expr.syntax().clone()) { - check_table_expr_content(context, semantic_model, table_type, &table_expr); + return check_table_expr_content(context, semantic_model, table_type, &table_expr); } - Some(()) + Some(false) } // 处理 value_expr 是 TableExpr 的情况, 但不会处理 `local a = { x = 1 }, local v = a` @@ -229,16 +229,17 @@ fn check_table_expr_content( semantic_model: &SemanticModel, table_type: &LuaType, table_expr: &LuaTableExpr, -) -> Option<()> { +) -> Option { const MAX_CHECK_COUNT: usize = 250; let mut check_count = 0; + let mut has_diagnostic = false; let fields = table_expr.get_fields().collect::>(); for (idx, field) in fields.iter().enumerate() { check_count += 1; if check_count > MAX_CHECK_COUNT { - return Some(()); + return Some(has_diagnostic); } let Some(value_expr) = field.get_value_expr() else { continue; @@ -255,12 +256,14 @@ fn check_table_expr_content( // 解开可变参数 let expr_types = semantic_model.infer_expr_list_types(&vec![value_expr.clone()], None); - check_table_last_variadic_type( + if let Some(result) = check_table_last_variadic_type( context, semantic_model, table_type, &expr_types, - ); + ) { + has_diagnostic = has_diagnostic || result; + } continue; } _ => {} @@ -283,7 +286,11 @@ fn check_table_expr_content( if source_type.is_table() || source_type.is_custom_type() { if let Some(table_expr) = LuaTableExpr::cast(value_expr.syntax().clone()) { // 检查子表 - check_table_expr_content(context, semantic_model, &source_type, &table_expr); + if let Some(result) = + check_table_expr_content(context, semantic_model, &source_type, &table_expr) + { + has_diagnostic = has_diagnostic || result; + } continue; } } @@ -293,17 +300,19 @@ fn check_table_expr_content( _ => false, }; - check_assign_type_mismatch( + if let Some(result) = check_assign_type_mismatch( context, semantic_model, field.get_range(), Some(&source_type), &expr_type, allow_nil, - ); + ) { + has_diagnostic = has_diagnostic || result; + } } - Some(()) + Some(has_diagnostic) } fn check_table_last_variadic_type( @@ -311,7 +320,9 @@ fn check_table_last_variadic_type( semantic_model: &SemanticModel, table_type: &LuaType, expr_types: &[(LuaType, TextRange)], -) -> Option<()> { +) -> Option { + let mut has_diagnostic = false; + for (idx, (expr_type, range)) in expr_types.iter().enumerate() { // 此时的值必然是从下标 1 开始递增的 let member_key = LuaMemberKey::Integer(idx as i64 + 1); @@ -328,16 +339,18 @@ fn check_table_last_variadic_type( expr_type.clone() }; - check_assign_type_mismatch( + if let Some(result) = check_assign_type_mismatch( context, semantic_model, *range, Some(&source_type), &expr_type, false, - ); + ) { + has_diagnostic = has_diagnostic || result; + } } - Some(()) + Some(has_diagnostic) } fn check_assign_type_mismatch( @@ -347,28 +360,28 @@ fn check_assign_type_mismatch( source_type: Option<&LuaType>, value_type: &LuaType, allow_nil: bool, -) -> Option<()> { +) -> Option { let source_type = source_type.unwrap_or(&LuaType::Any); // 如果一致, 则不进行类型检查 if source_type == value_type { - return Some(()); + return Some(false); } // 某些情况下我们应允许可空, 例如: boolean[] if allow_nil && value_type.is_nullable() { - return Some(()); + return Some(false); } match (&source_type, &value_type) { // 如果源类型是定义类型, 则仅在目标类型是定义类型或引用类型时进行类型检查 (LuaType::Def(_), LuaType::Def(_) | LuaType::Ref(_)) => {} - (LuaType::Def(_), _) => return Some(()), + (LuaType::Def(_), _) => return Some(false), // 此时检查交给 table_field - (LuaType::Ref(_) | LuaType::Tuple(_), LuaType::TableConst(_)) => return Some(()), - (LuaType::Nil, _) => return Some(()), + (LuaType::Ref(_) | LuaType::Tuple(_), LuaType::TableConst(_)) => return Some(false), + (LuaType::Nil, _) => return Some(false), (LuaType::Ref(_), LuaType::Instance(instance)) => { if instance.get_base().is_table() { - return Some(()); + return Some(false); } } _ => {} @@ -384,8 +397,9 @@ fn check_assign_type_mismatch( &value_type, result, ); + return Some(true); } - Some(()) + Some(false) } fn add_type_check_diagnostic( diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/param_type_check.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/param_type_check.rs index 9bbc69b81..0358a15df 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/param_type_check.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/param_type_check.rs @@ -2,8 +2,9 @@ use emmylua_parser::{LuaAst, LuaAstNode, LuaAstToken, LuaCallExpr, LuaExpr, LuaI use rowan::TextRange; use crate::{ - humanize_type, DiagnosticCode, LuaSemanticDeclId, LuaType, RenderLevel, SemanticDeclLevel, - SemanticModel, TypeCheckFailReason, TypeCheckResult, + diagnostic::checker::assign_type_mismatch::check_table_expr, humanize_type, DiagnosticCode, + LuaSemanticDeclId, LuaType, RenderLevel, SemanticDeclLevel, SemanticModel, TypeCheckFailReason, + TypeCheckResult, }; use super::{Checker, DiagnosticContext}; @@ -11,7 +12,10 @@ use super::{Checker, DiagnosticContext}; pub struct ParamTypeCheckChecker; impl Checker for ParamTypeCheckChecker { - const CODES: &[DiagnosticCode] = &[DiagnosticCode::ParamTypeNotMatch]; + const CODES: &[DiagnosticCode] = &[ + DiagnosticCode::ParamTypeNotMatch, + DiagnosticCode::AssignTypeMismatch, + ]; /// a simple implementation of param type check, later we will do better fn check(context: &mut DiagnosticContext, semantic_model: &SemanticModel) { @@ -85,6 +89,35 @@ fn check_call_expr( } let result = semantic_model.type_check(&check_type, arg_type); if !result.is_ok() { + // 这里执行了`AssignTypeMismatch`的检查 + if arg_type.is_table() { + let arg_expr_idx = match (colon_call, colon_define) { + (true, false) => { + if idx == 0 { + continue; + } else { + idx - 1 + } + } + _ => idx, + }; + + if let Some(arg_expr) = arg_exprs.get(arg_expr_idx) { + // 表字段已经报错了, 则不添加参数不匹配的诊断避免干扰 + if let Some(add_diagnostic) = check_table_expr( + context, + semantic_model, + arg_expr, + Some(¶m_type), + Some(arg_type), + ) { + if add_diagnostic { + continue; + } + } + } + } + try_add_diagnostic( context, semantic_model, diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs index 15db135a7..d76909965 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs @@ -4,8 +4,9 @@ use emmylua_parser::{ use rowan::{NodeOrToken, TextRange}; use crate::{ - humanize_type, DiagnosticCode, LuaSemanticDeclId, LuaSignatureId, LuaType, RenderLevel, - SemanticDeclLevel, SemanticModel, SignatureReturnStatus, TypeCheckFailReason, TypeCheckResult, + diagnostic::checker::assign_type_mismatch::check_table_expr, humanize_type, DiagnosticCode, + LuaSemanticDeclId, LuaSignatureId, LuaType, RenderLevel, SemanticDeclLevel, SemanticModel, + SignatureReturnStatus, TypeCheckFailReason, TypeCheckResult, }; use super::{get_return_stats, Checker, DiagnosticContext}; @@ -13,7 +14,10 @@ use super::{get_return_stats, Checker, DiagnosticContext}; pub struct ReturnTypeMismatch; impl Checker for ReturnTypeMismatch { - const CODES: &[DiagnosticCode] = &[DiagnosticCode::ReturnTypeMismatch]; + const CODES: &[DiagnosticCode] = &[ + DiagnosticCode::ReturnTypeMismatch, + DiagnosticCode::AssignTypeMismatch, + ]; fn check(context: &mut DiagnosticContext, semantic_model: &SemanticModel) { let root = semantic_model.get_root().clone(); @@ -54,9 +58,9 @@ fn check_return_stat( return_type: &LuaType, return_stat: &LuaReturnStat, ) -> Option<()> { + let return_exprs = return_stat.get_expr_list().collect::>(); let (return_expr_types, return_expr_ranges) = { - let infos = semantic_model - .infer_expr_list_types(&return_stat.get_expr_list().collect::>(), None); + let infos = semantic_model.infer_expr_list_types(&return_exprs, None); let mut return_expr_types = infos.iter().map(|(typ, _)| typ.clone()).collect::>(); // 解决 setmetatable 的返回值类型问题 let setmetatable_index = has_setmetatable(semantic_model, return_stat); @@ -87,6 +91,18 @@ fn check_return_stat( let result = semantic_model.type_check(check_type, return_expr_type); if !result.is_ok() { + if return_expr_type.is_table() { + if let Some(return_expr) = return_exprs.get(index) { + check_table_expr( + context, + semantic_model, + return_expr, + Some(check_type), + Some(return_expr_type), + ); + } + } + add_type_check_diagnostic( context, semantic_model, @@ -112,6 +128,22 @@ fn check_return_stat( let return_expr_range = return_expr_ranges[0]; let result = semantic_model.type_check(check_type, &return_expr_type); if !result.is_ok() { + if return_expr_type.is_table() { + if let Some(return_expr) = return_exprs.get(0) { + // 表字段已经报错了, 则不添加返回值不匹配的诊断避免干扰 + if let Some(add_diagnostic) = check_table_expr( + context, + semantic_model, + return_expr, + Some(return_type), + Some(return_expr_type), + ) { + if add_diagnostic { + return Some(()); + } + } + } + } add_type_check_diagnostic( context, semantic_model, diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs index cb6f97446..8e735aef6 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs @@ -922,4 +922,30 @@ return t "# )); } + + #[test] + fn test_param_tbale() { + let mut ws = VirtualWorkspace::new(); + assert!(!ws.check_code_for( + DiagnosticCode::AssignTypeMismatch, + r#" + ---@class ability + ---@field t abilityType + + ---@enum (key) abilityType + local abilityType = { + passive = 1, + } + + ---@param a ability + function test(a) + + end + + test({ + t = "" + }) + "# + )); + } } From 5bab99402a07b7ddb781e79ea11f365db2115eb6 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 06:44:10 +0800 Subject: [PATCH 12/54] =?UTF-8?q?fix:=20`@type`=E7=8E=B0=E5=9C=A8=E4=BC=9A?= =?UTF-8?q?=E7=BB=91=E5=AE=9A=E5=8F=B3=E4=BE=A7=E7=9A=84=E6=B3=A8=E9=87=8A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../compilation/analyzer/doc/type_ref_tags.rs | 50 +++++++++++++++++++ .../src/handlers/test/hover_test.rs | 18 +++++++ 2 files changed, 68 insertions(+) diff --git a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/type_ref_tags.rs b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/type_ref_tags.rs index bdd2e4a94..5e589ddaa 100644 --- a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/type_ref_tags.rs +++ b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/type_ref_tags.rs @@ -25,6 +25,12 @@ use super::{ }; pub fn analyze_type(analyzer: &mut DocAnalyzer, tag: LuaDocTagType) -> Option<()> { + let description = if let Some(des) = tag.get_description() { + Some(preprocess_description(&des.get_description_text(), None)) + } else { + None + }; + let mut type_list = Vec::new(); for lua_doc_type in tag.get_type_list() { let type_ref = infer_type(analyzer, lua_doc_type); @@ -50,6 +56,17 @@ pub fn analyze_type(analyzer: &mut DocAnalyzer, tag: LuaDocTagType) -> Option<() .db .get_type_index_mut() .bind_type(decl_id.into(), LuaTypeCache::DocType(type_ref.clone())); + + // bind description + if let Some(ref desc) = description { + if !desc.is_empty() { + analyzer.db.get_property_index_mut().add_description( + analyzer.file_id, + LuaSemanticDeclId::LuaDecl(decl_id), + desc.clone(), + ); + } + } } LuaVarExpr::IndexExpr(index_expr) => { let member_id = @@ -58,6 +75,17 @@ pub fn analyze_type(analyzer: &mut DocAnalyzer, tag: LuaDocTagType) -> Option<() .db .get_type_index_mut() .bind_type(member_id.into(), LuaTypeCache::DocType(type_ref.clone())); + + // bind description + if let Some(ref desc) = description { + if !desc.is_empty() { + analyzer.db.get_property_index_mut().add_description( + analyzer.file_id, + LuaSemanticDeclId::Member(member_id), + desc.clone(), + ); + } + } } } } @@ -77,6 +105,17 @@ pub fn analyze_type(analyzer: &mut DocAnalyzer, tag: LuaDocTagType) -> Option<() .db .get_type_index_mut() .bind_type(decl_id.into(), LuaTypeCache::DocType(type_ref.clone())); + + // bind description + if let Some(ref desc) = description { + if !desc.is_empty() { + analyzer.db.get_property_index_mut().add_description( + analyzer.file_id, + LuaSemanticDeclId::LuaDecl(decl_id), + desc.clone(), + ); + } + } } } LuaAst::LuaTableField(table_field) => { @@ -87,6 +126,17 @@ pub fn analyze_type(analyzer: &mut DocAnalyzer, tag: LuaDocTagType) -> Option<() .db .get_type_index_mut() .bind_type(member_id.into(), LuaTypeCache::DocType(first_type.clone())); + + // bind description + if let Some(ref desc) = description { + if !desc.is_empty() { + analyzer.db.get_property_index_mut().add_description( + analyzer.file_id, + LuaSemanticDeclId::Member(member_id), + desc.clone(), + ); + } + } } } _ => {} diff --git a/crates/emmylua_ls/src/handlers/test/hover_test.rs b/crates/emmylua_ls/src/handlers/test/hover_test.rs index 7cd08662c..f59bf84ee 100644 --- a/crates/emmylua_ls/src/handlers/test/hover_test.rs +++ b/crates/emmylua_ls/src/handlers/test/hover_test.rs @@ -227,4 +227,22 @@ mod tests { }, )); } + + #[test] + fn test_type_desc() { + let mut ws = ProviderVirtualWorkspace::new(); + assert!(ws.check_hover( + r#" + local export = { + ---@type number? activeSub + vvv = nil + } + + export.vvv + "#, + VirtualHoverResult { + value: "```lua\n(field) vvv: number?\n```\n\n---\n\nactiveSub".to_string(), + }, + )); + } } From 2b61c16be370debd27d894369454c3d04ea4cb72 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 13:13:59 +0800 Subject: [PATCH 13/54] =?UTF-8?q?diagnostic:=20AssignTypeMismatch=20?= =?UTF-8?q?=E7=A7=BB=E9=99=A4=20table=20=E8=BF=87=E6=BB=A4?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../diagnostic/checker/assign_type_mismatch.rs | 16 ++++++++-------- .../diagnostic/test/assign_type_mismatch_test.rs | 14 ++++++++++++++ 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/assign_type_mismatch.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/assign_type_mismatch.rs index b07b7819b..3604f8a08 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/assign_type_mismatch.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/assign_type_mismatch.rs @@ -206,17 +206,17 @@ pub fn check_table_expr( semantic_model: &SemanticModel, table_expr: &LuaExpr, table_type: Option<&LuaType>, // 记录的类型 - expr_type: Option<&LuaType>, // 实际表达式推导出的类型 + _expr_type: Option<&LuaType>, // 实际表达式推导出的类型 ) -> Option { // 需要进行一些过滤 - if table_type == expr_type { - return Some(false); - } + // if table_type == expr_type { + // return Some(false); + // } let table_type = table_type?; - match table_type { - LuaType::Def(_) => return Some(false), - _ => {} - } + // match table_type { + // LuaType::Def(_) => return Some(false), + // _ => {} + // } if let Some(table_expr) = LuaTableExpr::cast(table_expr.syntax().clone()) { return check_table_expr_content(context, semantic_model, table_type, &table_expr); } diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs index 8e735aef6..a88d8a9dc 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs @@ -948,4 +948,18 @@ return t "# )); } + + #[test] + fn test_tabe_field_type_mismatch() { + let mut ws = VirtualWorkspace::new(); + assert!(!ws.check_code_for( + DiagnosticCode::AssignTypeMismatch, + r#" + local export = { + ---@type number? + vvv = "a" + } + "# + )); + } } From dbaa3fe4cd6c153adb84557e3899ce6ed5d95959 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 14:59:41 +0800 Subject: [PATCH 14/54] =?UTF-8?q?[New]=20=E9=87=8D=E5=91=BD=E5=90=8D?= =?UTF-8?q?=E6=94=AF=E6=8C=81=E7=B4=A2=E5=BC=95=E8=AE=BF=E9=97=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- crates/emmylua_ls/src/handlers/rename/mod.rs | 84 +++++++++++-------- .../src/handlers/rename/rename_member.rs | 36 ++++++-- crates/emmylua_ls/src/handlers/test/mod.rs | 1 + .../src/handlers/test/rename_test.rs | 21 +++++ .../emmylua_ls/src/handlers/test_lib/mod.rs | 24 ++++++ 5 files changed, 123 insertions(+), 43 deletions(-) create mode 100644 crates/emmylua_ls/src/handlers/test/rename_test.rs diff --git a/crates/emmylua_ls/src/handlers/rename/mod.rs b/crates/emmylua_ls/src/handlers/rename/mod.rs index d12c68445..3b4b8d788 100644 --- a/crates/emmylua_ls/src/handlers/rename/mod.rs +++ b/crates/emmylua_ls/src/handlers/rename/mod.rs @@ -5,7 +5,7 @@ mod rename_type; use std::collections::HashMap; use emmylua_code_analysis::{LuaCompilation, LuaSemanticDeclId, SemanticDeclLevel, SemanticModel}; -use emmylua_parser::{LuaAstNode, LuaSyntaxToken, LuaTokenKind}; +use emmylua_parser::{LuaAstNode, LuaLiteralExpr, LuaSyntaxToken, LuaTableField, LuaTokenKind}; use lsp_types::{ ClientCapabilities, OneOf, PrepareRenameResponse, RenameOptions, RenameParams, ServerCapabilities, TextDocumentPositionParams, WorkspaceEdit, @@ -29,37 +29,7 @@ pub async fn on_rename_handler( let analysis = context.analysis.read().await; let file_id = analysis.get_file_id(&uri)?; let position = params.text_document_position.position; - let mut semantic_model = analysis.compilation.get_semantic_model(file_id)?; - let root = semantic_model.get_root(); - let position_offset = { - let document = semantic_model.get_document(); - document.get_offset(position.line as usize, position.character as usize)? - }; - - if position_offset > root.syntax().text_range().end() { - return None; - } - - let token = match root.syntax().token_at_offset(position_offset) { - TokenAtOffset::Single(token) => token, - TokenAtOffset::Between(left, right) => { - if left.kind() == LuaTokenKind::TkName.into() { - left - } else { - right - } - } - TokenAtOffset::None => { - return None; - } - }; - - rename_references( - &mut semantic_model, - &analysis.compilation, - token, - params.new_name, - ) + rename(&analysis, file_id, position, params.new_name) } pub async fn on_prepare_rename_handler( @@ -94,7 +64,6 @@ pub async fn on_prepare_rename_handler( return None; } }; - if matches!( token.kind().into(), LuaTokenKind::TkName | LuaTokenKind::TkInt | LuaTokenKind::TkString @@ -107,6 +76,40 @@ pub async fn on_prepare_rename_handler( } } +pub fn rename( + analysis: &emmylua_code_analysis::EmmyLuaAnalysis, + file_id: emmylua_code_analysis::FileId, + position: lsp_types::Position, + new_name: String, +) -> Option { + let mut semantic_model = analysis.compilation.get_semantic_model(file_id)?; + let root = semantic_model.get_root(); + let position_offset = { + let document = semantic_model.get_document(); + document.get_offset(position.line as usize, position.character as usize)? + }; + + if position_offset > root.syntax().text_range().end() { + return None; + } + + let token = match root.syntax().token_at_offset(position_offset) { + TokenAtOffset::Single(token) => token, + TokenAtOffset::Between(left, right) => { + if left.kind() == LuaTokenKind::TkName.into() { + left + } else { + right + } + } + TokenAtOffset::None => { + return None; + } + }; + + rename_references(&mut semantic_model, &analysis.compilation, token, new_name) +} + fn rename_references( semantic_model: &SemanticModel, compilation: &LuaCompilation, @@ -114,7 +117,14 @@ fn rename_references( new_name: String, ) -> Option { let mut result = HashMap::new(); - let semantic_decl = semantic_model.find_decl(token.into(), SemanticDeclLevel::NoTrace)?; + let semantic_decl = match try_get_table_field(token.clone()) { + Some(table_field) => semantic_model.find_decl( + table_field.syntax().clone().into(), + SemanticDeclLevel::NoTrace, + ), + None => semantic_model.find_decl(token.into(), SemanticDeclLevel::NoTrace), + }?; + match semantic_decl { LuaSemanticDeclId::LuaDecl(decl_id) => { rename_decl_references(semantic_model, compilation, decl_id, new_name, &mut result); @@ -159,6 +169,12 @@ fn rename_references( }) } +fn try_get_table_field(token: LuaSyntaxToken) -> Option { + let parent = token.parent()?; + let literal_expr = LuaLiteralExpr::cast(parent)?; + literal_expr.get_parent::() +} + pub struct RenameCapabilities; impl RegisterCapabilities for RenameCapabilities { diff --git a/crates/emmylua_ls/src/handlers/rename/rename_member.rs b/crates/emmylua_ls/src/handlers/rename/rename_member.rs index 2dbfe194c..f1570a6d4 100644 --- a/crates/emmylua_ls/src/handlers/rename/rename_member.rs +++ b/crates/emmylua_ls/src/handlers/rename/rename_member.rs @@ -3,7 +3,10 @@ use std::collections::HashMap; use emmylua_code_analysis::{ LuaCompilation, LuaMemberId, LuaSemanticDeclId, SemanticDeclLevel, SemanticModel, }; -use emmylua_parser::{LuaAst, LuaAstNode, LuaAstToken, LuaNameToken, LuaSyntaxNode}; +use emmylua_parser::{ + LuaAst, LuaAstNode, LuaAstToken, LuaIndexToken, LuaLiteralExpr, LuaNameToken, LuaSyntaxNode, + LuaTokenKind, +}; use lsp_types::Uri; use crate::handlers::hover::find_member_origin_owner; @@ -44,11 +47,13 @@ pub fn rename_member_references( property_owner.clone(), SemanticDeclLevel::NoTrace, ) { - let range = get_member_name_token_lsp_range(semantic_model, node.clone())?; - result - .entry(semantic_model.get_document().get_uri()) - .or_insert_with(HashMap::new) - .insert(range, new_name.clone()); + let range = get_member_name_token_lsp_range(semantic_model, node.clone()); + if let Some(range) = range { + result + .entry(semantic_model.get_document().get_uri()) + .or_insert_with(HashMap::new) + .insert(range, new_name.clone()); + } } } @@ -61,7 +66,20 @@ fn get_member_name_token_lsp_range( ) -> Option { let document = semantic_model.get_document(); let node = LuaAst::cast(node)?; - // todo - let token = node.token::()?; - document.to_lsp_range(token.get_range()) + if let Some(token) = node.token::() { + return document.to_lsp_range(token.get_range()); + } + + // 此时可能是 [] 访问 + if let Some(_) = node.token::() { + let literal = node.child::()?.get_literal()?; + if matches!( + literal.get_token_kind(), + LuaTokenKind::TkInt | LuaTokenKind::TkString + ) { + return document.to_lsp_range(literal.get_range()); + } + } + + None } diff --git a/crates/emmylua_ls/src/handlers/test/mod.rs b/crates/emmylua_ls/src/handlers/test/mod.rs index 8b1cbb20c..7cd8c8c78 100644 --- a/crates/emmylua_ls/src/handlers/test/mod.rs +++ b/crates/emmylua_ls/src/handlers/test/mod.rs @@ -6,5 +6,6 @@ mod hover_function_test; mod hover_test; mod implementation_test; mod inlay_hint_test; +mod rename_test; mod semantic_token_test; mod signature_helper_test; diff --git a/crates/emmylua_ls/src/handlers/test/rename_test.rs b/crates/emmylua_ls/src/handlers/test/rename_test.rs new file mode 100644 index 000000000..2fd60ef5a --- /dev/null +++ b/crates/emmylua_ls/src/handlers/test/rename_test.rs @@ -0,0 +1,21 @@ +#[cfg(test)] +mod tests { + use crate::handlers::test_lib::ProviderVirtualWorkspace; + + #[test] + fn test_int_key() { + let mut ws = ProviderVirtualWorkspace::new(); + let result = ws.check_rename( + r#" + local export = { + [1] = 1, + } + + export[1] = 2 + "#, + "2".to_string(), + 2, + ); + assert!(result); + } +} diff --git a/crates/emmylua_ls/src/handlers/test_lib/mod.rs b/crates/emmylua_ls/src/handlers/test_lib/mod.rs index 1c6ff2e5a..b38d8378b 100644 --- a/crates/emmylua_ls/src/handlers/test_lib/mod.rs +++ b/crates/emmylua_ls/src/handlers/test_lib/mod.rs @@ -350,4 +350,28 @@ impl ProviderVirtualWorkspace { dbg!(&data); Some(result) } + + pub fn check_rename(&mut self, block_str: &str, new_name: String, len: usize) -> bool { + let content = Self::handle_file_content(block_str); + let Some((content, position)) = content else { + return false; + }; + let file_id = self.def(&content); + let result = rename(&self.analysis, file_id, position, new_name.clone()); + let Some(result) = result else { + return false; + }; + // dbg!(&result); + if let Some(changes) = result.changes { + let mut count = 0; + for (_, edits) in changes { + count += edits.len(); + } + if count != len { + return false; + } + } + + true + } } From 3bdf1b8a14f7071b9e6116f0d25994cec5973f11 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 15:01:17 +0800 Subject: [PATCH 15/54] fix spell check --- .../src/diagnostic/test/assign_type_mismatch_test.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs index a88d8a9dc..e9e401a47 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs @@ -950,7 +950,7 @@ return t } #[test] - fn test_tabe_field_type_mismatch() { + fn test_table_field_type_mismatch() { let mut ws = VirtualWorkspace::new(); assert!(!ws.check_code_for( DiagnosticCode::AssignTypeMismatch, From 04d313577c6d623b14d2cb4bb83493b2e7508cfc Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 15:30:54 +0800 Subject: [PATCH 16/54] optimize rename --- crates/emmylua_ls/src/handlers/rename/mod.rs | 15 +++++----- .../src/handlers/rename/rename_member.rs | 28 ++++++++++++----- .../src/handlers/test/rename_test.rs | 30 ++++++++++++++++++- .../emmylua_ls/src/handlers/test_lib/mod.rs | 1 + 4 files changed, 57 insertions(+), 17 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/rename/mod.rs b/crates/emmylua_ls/src/handlers/rename/mod.rs index 3b4b8d788..63c6338bf 100644 --- a/crates/emmylua_ls/src/handlers/rename/mod.rs +++ b/crates/emmylua_ls/src/handlers/rename/mod.rs @@ -5,7 +5,7 @@ mod rename_type; use std::collections::HashMap; use emmylua_code_analysis::{LuaCompilation, LuaSemanticDeclId, SemanticDeclLevel, SemanticModel}; -use emmylua_parser::{LuaAstNode, LuaLiteralExpr, LuaSyntaxToken, LuaTableField, LuaTokenKind}; +use emmylua_parser::{LuaAstNode, LuaLiteralExpr, LuaSyntaxNode, LuaSyntaxToken, LuaTokenKind}; use lsp_types::{ ClientCapabilities, OneOf, PrepareRenameResponse, RenameOptions, RenameParams, ServerCapabilities, TextDocumentPositionParams, WorkspaceEdit, @@ -54,7 +54,9 @@ pub async fn on_prepare_rename_handler( let token = match root.syntax().token_at_offset(position_offset) { TokenAtOffset::Single(token) => token, TokenAtOffset::Between(left, right) => { - if left.kind() == LuaTokenKind::TkName.into() { + if left.kind() == LuaTokenKind::TkName.into() + || left.kind() == LuaTokenKind::TkInt.into() + { left } else { right @@ -118,10 +120,7 @@ fn rename_references( ) -> Option { let mut result = HashMap::new(); let semantic_decl = match try_get_table_field(token.clone()) { - Some(table_field) => semantic_model.find_decl( - table_field.syntax().clone().into(), - SemanticDeclLevel::NoTrace, - ), + Some(node) => semantic_model.find_decl(node.into(), SemanticDeclLevel::NoTrace), None => semantic_model.find_decl(token.into(), SemanticDeclLevel::NoTrace), }?; @@ -169,10 +168,10 @@ fn rename_references( }) } -fn try_get_table_field(token: LuaSyntaxToken) -> Option { +fn try_get_table_field(token: LuaSyntaxToken) -> Option { let parent = token.parent()?; let literal_expr = LuaLiteralExpr::cast(parent)?; - literal_expr.get_parent::() + literal_expr.syntax().parent() } pub struct RenameCapabilities; diff --git a/crates/emmylua_ls/src/handlers/rename/rename_member.rs b/crates/emmylua_ls/src/handlers/rename/rename_member.rs index f1570a6d4..0674400da 100644 --- a/crates/emmylua_ls/src/handlers/rename/rename_member.rs +++ b/crates/emmylua_ls/src/handlers/rename/rename_member.rs @@ -4,8 +4,8 @@ use emmylua_code_analysis::{ LuaCompilation, LuaMemberId, LuaSemanticDeclId, SemanticDeclLevel, SemanticModel, }; use emmylua_parser::{ - LuaAst, LuaAstNode, LuaAstToken, LuaIndexToken, LuaLiteralExpr, LuaNameToken, LuaSyntaxNode, - LuaTokenKind, + LuaAst, LuaAstNode, LuaAstToken, LuaIndexToken, LuaLiteralExpr, LuaNameToken, LuaNumberToken, + LuaSyntaxNode, LuaTokenKind, }; use lsp_types::Uri; @@ -72,12 +72,24 @@ fn get_member_name_token_lsp_range( // 此时可能是 [] 访问 if let Some(_) = node.token::() { - let literal = node.child::()?.get_literal()?; - if matches!( - literal.get_token_kind(), - LuaTokenKind::TkInt | LuaTokenKind::TkString - ) { - return document.to_lsp_range(literal.get_range()); + match node { + LuaAst::LuaDocTagField(tag) => { + if let Some(token) = tag.token::() { + if matches!(token.get_token_kind(), LuaTokenKind::TkInt) { + return document.to_lsp_range(token.get_range()); + } + return document.to_lsp_range(token.get_range()); + } + } + _ => { + let literal = node.child::()?.get_literal()?; + if matches!( + literal.get_token_kind(), + LuaTokenKind::TkInt | LuaTokenKind::TkString + ) { + return document.to_lsp_range(literal.get_range()); + } + } } } diff --git a/crates/emmylua_ls/src/handlers/test/rename_test.rs b/crates/emmylua_ls/src/handlers/test/rename_test.rs index 2fd60ef5a..9aaa473d0 100644 --- a/crates/emmylua_ls/src/handlers/test/rename_test.rs +++ b/crates/emmylua_ls/src/handlers/test/rename_test.rs @@ -5,7 +5,7 @@ mod tests { #[test] fn test_int_key() { let mut ws = ProviderVirtualWorkspace::new(); - let result = ws.check_rename( + assert!(ws.check_rename( r#" local export = { [1] = 1, @@ -15,6 +15,34 @@ mod tests { "#, "2".to_string(), 2, + )); + + assert!(ws.check_rename( + r#" + local export = { + [1] = 1, + } + + export[1] = 2 + "#, + "2".to_string(), + 2, + )); + } + + #[test] + fn test_int_key_in_class() { + let mut ws = ProviderVirtualWorkspace::new(); + let result = ws.check_rename( + r#" + ---@class Test + ---@field [1] number + local Test = {} + + Test[1] = 2 + "#, + "2".to_string(), + 2, ); assert!(result); } diff --git a/crates/emmylua_ls/src/handlers/test_lib/mod.rs b/crates/emmylua_ls/src/handlers/test_lib/mod.rs index b38d8378b..43ebe1616 100644 --- a/crates/emmylua_ls/src/handlers/test_lib/mod.rs +++ b/crates/emmylua_ls/src/handlers/test_lib/mod.rs @@ -14,6 +14,7 @@ use crate::{ code_actions::code_action, completion::{completion, completion_resolve}, inlay_hint::inlay_hint, + rename::rename, semantic_token::semantic_token, signature_helper::signature_help, }, From 76735c1b54c6799f657e14950367ea6f2755a53d Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 17:52:17 +0800 Subject: [PATCH 17/54] =?UTF-8?q?feature:=20=E7=B4=A2=E5=BC=95=E6=88=90?= =?UTF-8?q?=E5=91=98=E5=85=81=E8=AE=B8=E5=AE=9A=E4=B9=89=E4=B8=80=E4=B8=AA?= =?UTF-8?q?=E5=88=AB=E5=90=8D,=20=E8=A1=A5=E5=85=A8=E6=97=B6=E5=B0=86?= =?UTF-8?q?=E4=BD=BF=E7=94=A8=E8=AF=A5=E5=88=AB=E5=90=8D=E4=BD=9C=E4=B8=BA?= =?UTF-8?q?=E6=98=BE=E7=A4=BA?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 如果注释以 [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] } ``` --- crates/emmylua_ls/locales/misc.yaml | 5 + .../add_completions/add_decl_completion.rs | 8 +- .../add_completions/add_member_completion.rs | 107 +++++++++++++++--- .../handlers/completion/completion_data.rs | 32 +++--- .../completion/providers/member_provider.rs | 8 +- .../src/handlers/completion/providers/mod.rs | 2 +- .../handlers/completion/resolve_completion.rs | 20 ++-- .../src/handlers/test/completion_test.rs | 19 ++++ 8 files changed, 145 insertions(+), 56 deletions(-) create mode 100644 crates/emmylua_ls/locales/misc.yaml diff --git a/crates/emmylua_ls/locales/misc.yaml b/crates/emmylua_ls/locales/misc.yaml new file mode 100644 index 000000000..363395875 --- /dev/null +++ b/crates/emmylua_ls/locales/misc.yaml @@ -0,0 +1,5 @@ +_version: 2 +completion.index %{label}: + en: index %{label} + zh_CN: 索引 %{label} + zh_HK: 索引 %{label} \ No newline at end of file diff --git a/crates/emmylua_ls/src/handlers/completion/add_completions/add_decl_completion.rs b/crates/emmylua_ls/src/handlers/completion/add_completions/add_decl_completion.rs index 50cfe653f..9cf2099bd 100644 --- a/crates/emmylua_ls/src/handlers/completion/add_completions/add_decl_completion.rs +++ b/crates/emmylua_ls/src/handlers/completion/add_completions/add_decl_completion.rs @@ -18,15 +18,11 @@ 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, - ), + data: CompletionData::from_property_owner_id(builder, decl_id.into(), overload_count), label_details: Some(lsp_types::CompletionItemLabelDetails { detail: get_detail(builder, &typ, CallDisplay::None), description: get_description(builder, &typ), diff --git a/crates/emmylua_ls/src/handlers/completion/add_completions/add_member_completion.rs b/crates/emmylua_ls/src/handlers/completion/add_completions/add_member_completion.rs index 95579f38c..a73706edc 100644 --- a/crates/emmylua_ls/src/handlers/completion/add_completions/add_member_completion.rs +++ b/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, + overload_count: Option, ) -> Option<()> { if builder.is_cancelled() { return None; @@ -58,9 +58,9 @@ 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; } @@ -68,18 +68,9 @@ pub fn add_member_completion( // 附加数据, 用于在`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 { + 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 { + 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::().is_ok() || content.parse::().is_ok() { + return None; + } + + Some(content.to_string()) +} diff --git a/crates/emmylua_ls/src/handlers/completion/completion_data.rs b/crates/emmylua_ls/src/handlers/completion/completion_data.rs index d2cccab4e..4af64bbb8 100644 --- a/crates/emmylua_ls/src/handlers/completion/completion_data.rs +++ b/crates/emmylua_ls/src/handlers/completion/completion_data.rs @@ -9,7 +9,7 @@ pub struct CompletionData { pub field_id: FileId, pub typ: CompletionDataType, /// Total count of function overloads - pub function_overload_count: Option, + pub overload_count: Option, } #[allow(unused)] @@ -17,12 +17,12 @@ impl CompletionData { pub fn from_property_owner_id( builder: &CompletionBuilder, id: LuaSemanticDeclId, - function_overload_count: Option, + overload_count: Option, ) -> Option { 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, + overload_count: Option, ) -> Option { 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, +// overload_count: Option, // } // 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(); diff --git a/crates/emmylua_ls/src/handlers/completion/providers/member_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/member_provider.rs index 639208117..09cf0ac64 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/member_provider.rs +++ b/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; diff --git a/crates/emmylua_ls/src/handlers/completion/providers/mod.rs b/crates/emmylua_ls/src/handlers/completion/providers/mod.rs index 2a4760a13..ec56d04b2 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/mod.rs +++ b/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)); } } diff --git a/crates/emmylua_ls/src/handlers/completion/resolve_completion.rs b/crates/emmylua_ls/src/handlers/completion/resolve_completion.rs index 5a4cc02e9..e1801b620 100644 --- a/crates/emmylua_ls/src/handlers/completion/resolve_completion.rs +++ b/crates/emmylua_ls/src/handlers/completion/resolve_completion.rs @@ -22,10 +22,7 @@ pub fn resolve_completion( let hover_builder = build_hover_content_for_completion(compilation, semantic_model, db, property_id); if let Some(mut hover_builder) = hover_builder { - update_function_signature_info( - &mut hover_builder, - completion_data.function_overload_count, - ); + update_function_signature_info(&mut hover_builder, completion_data.overload_count); if client_id.is_vscode() { build_vscode_completion_item(completion_item, hover_builder, None); } else { @@ -37,10 +34,7 @@ pub fn resolve_completion( let hover_builder = build_hover_content_for_completion(compilation, semantic_model, db, property_id); if let Some(mut hover_builder) = hover_builder { - update_function_signature_info( - &mut hover_builder, - completion_data.function_overload_count, - ); + update_function_signature_info(&mut hover_builder, completion_data.overload_count); if client_id.is_vscode() { build_vscode_completion_item(completion_item, hover_builder, Some(index)); } else { @@ -55,19 +49,19 @@ pub fn resolve_completion( pub fn update_function_signature_info( hover_builder: &mut HoverBuilder, - function_overload_count: Option, + overload_count: Option, ) { - 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); } } } diff --git a/crates/emmylua_ls/src/handlers/test/completion_test.rs b/crates/emmylua_ls/src/handlers/test/completion_test.rs index 6a4616b59..34949e689 100644 --- a/crates/emmylua_ls/src/handlers/test/completion_test.rs +++ b/crates/emmylua_ls/src/handlers/test/completion_test.rs @@ -1076,4 +1076,23 @@ mod tests { },], )); } + + #[test] + fn test_index_key_alias() { + let mut ws = ProviderVirtualWorkspace::new(); + assert!(ws.check_completion( + r#" + local export = { + [1] = 1, -- [nameX] + } + + export. + "#, + vec![VirtualCompletionItem { + label: "nameX".to_string(), + kind: CompletionItemKind::CONSTANT, + ..Default::default() + },], + )); + } } From 57507d94e5cff8e9930b9aa6fe88996cdc0a1f68 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 18:43:51 +0800 Subject: [PATCH 18/54] fix #559 --- .../src/db_index/type/type_ops/mod.rs | 2 +- .../src/semantic/infer/infer_binary/mod.rs | 54 ++++++++++++------- .../src/semantic/infer/test.rs | 25 +++++++++ 3 files changed, 62 insertions(+), 19 deletions(-) diff --git a/crates/emmylua_code_analysis/src/db_index/type/type_ops/mod.rs b/crates/emmylua_code_analysis/src/db_index/type/type_ops/mod.rs index f4ae1f1ef..31fe9faee 100644 --- a/crates/emmylua_code_analysis/src/db_index/type/type_ops/mod.rs +++ b/crates/emmylua_code_analysis/src/db_index/type/type_ops/mod.rs @@ -57,7 +57,7 @@ fn get_real_type_with_depth<'a>( typ: &'a LuaType, depth: u32, ) -> Option<&'a LuaType> { - const MAX_RECURSION_DEPTH: u32 = 100; + const MAX_RECURSION_DEPTH: u32 = 50; if depth >= MAX_RECURSION_DEPTH { return Some(typ); diff --git a/crates/emmylua_code_analysis/src/semantic/infer/infer_binary/mod.rs b/crates/emmylua_code_analysis/src/semantic/infer/infer_binary/mod.rs index e8bf6570d..bb1304aff 100644 --- a/crates/emmylua_code_analysis/src/semantic/infer/infer_binary/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/infer/infer_binary/mod.rs @@ -7,7 +7,7 @@ use smol_str::SmolStr; use crate::{ check_type_compact, db_index::{DbIndex, LuaOperatorMetaMethod, LuaType}, - LuaInferCache, TypeOps, + get_real_type, LuaInferCache, TypeOps, }; use super::{get_custom_type_operator, infer_expr, InferFailReason, InferResult}; @@ -21,18 +21,29 @@ pub fn infer_binary_expr( let (left, right) = expr.get_exprs().ok_or(InferFailReason::None)?; let left_type = infer_expr(db, cache, left.clone())?; let right_type = infer_expr(db, cache, right.clone())?; + let real_left_type = get_real_type(db, &left_type); + let real_right_type = get_real_type(db, &right_type); + let left_type_ref = real_left_type.unwrap_or(&left_type); + let right_type_ref = real_right_type.unwrap_or(&right_type); if op == BinaryOperator::OpOr { - if let Some(ty) = special_or_rule(db, &left_type, &right_type, left, right) { + if let Some(ty) = special_or_rule(db, left_type_ref, right_type_ref, left, right) { return Ok(ty); } } else if !matches!(op, BinaryOperator::OpAnd | BinaryOperator::OpOr) { - if let Some(ty) = infer_union_binary_expr(db, op, &left_type, &right_type) { + if let Some(ty) = infer_union_binary_expr(db, op, left_type_ref, right_type_ref) { return Ok(ty); } } - infer_binary_expr_type(db, left_type, right_type, op) + match (real_left_type.is_some(), real_right_type.is_some()) { + (false, false) => infer_binary_expr_type(db, left_type, right_type, op), + (true, false) => infer_binary_expr_type(db, left_type_ref.clone(), right_type, op), + (false, true) => infer_binary_expr_type(db, left_type, right_type_ref.clone(), op), + (true, true) => { + infer_binary_expr_type(db, left_type_ref.clone(), right_type_ref.clone(), op) + } + } } fn infer_union_binary_expr( @@ -52,11 +63,14 @@ fn infer_union_binary_expr( let mut result = LuaType::Unknown; let types = u.get_types(); for ty in types.iter() { - if let Ok(ty) = if is_left_union { + // 只在实际调用时才 clone，而不是预先 clone + let ty_result = if is_left_union { infer_binary_expr_type(db, ty.clone(), other.clone(), op) } else { infer_binary_expr_type(db, other.clone(), ty.clone(), op) - } { + }; + + if let Ok(ty) = ty_result { result = TypeOps::Union.apply(db, &result, &ty); } } @@ -101,22 +115,26 @@ fn infer_binary_custom_operator( right: &LuaType, op: LuaOperatorMetaMethod, ) -> InferResult { - let operators = get_custom_type_operator(db, left.clone(), op); - if let Some(operators) = operators { - for operator in operators { - let operand = operator.get_operand(db); - if check_type_compact(db, &operand, right).is_ok() { - return operator.get_result(db); + // 先检查 left 是否是自定义类型，避免不必要的 clone + if left.is_custom_type() { + if let Some(operators) = get_custom_type_operator(db, left.clone(), op) { + for operator in operators { + let operand = operator.get_operand(db); + if check_type_compact(db, &operand, right).is_ok() { + return operator.get_result(db); + } } } } - let operators = get_custom_type_operator(db, right.clone(), op); - if let Some(operators) = operators { - for operator in operators { - let operand = operator.get_operand(db); - if check_type_compact(db, &operand, left).is_ok() { - return operator.get_result(db); + // 再检查 right 是否是自定义类型，只在需要时 clone + if right.is_custom_type() { + if let Some(operators) = get_custom_type_operator(db, right.clone(), op) { + for operator in operators { + let operand = operator.get_operand(db); + if check_type_compact(db, &operand, left).is_ok() { + return operator.get_result(db); + } } } } diff --git a/crates/emmylua_code_analysis/src/semantic/infer/test.rs b/crates/emmylua_code_analysis/src/semantic/infer/test.rs index 0b513af5f..582381ab5 100644 --- a/crates/emmylua_code_analysis/src/semantic/infer/test.rs +++ b/crates/emmylua_code_analysis/src/semantic/infer/test.rs @@ -24,4 +24,29 @@ mod test { let expected = ws.ty("AA"); assert_eq!(ty, expected); } + + #[test] + fn test_issue_559() { + let mut ws = VirtualWorkspace::new(); + + ws.def( + r#" + ---@class Origin + ---@operator add(Origin):Origin + + ---@alias AliasType Origin + + ---@type AliasType + local x1 + ---@type AliasType + local x2 + + A = x1 + x2 + "#, + ); + + let ty = ws.expr_ty("A"); + let expected = ws.ty("Origin"); + assert_eq!(ty, expected); + } } From f8d2f41238d1ff5666efcf3d2cdcc4af257e8e2c Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 19:56:31 +0800 Subject: [PATCH 19/54] =?UTF-8?q?update:=20=E5=A2=9E=E5=BC=BA=E7=B4=A2?= =?UTF-8?q?=E5=BC=95=E8=B7=B3=E8=BD=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- crates/emmylua_ls/src/handlers/definition/mod.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/crates/emmylua_ls/src/handlers/definition/mod.rs b/crates/emmylua_ls/src/handlers/definition/mod.rs index b8ee1157f..d07a867e1 100644 --- a/crates/emmylua_ls/src/handlers/definition/mod.rs +++ b/crates/emmylua_ls/src/handlers/definition/mod.rs @@ -51,12 +51,15 @@ pub fn definition( if position_offset > root.syntax().text_range().end() { return None; } - let token = match root.syntax().token_at_offset(position_offset) { TokenAtOffset::Single(token) => token, TokenAtOffset::Between(left, right) => { if left.kind() == LuaTokenKind::TkName.into() { left + } else if left.kind() == LuaTokenKind::TkLeftBracket.into() + && right.kind() == LuaTokenKind::TkInt.into() + { + left } else { right } From 1842419802f93b26bf3d0763671cdfc02e67be62 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 19:57:22 +0800 Subject: [PATCH 20/54] fix diagnostic DuplicateDocField --- .../src/diagnostic/checker/duplicate_field.rs | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/duplicate_field.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/duplicate_field.rs index a25f0b9ed..839bab5a3 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/duplicate_field.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/duplicate_field.rs @@ -1,7 +1,7 @@ use std::collections::{HashMap, HashSet}; use emmylua_parser::{ - LuaAstNode, LuaDocTagField, LuaIndexExpr, LuaStat, LuaSyntaxKind, LuaSyntaxNode, + LuaAstNode, LuaDocTagClass, LuaDocTagField, LuaIndexExpr, LuaStat, LuaSyntaxKind, LuaSyntaxNode, }; use crate::{ @@ -60,6 +60,16 @@ fn get_decl_set(semantic_model: &SemanticModel) -> Option> { } } + let root = semantic_model.get_root(); + for tag_class in root.descendants::() { + if let Some(class_name) = tag_class.get_name_token() { + type_decl_id_set.insert(DeclInfo { + id: LuaTypeDeclId::new(class_name.get_name_text()), + is_require: false, + }); + } + } + Some(type_decl_id_set) } From 42d287ace2fab8a4db8226267feb05f019673211 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 19:59:10 +0800 Subject: [PATCH 21/54] =?UTF-8?q?feature:=20=E7=B4=A2=E5=BC=95=E8=AE=BF?= =?UTF-8?q?=E9=97=AE=E7=8E=B0=E5=9C=A8=E4=BC=9A=E5=9C=A8=20hint=20?= =?UTF-8?q?=E6=98=BE=E7=A4=BA=E5=88=AB=E5=90=8D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../add_completions/add_member_completion.rs | 11 +--- .../completion/add_completions/mod.rs | 1 + .../emmylua_ls/src/handlers/completion/mod.rs | 1 + .../handlers/inlay_hint/build_inlay_hint.rs | 58 +++++++++++++++++++ crates/emmylua_ls/src/handlers/rename/mod.rs | 4 +- .../src/handlers/test/inlay_hint_test.rs | 16 +++++ 6 files changed, 81 insertions(+), 10 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/completion/add_completions/add_member_completion.rs b/crates/emmylua_ls/src/handlers/completion/add_completions/add_member_completion.rs index a73706edc..8c30a344b 100644 --- a/crates/emmylua_ls/src/handlers/completion/add_completions/add_member_completion.rs +++ b/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 { - 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 { +pub fn extract_index_member_alias(db: &DbIndex, member_info: &LuaMemberInfo) -> Option { 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 diff --git a/crates/emmylua_ls/src/handlers/completion/add_completions/mod.rs b/crates/emmylua_ls/src/handlers/completion/add_completions/mod.rs index 330fd9ea6..07d692141 100644 --- a/crates/emmylua_ls/src/handlers/completion/add_completions/mod.rs +++ b/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}; diff --git a/crates/emmylua_ls/src/handlers/completion/mod.rs b/crates/emmylua_ls/src/handlers/completion/mod.rs index 92b40d84b..a3fdcd484 100644 --- a/crates/emmylua_ls/src/handlers/completion/mod.rs +++ b/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}; diff --git a/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs b/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs index e6577462a..7f4103441 100644 --- a/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs +++ b/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 { 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, + 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(()) +} diff --git a/crates/emmylua_ls/src/handlers/rename/mod.rs b/crates/emmylua_ls/src/handlers/rename/mod.rs index 63c6338bf..0b521312a 100644 --- a/crates/emmylua_ls/src/handlers/rename/mod.rs +++ b/crates/emmylua_ls/src/handlers/rename/mod.rs @@ -119,7 +119,7 @@ fn rename_references( new_name: String, ) -> Option { 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 { +fn get_literal_expr_parent(token: LuaSyntaxToken) -> Option { let parent = token.parent()?; let literal_expr = LuaLiteralExpr::cast(parent)?; literal_expr.syntax().parent() diff --git a/crates/emmylua_ls/src/handlers/test/inlay_hint_test.rs b/crates/emmylua_ls/src/handlers/test/inlay_hint_test.rs index 4e7e83ae7..c2e0e44a2 100644 --- a/crates/emmylua_ls/src/handlers/test/inlay_hint_test.rs +++ b/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); + } } From c3455622a8da21c9ce1fd9d015cc036512bb0386 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 29 Jun 2025 21:18:38 +0800 Subject: [PATCH 22/54] =?UTF-8?q?=E4=BC=98=E5=8C=96member=5Finfo=E6=90=9C?= =?UTF-8?q?=E7=B4=A2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/diagnostic/checker/check_field.rs | 39 +- .../infer/infer_call/infer_setmetatable.rs | 32 +- .../src/semantic/member/find_members.rs | 352 ++++++++++++------ .../src/semantic/member/mod.rs | 11 +- .../emmylua_code_analysis/src/semantic/mod.rs | 10 + .../emmylua_ls/src/handlers/completion/mod.rs | 2 +- .../definition/goto_def_definition.rs | 18 +- .../src/handlers/hover/find_origin.rs | 10 +- .../handlers/inlay_hint/build_inlay_hint.rs | 12 +- 9 files changed, 318 insertions(+), 168 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs index 199f05734..6295f52a9 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs @@ -317,26 +317,41 @@ fn is_valid_member( } if members.is_empty() { // 当没有任何成员信息且是 enum 类型时, 需要检查参数是否为自己 - if let LuaType::Ref(id) | LuaType::Def(id) = prefix_type { - if let Some(decl) = semantic_model.get_db().get_type_index().get_type_decl(&id) - { - if decl.is_enum() { - if key_types.iter().any(|typ| match typ { - LuaType::Ref(key_id) | LuaType::Def(key_id) => id == *key_id, - _ => false, - }) { - return Some(()); - } - } - } + if check_enum_self_reference(semantic_model, &prefix_type, &key_types).is_some() { + return Some(()); } } + } else { + if check_enum_self_reference(semantic_model, &prefix_type, &key_types).is_some() { + return Some(()); + } } } None } +/// 检查枚举类型的自引用 +fn check_enum_self_reference( + semantic_model: &SemanticModel, + prefix_type: &LuaType, + key_types: &HashSet, +) -> Option<()> { + if let LuaType::Ref(id) | LuaType::Def(id) = prefix_type { + if let Some(decl) = semantic_model.get_db().get_type_index().get_type_decl(&id) { + if decl.is_enum() { + if key_types.iter().any(|typ| match typ { + LuaType::Ref(key_id) | LuaType::Def(key_id) => *id == *key_id, + _ => false, + }) { + return Some(()); + } + } + } + } + None +} + fn get_prefix_types(prefix_typ: &LuaType) -> HashSet { let mut type_set = HashSet::new(); let mut stack = vec![prefix_typ.clone()]; diff --git a/crates/emmylua_code_analysis/src/semantic/infer/infer_call/infer_setmetatable.rs b/crates/emmylua_code_analysis/src/semantic/infer/infer_call/infer_setmetatable.rs index 99f601280..10a40fd58 100644 --- a/crates/emmylua_code_analysis/src/semantic/infer/infer_call/infer_setmetatable.rs +++ b/crates/emmylua_code_analysis/src/semantic/infer/infer_call/infer_setmetatable.rs @@ -2,8 +2,11 @@ use emmylua_parser::{LuaAstNode, LuaCallExpr, LuaExpr, LuaIndexKey, LuaTableExpr use crate::{ infer_expr, - semantic::{infer::InferResult, member::find_members}, - DbIndex, InFiled, InferFailReason, LuaInferCache, LuaType, + semantic::{ + infer::InferResult, + member::{find_members, find_members_with_key}, + }, + DbIndex, InFiled, InferFailReason, LuaInferCache, LuaMemberKey, LuaType, }; pub fn infer_setmetatable_call( @@ -55,20 +58,19 @@ fn meta_type_contain_table( meta_type: LuaType, table_expr: LuaTableExpr, ) -> Option { - let meta_members = find_members(db, &meta_type)?; + let meta_members = + find_members_with_key(db, &meta_type, LuaMemberKey::Name("__index".into()), true)?; for member in meta_members { - if member.key.get_name() == Some("__index") { - let index_members = find_members(db, &member.typ)?; - let table_type = infer_expr(db, cache, LuaExpr::TableExpr(table_expr.clone())).ok()?; - let table_members = find_members(db, &table_type)?; - // 如果 index_members 包含了 table_members 中的所有成员，则返回 meta_type - if table_members.iter().all(|table_member| { - index_members - .iter() - .any(|index_member| index_member.key.to_path() == table_member.key.to_path()) - }) { - return Some(meta_type); - } + let index_members = find_members(db, &member.typ)?; + let table_type = infer_expr(db, cache, LuaExpr::TableExpr(table_expr.clone())).ok()?; + let table_members = find_members(db, &table_type)?; + // 如果 index_members 包含了 table_members 中的所有成员，则返回 meta_type + if table_members.iter().all(|table_member| { + index_members + .iter() + .any(|index_member| index_member.key.to_path() == table_member.key.to_path()) + }) { + return Some(meta_type); } } None diff --git a/crates/emmylua_code_analysis/src/semantic/member/find_members.rs b/crates/emmylua_code_analysis/src/semantic/member/find_members.rs index 9b4ddb52c..d19133018 100644 --- a/crates/emmylua_code_analysis/src/semantic/member/find_members.rs +++ b/crates/emmylua_code_analysis/src/semantic/member/find_members.rs @@ -14,43 +14,97 @@ use crate::{ use super::{get_buildin_type_map_type_id, FindMembersResult, LuaMemberInfo}; +/// 搜索成员的过滤条件 +#[derive(Debug, Clone)] +pub enum FindMemberFilter { + /// 寻找所有成员 + All, + /// 根据指定的key寻找成员, 是否寻找所有成员 + ByKey(LuaMemberKey, bool), +} + pub fn find_members(db: &DbIndex, prefix_type: &LuaType) -> FindMembersResult { - find_members_guard(db, prefix_type, &mut InferGuard::new()) + find_members_guard( + db, + prefix_type, + &mut InferGuard::new(), + &FindMemberFilter::All, + ) +} + +pub fn find_members_with_key( + db: &DbIndex, + prefix_type: &LuaType, + member_key: LuaMemberKey, + find_all: bool, +) -> FindMembersResult { + find_members_guard( + db, + prefix_type, + &mut InferGuard::new(), + &FindMemberFilter::ByKey(member_key, find_all), + ) } -pub fn find_members_guard( +fn find_members_guard( db: &DbIndex, prefix_type: &LuaType, infer_guard: &mut InferGuard, + filter: &FindMemberFilter, ) -> FindMembersResult { match &prefix_type { LuaType::TableConst(id) => { let member_owner = LuaMemberOwner::Element(id.clone()); - find_normal_members(db, member_owner) + find_normal_members(db, member_owner, filter) } - LuaType::TableGeneric(table_type) => find_table_generic_members(table_type), + LuaType::TableGeneric(table_type) => find_table_generic_members(table_type, filter), LuaType::String | LuaType::Io | LuaType::StringConst(_) => { let type_decl_id = get_buildin_type_map_type_id(&prefix_type)?; - find_custom_type_members(db, &type_decl_id, infer_guard) + find_custom_type_members(db, &type_decl_id, infer_guard, filter) + } + LuaType::Ref(type_decl_id) => { + find_custom_type_members(db, type_decl_id, infer_guard, filter) + } + LuaType::Def(type_decl_id) => { + find_custom_type_members(db, type_decl_id, infer_guard, filter) } - LuaType::Ref(type_decl_id) => find_custom_type_members(db, type_decl_id, infer_guard), - LuaType::Def(type_decl_id) => find_custom_type_members(db, type_decl_id, infer_guard), // // LuaType::Module(_) => todo!(), - LuaType::Tuple(tuple_type) => find_tuple_members(tuple_type), - LuaType::Object(object_type) => find_object_members(object_type), - LuaType::Union(union_type) => find_union_members(db, union_type, infer_guard), + LuaType::Tuple(tuple_type) => find_tuple_members(tuple_type, filter), + LuaType::Object(object_type) => find_object_members(object_type, filter), + LuaType::Union(union_type) => find_union_members(db, union_type, infer_guard, filter), LuaType::Intersection(intersection_type) => { - find_intersection_members(db, intersection_type, infer_guard) + find_intersection_members(db, intersection_type, infer_guard, filter) + } + LuaType::Generic(generic_type) => { + find_generic_members(db, generic_type, infer_guard, filter) } - LuaType::Generic(generic_type) => find_generic_members(db, generic_type, infer_guard), - LuaType::Global => find_global_members(db), - LuaType::Instance(inst) => find_instance_members(db, inst, infer_guard), - LuaType::Namespace(ns) => find_namespace_members(db, ns), + LuaType::Global => find_global_members(db, filter), + LuaType::Instance(inst) => find_instance_members(db, inst, infer_guard, filter), + LuaType::Namespace(ns) => find_namespace_members(db, ns, filter), _ => None, } } -fn find_table_generic_members(table_type: &Vec) -> FindMembersResult { +/// 检查成员是否应该被包含 +fn should_include_member(member_key: &LuaMemberKey, filter: &FindMemberFilter) -> bool { + match filter { + FindMemberFilter::All => true, + FindMemberFilter::ByKey(target_key, _) => member_key == target_key, + } +} + +/// 检查是否应该停止收集更多成员 +fn should_stop_collecting(current_count: usize, filter: &FindMemberFilter) -> bool { + match filter { + FindMemberFilter::All => false, + FindMemberFilter::ByKey(_, find_all) => !find_all && current_count > 0, + } +} + +fn find_table_generic_members( + table_type: &Vec, + filter: &FindMemberFilter, +) -> FindMembersResult { let mut members = Vec::new(); if table_type.len() != 2 { return None; @@ -58,33 +112,49 @@ fn find_table_generic_members(table_type: &Vec) -> FindMembersResult { let key_type = &table_type[0]; let value_type = &table_type[1]; - members.push(LuaMemberInfo { - property_owner_id: None, - key: LuaMemberKey::ExprType(key_type.clone()), - typ: value_type.clone(), - feature: None, - overload_index: None, - }); + let member_key = LuaMemberKey::ExprType(key_type.clone()); + if should_include_member(&member_key, filter) { + members.push(LuaMemberInfo { + property_owner_id: None, + key: member_key, + typ: value_type.clone(), + feature: None, + overload_index: None, + }); + } Some(members) } -fn find_normal_members(db: &DbIndex, member_owner: LuaMemberOwner) -> FindMembersResult { +fn find_normal_members( + db: &DbIndex, + member_owner: LuaMemberOwner, + filter: &FindMemberFilter, +) -> FindMembersResult { let mut members = Vec::new(); let member_index = db.get_member_index(); let owner_members = member_index.get_members(&member_owner)?; + for member in owner_members { - members.push(LuaMemberInfo { - property_owner_id: Some(LuaSemanticDeclId::Member(member.get_id())), - key: member.get_key().clone(), - typ: db - .get_type_index() - .get_type_cache(&member.get_id().into()) - .map(|t| t.as_type().clone()) - .unwrap_or(LuaType::Unknown), - feature: Some(member.get_feature()), - overload_index: None, - }); + let member_key = member.get_key().clone(); + + if should_include_member(&member_key, filter) { + members.push(LuaMemberInfo { + property_owner_id: Some(LuaSemanticDeclId::Member(member.get_id())), + key: member_key, + typ: db + .get_type_index() + .get_type_cache(&member.get_id().into()) + .map(|t| t.as_type().clone()) + .unwrap_or(LuaType::Unknown), + feature: Some(member.get_feature()), + overload_index: None, + }); + + if should_stop_collecting(members.len(), filter) { + break; + } + } } Some(members) @@ -94,15 +164,16 @@ fn find_custom_type_members( db: &DbIndex, type_decl_id: &LuaTypeDeclId, infer_guard: &mut InferGuard, + filter: &FindMemberFilter, ) -> FindMembersResult { infer_guard.check(&type_decl_id).ok()?; let type_index = db.get_type_index(); let type_decl = type_index.get_type_decl(&type_decl_id)?; if type_decl.is_alias() { if let Some(origin) = type_decl.get_alias_origin(db, None) { - return find_members_guard(db, &origin, infer_guard); + return find_members_guard(db, &origin, infer_guard, filter); } else { - return find_members_guard(db, &LuaType::String, infer_guard); + return find_members_guard(db, &LuaType::String, infer_guard, filter); } } @@ -112,25 +183,39 @@ fn find_custom_type_members( member_index.get_members(&LuaMemberOwner::Type(type_decl_id.clone())) { for member in type_members { - members.push(LuaMemberInfo { - property_owner_id: Some(LuaSemanticDeclId::Member(member.get_id())), - key: member.get_key().clone(), - typ: db - .get_type_index() - .get_type_cache(&member.get_id().into()) - .map(|t| t.as_type().clone()) - .unwrap_or(LuaType::Unknown), - feature: Some(member.get_feature()), - overload_index: None, - }); + let member_key = member.get_key().clone(); + + if should_include_member(&member_key, filter) { + members.push(LuaMemberInfo { + property_owner_id: Some(LuaSemanticDeclId::Member(member.get_id())), + key: member_key, + typ: db + .get_type_index() + .get_type_cache(&member.get_id().into()) + .map(|t| t.as_type().clone()) + .unwrap_or(LuaType::Unknown), + feature: Some(member.get_feature()), + overload_index: None, + }); + + if should_stop_collecting(members.len(), filter) { + return Some(members); + } + } } } if type_decl.is_class() { if let Some(super_types) = type_index.get_super_types(&type_decl_id) { for super_type in super_types { - if let Some(super_members) = find_members_guard(db, &super_type, infer_guard) { + if let Some(super_members) = + find_members_guard(db, &super_type, infer_guard, filter) + { members.extend(super_members); + + if should_stop_collecting(members.len(), filter) { + return Some(members); + } } } } @@ -139,31 +224,48 @@ fn find_custom_type_members( Some(members) } -fn find_tuple_members(tuple_type: &LuaTupleType) -> FindMembersResult { +fn find_tuple_members(tuple_type: &LuaTupleType, filter: &FindMemberFilter) -> FindMembersResult { let mut members = Vec::new(); for (idx, typ) in tuple_type.get_types().iter().enumerate() { - members.push(LuaMemberInfo { - property_owner_id: None, - key: LuaMemberKey::Integer((idx + 1) as i64), - typ: typ.clone(), - feature: None, - overload_index: None, - }); + let member_key = LuaMemberKey::Integer((idx + 1) as i64); + + if should_include_member(&member_key, filter) { + members.push(LuaMemberInfo { + property_owner_id: None, + key: member_key, + typ: typ.clone(), + feature: None, + overload_index: None, + }); + + if should_stop_collecting(members.len(), filter) { + break; + } + } } Some(members) } -fn find_object_members(object_type: &LuaObjectType) -> FindMembersResult { +fn find_object_members( + object_type: &LuaObjectType, + filter: &FindMemberFilter, +) -> FindMembersResult { let mut members = Vec::new(); for (key, typ) in object_type.get_fields().iter() { - members.push(LuaMemberInfo { - property_owner_id: None, - key: key.clone(), - typ: typ.clone(), - feature: None, - overload_index: None, - }); + if should_include_member(key, filter) { + members.push(LuaMemberInfo { + property_owner_id: None, + key: key.clone(), + typ: typ.clone(), + feature: None, + overload_index: None, + }); + + if should_stop_collecting(members.len(), filter) { + break; + } + } } Some(members) @@ -173,12 +275,17 @@ fn find_union_members( db: &DbIndex, union_type: &LuaUnionType, infer_guard: &mut InferGuard, + filter: &FindMemberFilter, ) -> FindMembersResult { let mut members = Vec::new(); for typ in union_type.get_types().iter() { - let sub_members = find_members_guard(db, typ, infer_guard); + let sub_members = find_members_guard(db, typ, infer_guard, filter); if let Some(sub_members) = sub_members { members.extend(sub_members); + + if should_stop_collecting(members.len(), filter) { + break; + } } } @@ -189,10 +296,11 @@ fn find_intersection_members( db: &DbIndex, intersection_type: &LuaIntersectionType, infer_guard: &mut InferGuard, + filter: &FindMemberFilter, ) -> FindMembersResult { let mut members = Vec::new(); for typ in intersection_type.get_types().iter() { - let sub_members = find_members_guard(db, typ, infer_guard); + let sub_members = find_members_guard(db, typ, infer_guard, filter); if let Some(sub_members) = sub_members { members.push(sub_members); } @@ -207,23 +315,27 @@ fn find_intersection_members( let mut member_set = HashSet::new(); for member in members.iter().flatten() { - let key = member.key.clone(); - let typ = member.typ.clone(); - if member_set.contains(&key) { + let key = &member.key; + let typ = &member.typ; + if member_set.contains(key) { continue; } member_set.insert(key.clone()); result.push(LuaMemberInfo { property_owner_id: None, - key, - typ, + key: key.clone(), + typ: typ.clone(), feature: None, overload_index: None, }); + + if should_stop_collecting(result.len(), filter) { + break; + } } - return Some(result); + Some(result) } } @@ -232,6 +344,7 @@ fn find_generic_members_from_super_generics( type_decl_id: &LuaTypeDeclId, substitutor: &TypeSubstitutor, infer_guard: &mut InferGuard, + filter: &FindMemberFilter, ) -> Vec { let type_index = db.get_type_index(); @@ -256,7 +369,7 @@ fn find_generic_members_from_super_generics( }) .filter_map(|super_type| { let super_type = instantiate_type_generic(db, &super_type, &substitutor); - find_members_guard(db, &super_type, infer_guard) + find_members_guard(db, &super_type, infer_guard, filter) }) .flatten() .collect() @@ -269,9 +382,10 @@ fn find_generic_members( db: &DbIndex, generic_type: &LuaGenericType, infer_guard: &mut InferGuard, + filter: &FindMemberFilter, ) -> FindMembersResult { let base_type = generic_type.get_base_type(); - let mut members = find_members_guard(db, &base_type, infer_guard)?; + let mut members = find_members_guard(db, &base_type, infer_guard, filter)?; let generic_params = generic_type.get_params(); let substitutor = TypeSubstitutor::from_type_array(generic_params.clone()); @@ -289,28 +403,37 @@ fn find_generic_members( &base_type_decl_id, &substitutor, infer_guard, + filter, )) }; Some(members) } -fn find_global_members(db: &DbIndex) -> FindMembersResult { +fn find_global_members(db: &DbIndex, filter: &FindMemberFilter) -> FindMembersResult { let mut members = Vec::new(); let global_decls = db.get_global_index().get_all_global_decl_ids(); for decl_id in global_decls { if let Some(decl) = db.get_decl_index().get_decl(&decl_id) { - members.push(LuaMemberInfo { - property_owner_id: Some(LuaSemanticDeclId::LuaDecl(decl_id)), - key: LuaMemberKey::Name(decl.get_name().to_string().into()), - typ: db - .get_type_index() - .get_type_cache(&decl_id.into()) - .map(|t| t.as_type().clone()) - .unwrap_or(LuaType::Unknown), - feature: None, - overload_index: None, - }); + let member_key = LuaMemberKey::Name(decl.get_name().to_string().into()); + + if should_include_member(&member_key, filter) { + members.push(LuaMemberInfo { + property_owner_id: Some(LuaSemanticDeclId::LuaDecl(decl_id)), + key: member_key, + typ: db + .get_type_index() + .get_type_cache(&decl_id.into()) + .map(|t| t.as_type().clone()) + .unwrap_or(LuaType::Unknown), + feature: None, + overload_index: None, + }); + + if should_stop_collecting(members.len(), filter) { + break; + } + } } } @@ -321,47 +444,60 @@ fn find_instance_members( db: &DbIndex, inst: &LuaInstanceType, infer_guard: &mut InferGuard, + filter: &FindMemberFilter, ) -> FindMembersResult { let mut members = Vec::new(); let range = inst.get_range(); let member_owner = LuaMemberOwner::Element(range.clone()); - if let Some(normal_members) = find_normal_members(db, member_owner) { + if let Some(normal_members) = find_normal_members(db, member_owner, filter) { members.extend(normal_members); + + if should_stop_collecting(members.len(), filter) { + return Some(members); + } } let origin_type = inst.get_base(); - if let Some(origin_members) = find_members_guard(db, origin_type, infer_guard) { + if let Some(origin_members) = find_members_guard(db, origin_type, infer_guard, filter) { members.extend(origin_members); } Some(members) } -fn find_namespace_members(db: &DbIndex, ns: &str) -> FindMembersResult { +fn find_namespace_members(db: &DbIndex, ns: &str, filter: &FindMemberFilter) -> FindMembersResult { let mut members = Vec::new(); let prefix = format!("{}.", ns); let type_index = db.get_type_index(); let type_decl_id_map = type_index.find_type_decls(FileId::VIRTUAL, &prefix); for (name, type_decl_id) in type_decl_id_map { - if let Some(type_decl_id) = type_decl_id { - let typ = LuaType::Def(type_decl_id.clone()); - let property_owner_id = LuaSemanticDeclId::TypeDecl(type_decl_id); - members.push(LuaMemberInfo { - property_owner_id: Some(property_owner_id), - key: LuaMemberKey::Name(name.into()), - typ, - feature: None, - overload_index: None, - }); - } else { - members.push(LuaMemberInfo { - property_owner_id: None, - key: LuaMemberKey::Name(name.clone().into()), - typ: LuaType::Namespace(SmolStr::new(format!("{}.{}", ns, &name)).into()), - feature: None, - overload_index: None, - }); + let member_key = LuaMemberKey::Name(name.clone().into()); + + if should_include_member(&member_key, filter) { + if let Some(type_decl_id) = type_decl_id { + let typ = LuaType::Def(type_decl_id.clone()); + let property_owner_id = LuaSemanticDeclId::TypeDecl(type_decl_id); + members.push(LuaMemberInfo { + property_owner_id: Some(property_owner_id), + key: member_key, + typ, + feature: None, + overload_index: None, + }); + } else { + members.push(LuaMemberInfo { + property_owner_id: None, + key: member_key, + typ: LuaType::Namespace(SmolStr::new(format!("{}.{}", ns, &name)).into()), + feature: None, + overload_index: None, + }); + } + + if should_stop_collecting(members.len(), filter) { + break; + } } } diff --git a/crates/emmylua_code_analysis/src/semantic/member/mod.rs b/crates/emmylua_code_analysis/src/semantic/member/mod.rs index 6ef039e7a..439d947ab 100644 --- a/crates/emmylua_code_analysis/src/semantic/member/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/member/mod.rs @@ -11,7 +11,7 @@ use crate::{ }; use emmylua_parser::{LuaAssignStat, LuaAstNode, LuaSyntaxKind, LuaTableExpr, LuaTableField}; pub use find_index::find_index_operations; -pub use find_members::find_members; +pub use find_members::{find_members, find_members_with_key}; pub use get_member_map::get_member_map; pub use infer_raw_member::infer_raw_member_type; @@ -139,11 +139,10 @@ fn resolve_table_field_through_type_inference( let field_key = table_field.get_field_key()?; let key = LuaMemberKey::from_index_key(db, infer_config, &field_key).ok()?; - let member_infos = find_members(db, &table_type)?; + let member_infos = find_members_with_key(db, &table_type, key, false)?; member_infos - .iter() - .find(|m| m.key == key)? - .property_owner_id - .clone() + .first() + .cloned() + .and_then(|m| m.property_owner_id) } diff --git a/crates/emmylua_code_analysis/src/semantic/mod.rs b/crates/emmylua_code_analysis/src/semantic/mod.rs index f65ad9c6d..7eba7ff19 100644 --- a/crates/emmylua_code_analysis/src/semantic/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/mod.rs @@ -39,6 +39,7 @@ use type_check::is_sub_type_of; pub use visibility::check_export_visibility; use visibility::check_visibility; +use crate::semantic::member::find_members_with_key; use crate::{db_index::LuaTypeDeclId, Emmyrc, LuaDocument, LuaSemanticDeclId}; use crate::{ db_index::{DbIndex, LuaType}, @@ -120,6 +121,15 @@ impl<'a> SemanticModel<'a> { find_members(self.db, prefix_type) } + pub fn get_member_info_with_key( + &self, + prefix_type: &LuaType, + member_key: LuaMemberKey, + find_all: bool, + ) -> Option> { + find_members_with_key(self.db, prefix_type, member_key, find_all) + } + pub fn get_member_info_map( &self, prefix_type: &LuaType, diff --git a/crates/emmylua_ls/src/handlers/completion/mod.rs b/crates/emmylua_ls/src/handlers/completion/mod.rs index a3fdcd484..c83b0b88b 100644 --- a/crates/emmylua_ls/src/handlers/completion/mod.rs +++ b/crates/emmylua_ls/src/handlers/completion/mod.rs @@ -5,6 +5,7 @@ mod data; mod providers; mod resolve_completion; +pub use add_completions::extract_index_member_alias; use completion_builder::CompletionBuilder; use completion_data::CompletionData; use emmylua_code_analysis::{EmmyLuaAnalysis, FileId}; @@ -18,7 +19,6 @@ 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}; diff --git a/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs b/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs index 0decc44ba..b27757a4c 100644 --- a/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs +++ b/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs @@ -264,14 +264,7 @@ pub fn find_instance_table_member( let table_field = LuaTableField::cast(table_field_node)?; let table_expr = table_field.get_parent::()?; let typ = semantic_model.infer_table_should_be(table_expr)?; - let member_infos = semantic_model.get_member_infos(&typ)?; - return Some( - member_infos - .iter() - .filter(|m| m.key == *member_key) - .cloned() - .collect(), - ); + return semantic_model.get_member_info_with_key(&typ, member_key.clone(), true); } _ => {} } @@ -302,14 +295,7 @@ fn find_member_in_table_const( .infer_expr(LuaExpr::TableExpr(table_expr)) .ok()?; - let member_infos = semantic_model.get_member_infos(&typ)?; - Some( - member_infos - .iter() - .filter(|m| m.key == *member_key) - .cloned() - .collect(), - ) + semantic_model.get_member_info_with_key(&typ, member_key.clone(), true) } /// 是否对 member 启动追踪 diff --git a/crates/emmylua_ls/src/handlers/hover/find_origin.rs b/crates/emmylua_ls/src/handlers/hover/find_origin.rs index b716da063..954605feb 100644 --- a/crates/emmylua_ls/src/handlers/hover/find_origin.rs +++ b/crates/emmylua_ls/src/handlers/hover/find_origin.rs @@ -245,13 +245,11 @@ fn resolve_table_field_through_type_inference( let field_key = table_field.get_field_key()?; let key = semantic_model.get_member_key(&field_key)?; - let member_infos = semantic_model.get_member_infos(&table_type)?; - + let member_infos = semantic_model.get_member_info_with_key(&table_type, key, false)?; member_infos - .iter() - .find(|m| m.key == key)? - .property_owner_id - .clone() + .first() + .cloned() + .and_then(|m| m.property_owner_id) } pub fn replace_semantic_type( diff --git a/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs b/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs index 7f4103441..f6f437419 100644 --- a/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs +++ b/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs @@ -6,8 +6,8 @@ use emmylua_code_analysis::{ LuaOperatorMetaMethod, LuaSemanticDeclId, LuaType, SemanticModel, }; use emmylua_parser::{ - LuaAst, LuaAstNode, LuaCallExpr, LuaExpr, LuaFuncStat, LuaIndexExpr, LuaLocalFuncStat, - LuaLocalName, LuaLocalStat, LuaStat, LuaSyntaxId, LuaVarExpr, + LuaAst, LuaAstNode, LuaCallExpr, LuaExpr, LuaFuncStat, LuaIndexExpr, LuaIndexKey, + LuaLocalFuncStat, LuaLocalName, LuaLocalStat, LuaStat, LuaSyntaxId, LuaVarExpr, }; use emmylua_parser::{LuaAstToken, LuaTokenKind}; use lsp_types::{InlayHint, InlayHintKind, InlayHintLabel, InlayHintLabelPart, Location}; @@ -628,13 +628,17 @@ fn build_index_expr_hint( // 只处理整数索引 let index_key = index_expr.get_index_key()?; + if !matches!(index_key, LuaIndexKey::Integer(_)) { + return Some(()); + } // 获取前缀表达式的类型信息 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 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.get_db(), member_info)?; // 创建 hint From f007436238fc105e5d1eeff7c192cc3079c067d3 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 30 Jun 2025 06:40:42 +0800 Subject: [PATCH 23/54] =?UTF-8?q?hint=20=E7=B4=A2=E5=BC=95=E5=88=AB?= =?UTF-8?q?=E5=90=8D=E5=89=8D=E7=BC=80=E5=AD=97=E7=AC=A6=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs b/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs index f6f437419..d624458de 100644 --- a/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs +++ b/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs @@ -659,7 +659,7 @@ fn build_index_expr_hint( let hint = InlayHint { kind: Some(InlayHintKind::TYPE), label: InlayHintLabel::LabelParts(vec![InlayHintLabelPart { - value: format!(">{}", alias), + value: format!(": {}", alias), location: Some(label_location), ..Default::default() }]), From 1358812e04e662ee84f651f58021d9802491d466 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 30 Jun 2025 07:40:28 +0800 Subject: [PATCH 24/54] update --- .../src/semantic/member/find_members.rs | 23 ++++++++++++------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/crates/emmylua_code_analysis/src/semantic/member/find_members.rs b/crates/emmylua_code_analysis/src/semantic/member/find_members.rs index d19133018..a3e5abf74 100644 --- a/crates/emmylua_code_analysis/src/semantic/member/find_members.rs +++ b/crates/emmylua_code_analysis/src/semantic/member/find_members.rs @@ -14,13 +14,17 @@ use crate::{ use super::{get_buildin_type_map_type_id, FindMembersResult, LuaMemberInfo}; -/// 搜索成员的过滤条件 #[derive(Debug, Clone)] pub enum FindMemberFilter { /// 寻找所有成员 All, - /// 根据指定的key寻找成员, 是否寻找所有成员 - ByKey(LuaMemberKey, bool), + /// 根据指定的key寻找成员 + ByKey { + /// 要搜索的成员key + member_key: LuaMemberKey, + /// 是否寻找所有匹配的成员,为`false`时,找到第一个匹配的成员后停止 + find_all: bool, + }, } pub fn find_members(db: &DbIndex, prefix_type: &LuaType) -> FindMembersResult { @@ -42,7 +46,10 @@ pub fn find_members_with_key( db, prefix_type, &mut InferGuard::new(), - &FindMemberFilter::ByKey(member_key, find_all), + &FindMemberFilter::ByKey { + member_key, + find_all, + }, ) } @@ -86,18 +93,18 @@ fn find_members_guard( } /// 检查成员是否应该被包含 -fn should_include_member(member_key: &LuaMemberKey, filter: &FindMemberFilter) -> bool { +fn should_include_member(key: &LuaMemberKey, filter: &FindMemberFilter) -> bool { match filter { FindMemberFilter::All => true, - FindMemberFilter::ByKey(target_key, _) => member_key == target_key, + FindMemberFilter::ByKey { member_key, .. } => member_key == key, } } /// 检查是否应该停止收集更多成员 fn should_stop_collecting(current_count: usize, filter: &FindMemberFilter) -> bool { match filter { - FindMemberFilter::All => false, - FindMemberFilter::ByKey(_, find_all) => !find_all && current_count > 0, + FindMemberFilter::ByKey { find_all, .. } => !find_all && current_count > 0, + _ => false, } } From 86aec7d5d6e9892f0aeb81397588518b79a00f6e Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 30 Jun 2025 09:32:39 +0800 Subject: [PATCH 25/54] fix enum field assign int --- .../src/diagnostic/test/assign_type_mismatch_test.rs | 8 ++++++-- .../src/semantic/type_check/ref_type.rs | 7 +++++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs index e9e401a47..032170c7d 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/assign_type_mismatch_test.rs @@ -88,7 +88,9 @@ mod tests { "# )); - assert!(!ws.check_code_for_namespace( + // TODO: 解决枚举值运算结果的推断问题 + // 暂时没有好的方式去处理这个警告, 在 ts 中, 枚举值运算的结果不是实际值, 但我们目前的结果是实际值, 所以难以处理 + assert!(ws.check_code_for_namespace( DiagnosticCode::AssignTypeMismatch, r#" ---@enum SubscriberFlags @@ -639,7 +641,9 @@ return t #[test] fn test_issue_295() { let mut ws = VirtualWorkspace::new(); - assert!(!ws.check_code_for( + // TODO: 解决枚举值运算结果的推断问题 + // 暂时没有好的方式去处理这个警告, 在 ts 中, 枚举值运算的结果不是实际值, 但我们目前的结果是实际值, 所以难以处理 + assert!(ws.check_code_for( DiagnosticCode::AssignTypeMismatch, r#" diff --git a/crates/emmylua_code_analysis/src/semantic/type_check/ref_type.rs b/crates/emmylua_code_analysis/src/semantic/type_check/ref_type.rs index 9b7abb2a1..4c93d4b75 100644 --- a/crates/emmylua_code_analysis/src/semantic/type_check/ref_type.rs +++ b/crates/emmylua_code_analysis/src/semantic/type_check/ref_type.rs @@ -97,8 +97,11 @@ fn check_ref_enum( if union_types .get_types() .iter() - .all(|t| matches!(t, LuaType::DocIntegerConst(_))) - && matches!(compact_type, LuaType::Integer) + .all(|t| matches!(t, LuaType::DocIntegerConst(_) | LuaType::IntegerConst(_))) + && matches!( + compact_type, + LuaType::Integer | LuaType::DocIntegerConst(_) | LuaType::IntegerConst(_) + ) { return Ok(()); } From a63312d1401b4e4398711efd3a51041596c65751 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 30 Jun 2025 16:23:31 +0800 Subject: [PATCH 26/54] fix DuplicateSetField --- .../src/diagnostic/checker/duplicate_field.rs | 29 +++++-- .../diagnostic/test/duplicate_field_test.rs | 81 ++++++++++++------- 2 files changed, 75 insertions(+), 35 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/duplicate_field.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/duplicate_field.rs index 839bab5a3..1663c66e9 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/duplicate_field.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/duplicate_field.rs @@ -51,11 +51,22 @@ fn get_decl_set(semantic_model: &SemanticModel) -> Option> { LuaDeclExtra::Local { .. } | LuaDeclExtra::Global { .. } ) { let decl_type = semantic_model.get_type((*decl_id).into()); - if let LuaType::Def(id) = decl_type { - type_decl_id_set.insert(DeclInfo { - id, - is_require: is_require_decl(&decl), - }); + match decl_type { + LuaType::Def(id) => { + type_decl_id_set.insert(DeclInfo { + id, + is_require: is_require_decl(&decl), + }); + } + LuaType::Ref(id) => { + if is_require_decl(&decl) { + type_decl_id_set.insert(DeclInfo { + id, + is_require: true, + }); + } + } + _ => {} } } } @@ -189,12 +200,16 @@ fn check_decl_duplicate_field( Some(()) } +/// 特殊处理: require("a").fun = function() end fn check_one_member( context: &mut DiagnosticContext, semantic_model: &SemanticModel, member: &LuaMember, is_require: bool, ) -> Option<()> { + if !is_require { + return None; + } let key = member.get_key(); let member_id = member.get_id(); let typ = semantic_model.get_type(member.get_id().into()); @@ -244,7 +259,7 @@ fn check_one_member( Some(()) } -/// 检查是否是 .member = newValue +/// 检查是否是 require("a").member = newValue fn check_function_member_is_set( semantic_model: &SemanticModel, node: &LuaSyntaxNode, @@ -257,7 +272,7 @@ fn check_function_member_is_set( .infer_expr(expr.get_prefix_expr()?.into()) .ok()?; match prefix_type { - LuaType::Ref(_) => { + LuaType::Def(_) => { return None; } _ => {} diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/duplicate_field_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/duplicate_field_test.rs index f04f51549..dfcc2634f 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/duplicate_field_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/duplicate_field_test.rs @@ -96,38 +96,38 @@ mod test { } // remove this test - // #[test] - // fn test_duplicate_function_2() { - // let mut ws = VirtualWorkspace::new(); - // ws.def_file( - // "1.lua", - // r#" - // ---@class D31.A - // local A = {} - - // ---@param ... any - // ---@return any, any, any, any - // function A:execute(...) - // end - - // return A - // "#, - // ); - // assert!(!ws.check_code_for( - // DiagnosticCode::DuplicateSetField, - // r#" - // local A = require("1") - - // A.execute = function(trg, ...) - // end - // "# - // )); - // } + #[test] + fn test_duplicate_function_2() { + let mut ws = VirtualWorkspace::new(); + ws.def_file( + "1.lua", + r#" + ---@class D31.A + local A = {} + + ---@param ... any + ---@return any, any, any, any + function A:execute(...) + end + + return A + "#, + ); + assert!(!ws.check_code_for( + DiagnosticCode::DuplicateSetField, + r#" + local A = require("1") + + A.execute = function(trg, ...) + end + "# + )); + } #[test] fn test_duplicate_function_3() { let mut ws = VirtualWorkspace::new(); - assert!(!ws.check_code_for( + assert!(ws.check_code_for( DiagnosticCode::DuplicateSetField, r#" ---@class D31.A @@ -160,4 +160,29 @@ mod test { "# )); } + + #[test] + fn test_return_self() { + let mut ws = VirtualWorkspace::new(); + assert!(ws.check_code_for( + DiagnosticCode::DuplicateSetField, + r#" + ---@class test + local A + + ---@return self + function A.new() + end + + function A:stop() + end + + local a = A.new() + + a.stop = function() + + end + "# + )); + } } From 10007ea018b2bd55b91ddc66487bdef963d4d892 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 30 Jun 2025 16:46:21 +0800 Subject: [PATCH 27/54] fix ParamTypeNotMatch: self --- .../diagnostic/checker/param_type_check.rs | 63 +++++++++++++------ .../diagnostic/test/param_type_check_test.rs | 18 ++++++ 2 files changed, 63 insertions(+), 18 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/param_type_check.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/param_type_check.rs index 0358a15df..2e2d2290e 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/param_type_check.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/param_type_check.rs @@ -221,16 +221,48 @@ pub fn get_call_source_type( semantic_model: &SemanticModel, call_expr: &LuaCallExpr, ) -> Option { - if let Some(LuaExpr::IndexExpr(index_expr)) = call_expr.get_prefix_expr() { - let decl = semantic_model.find_decl( - index_expr.syntax().clone().into(), - SemanticDeclLevel::default(), - )?; + match call_expr.get_prefix_expr()? { + LuaExpr::IndexExpr(index_expr) => { + let decl = semantic_model.find_decl( + index_expr.syntax().clone().into(), + SemanticDeclLevel::default(), + )?; - if let LuaSemanticDeclId::Member(member_id) = decl { - if let Some(LuaSemanticDeclId::Member(member_id)) = - semantic_model.get_member_origin_owner(member_id) - { + if let LuaSemanticDeclId::Member(member_id) = decl { + if let Some(LuaSemanticDeclId::Member(member_id)) = + semantic_model.get_member_origin_owner(member_id) + { + let root = semantic_model + .get_db() + .get_vfs() + .get_syntax_tree(&member_id.file_id)? + .get_red_root(); + let cur_node = member_id.get_syntax_id().to_node_from_root(&root)?; + let index_expr = LuaIndexExpr::cast(cur_node)?; + + return index_expr.get_prefix_expr().map(|prefix_expr| { + semantic_model + .infer_expr(prefix_expr.clone()) + .unwrap_or(LuaType::SelfInfer) + }); + } + } + + return if let Some(prefix_expr) = index_expr.get_prefix_expr() { + let expr_type = semantic_model + .infer_expr(prefix_expr.clone()) + .unwrap_or(LuaType::SelfInfer); + Some(expr_type) + } else { + None + }; + } + LuaExpr::NameExpr(name_expr) => { + let decl = semantic_model.find_decl( + name_expr.syntax().clone().into(), + SemanticDeclLevel::default(), + )?; + if let LuaSemanticDeclId::Member(member_id) = decl { let root = semantic_model .get_db() .get_vfs() @@ -245,16 +277,11 @@ pub fn get_call_source_type( .unwrap_or(LuaType::SelfInfer) }); } - } - return if let Some(prefix_expr) = index_expr.get_prefix_expr() { - let expr_type = semantic_model - .infer_expr(prefix_expr.clone()) - .unwrap_or(LuaType::SelfInfer); - Some(expr_type) - } else { - None - }; + return None; + } + _ => {} } + None } diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs index e91af65d1..83fe6cec2 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs @@ -1116,4 +1116,22 @@ mod test { "# )); } + + #[test] + fn test_self() { + let mut ws = VirtualWorkspace::new(); + assert!(ws.check_code_for( + DiagnosticCode::ParamTypeNotMatch, + r#" + ---@class test + local A + + function A:stop() + end + + local stop = A.stop + stop(A) + "# + )); + } } From 47216bd2920fc6fa711aba26eb2cd40e4a3f028f Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 30 Jun 2025 17:54:57 +0800 Subject: [PATCH 28/54] fix @export UndefinedField --- .../src/diagnostic/checker/check_field.rs | 32 +++++++++++++++++-- .../diagnostic/test/undefined_field_test.rs | 7 ++++ 2 files changed, 37 insertions(+), 2 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs index 6295f52a9..58d20f68a 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/check_field.rs @@ -1,8 +1,9 @@ use std::collections::HashSet; use emmylua_parser::{ - LuaAst, LuaAstNode, LuaElseIfClauseStat, LuaForRangeStat, LuaForStat, LuaIfStat, LuaIndexExpr, - LuaIndexKey, LuaRepeatStat, LuaSyntaxKind, LuaTokenKind, LuaVarExpr, LuaWhileStat, + LuaAst, LuaAstNode, LuaCallExpr, LuaElseIfClauseStat, LuaForRangeStat, LuaForStat, LuaIfStat, + LuaIndexExpr, LuaIndexKey, LuaRepeatStat, LuaSyntaxKind, LuaTokenKind, LuaVarExpr, + LuaWhileStat, }; use crate::{ @@ -509,6 +510,13 @@ fn check_require_table_const_with_export<'a>( ) -> Option<&'a ModuleInfo> { // 获取前缀表达式的语义信息 let prefix_expr = index_expr.get_prefix_expr()?; + if let Some(call_expr) = LuaCallExpr::cast(prefix_expr.syntax().clone()) { + let module_info = parse_require_expr_module_info(semantic_model, &call_expr)?; + if module_info.is_export(semantic_model.get_db()) { + return Some(module_info); + } + } + let semantic_info = semantic_model.get_semantic_info(prefix_expr.syntax().clone().into())?; // 检查是否是声明引用 @@ -529,3 +537,23 @@ fn check_require_table_const_with_export<'a>( } None } + +pub fn parse_require_expr_module_info<'a>( + semantic_model: &'a SemanticModel, + call_expr: &LuaCallExpr, +) -> Option<&'a ModuleInfo> { + let arg_list = call_expr.get_args_list()?; + let first_arg = arg_list.get_args().next()?; + let require_path_type = semantic_model.infer_expr(first_arg.clone()).ok()?; + let module_path: String = match &require_path_type { + LuaType::StringConst(module_path) => module_path.as_ref().to_string(), + _ => { + return None; + } + }; + + semantic_model + .get_db() + .get_module_index() + .find_module(&module_path) +} diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs index e9155cd4a..e8664a933 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs @@ -755,5 +755,12 @@ mod test { a.func() "#, )); + + assert!(!ws.check_code_for( + DiagnosticCode::UndefinedField, + r#" + local a = require("a").ABC + "#, + )); } } From 17e286cfe06b3b2269becb420308c896b0ec1ff0 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 30 Jun 2025 20:18:43 +0800 Subject: [PATCH 29/54] =?UTF-8?q?#region=20=E4=B8=8D=E5=86=8D=E9=AB=98?= =?UTF-8?q?=E4=BA=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/handlers/semantic_token/build_semantic_tokens.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs index 3f3803169..7715c6b31 100644 --- a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs +++ b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs @@ -177,7 +177,7 @@ fn build_tokens_semantic_token( builder.push(token, SemanticTokenType::STRING); } LuaTokenKind::TkDocRegion | LuaTokenKind::TkDocEndRegion => { - builder.push(token, SemanticTokenType::KEYWORD); + builder.push(token, SemanticTokenType::COMMENT); } LuaTokenKind::TkDocStart => { render_doc_at(builder, &token); From d6a8ef8ad6cd03efd08847f52b4528ae2ee3327f Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Tue, 1 Jul 2025 08:00:56 +0800 Subject: [PATCH 30/54] fix did_rename_files --- .../emmylua_ls/src/handlers/workspace/did_rename_files.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/workspace/did_rename_files.rs b/crates/emmylua_ls/src/handlers/workspace/did_rename_files.rs index a86c4b88b..9cf574a4d 100644 --- a/crates/emmylua_ls/src/handlers/workspace/did_rename_files.rs +++ b/crates/emmylua_ls/src/handlers/workspace/did_rename_files.rs @@ -8,7 +8,7 @@ use emmylua_code_analysis::{ file_path_to_uri, read_file_with_encoding, uri_to_file_path, FileId, LuaCompilation, LuaModuleIndex, LuaType, SemanticModel, WorkspaceId, }; -use emmylua_parser::{LuaAstNode, LuaCallExpr, LuaIndexExpr}; +use emmylua_parser::{LuaAstNode, LuaCallExpr}; use lsp_types::{ ApplyWorkspaceEditParams, FileRename, MessageActionItem, MessageType, RenameFilesParams, ShowMessageRequestParams, TextEdit, Uri, WorkspaceEdit, @@ -237,9 +237,9 @@ fn try_convert( changes: &mut HashMap>, current_file_id: FileId, // 当前文件id ) -> Option<()> { - if let Some(_) = call_expr.get_parent::() { - return None; - } + // if let Some(_) = call_expr.get_parent::() { + // return None; + // } let args_list = call_expr.get_args_list()?; let arg_expr = args_list.get_args().next()?; From 24227164fd0189190df2c0298cda09323830fc51 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Tue, 1 Jul 2025 10:09:27 +0800 Subject: [PATCH 31/54] optimize goto_def_definition function --- .../src/handlers/definition/goto_def_definition.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs b/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs index b27757a4c..9c2f108de 100644 --- a/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs +++ b/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs @@ -310,6 +310,11 @@ fn should_trace_member(semantic_model: &SemanticModel, member_id: &LuaMemberId) // 如果成员在返回语句中, 则需要追踪 if LuaReturnStat::can_cast(parent.kind().into()) { return Some(true); + } else { + let typ = semantic_model.get_type(member_id.clone().into()); + if typ.is_signature() { + return Some(true); + } } None } From 8da287e83ee6b6ab484cfca3906a3f70d76444ea Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Tue, 1 Jul 2025 11:28:01 +0800 Subject: [PATCH 32/54] =?UTF-8?q?update=20references:=20=E6=9C=AC=E5=9C=B0?= =?UTF-8?q?=E5=87=BD=E6=95=B0=E7=8E=B0=E5=9C=A8=E8=83=BD=E5=A4=9F=E6=90=9C?= =?UTF-8?q?=E7=B4=A2=E5=AF=BC=E5=87=BA=E7=9A=84=E5=BC=95=E7=94=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../call_hierarchy/build_call_hierarchy.rs | 2 +- .../handlers/code_lens/resolve_code_lens.rs | 2 +- .../emmylua_ls/src/handlers/references/mod.rs | 14 ++- .../handlers/references/reference_seacher.rs | 106 ++++++++++++++++-- crates/emmylua_ls/src/handlers/test/mod.rs | 1 + .../src/handlers/test/references_test.rs | 29 +++++ .../emmylua_ls/src/handlers/test_lib/mod.rs | 14 ++- 7 files changed, 156 insertions(+), 12 deletions(-) create mode 100644 crates/emmylua_ls/src/handlers/test/references_test.rs diff --git a/crates/emmylua_ls/src/handlers/call_hierarchy/build_call_hierarchy.rs b/crates/emmylua_ls/src/handlers/call_hierarchy/build_call_hierarchy.rs index e35de242b..2799bb1d5 100644 --- a/crates/emmylua_ls/src/handlers/call_hierarchy/build_call_hierarchy.rs +++ b/crates/emmylua_ls/src/handlers/call_hierarchy/build_call_hierarchy.rs @@ -100,7 +100,7 @@ pub fn build_incoming_hierarchy( let mut locations = vec![]; match semantic_decl { LuaSemanticDeclId::LuaDecl(decl_id) => { - search_decl_references(semantic_model, decl_id, &mut locations); + search_decl_references(semantic_model, compilation, decl_id, &mut locations); } LuaSemanticDeclId::Member(member_id) => { search_member_references(semantic_model, compilation, member_id, &mut locations); diff --git a/crates/emmylua_ls/src/handlers/code_lens/resolve_code_lens.rs b/crates/emmylua_ls/src/handlers/code_lens/resolve_code_lens.rs index 317aa0acf..fe7235198 100644 --- a/crates/emmylua_ls/src/handlers/code_lens/resolve_code_lens.rs +++ b/crates/emmylua_ls/src/handlers/code_lens/resolve_code_lens.rs @@ -44,7 +44,7 @@ pub fn resolve_code_lens( let file_id = decl_id.file_id; let mut semantic_model = compilation.get_semantic_model(file_id)?; let mut results = Vec::new(); - search_decl_references(&mut semantic_model, decl_id, &mut results); + search_decl_references(&mut semantic_model, compilation, decl_id, &mut results); let ref_count = results.len(); let uri = semantic_model.get_document().get_uri(); let command = make_usage_command(uri, code_lens.range, ref_count, client_id, results); diff --git a/crates/emmylua_ls/src/handlers/references/mod.rs b/crates/emmylua_ls/src/handlers/references/mod.rs index 14d4798a8..1ddae17a5 100644 --- a/crates/emmylua_ls/src/handlers/references/mod.rs +++ b/crates/emmylua_ls/src/handlers/references/mod.rs @@ -1,8 +1,11 @@ mod reference_seacher; use crate::context::ServerContextSnapshot; +use emmylua_code_analysis::{EmmyLuaAnalysis, FileId}; use emmylua_parser::{LuaAstNode, LuaTokenKind}; -use lsp_types::{ClientCapabilities, Location, OneOf, ReferenceParams, ServerCapabilities}; +use lsp_types::{ + ClientCapabilities, Location, OneOf, Position, ReferenceParams, ServerCapabilities, +}; use reference_seacher::search_references; pub use reference_seacher::{search_decl_references, search_member_references}; use rowan::TokenAtOffset; @@ -19,6 +22,15 @@ pub async fn on_references_handler( let analysis = context.analysis.read().await; let file_id = analysis.get_file_id(&uri)?; let position = params.text_document_position.position; + + references(&analysis, file_id, position) +} + +pub fn references( + analysis: &EmmyLuaAnalysis, + file_id: FileId, + position: Position, +) -> Option> { let mut semantic_model = analysis.compilation.get_semantic_model(file_id)?; if !semantic_model.get_emmyrc().references.enable { return None; diff --git a/crates/emmylua_ls/src/handlers/references/reference_seacher.rs b/crates/emmylua_ls/src/handlers/references/reference_seacher.rs index 8627a48bc..0b117ee08 100644 --- a/crates/emmylua_ls/src/handlers/references/reference_seacher.rs +++ b/crates/emmylua_ls/src/handlers/references/reference_seacher.rs @@ -1,11 +1,12 @@ -use std::collections::HashMap; +use std::collections::{HashMap, HashSet}; use emmylua_code_analysis::{ - LuaCompilation, LuaDeclId, LuaMemberId, LuaMemberKey, LuaSemanticDeclId, LuaTypeDeclId, - SemanticDeclLevel, SemanticModel, + DeclReference, LuaCompilation, LuaDeclId, LuaMemberId, LuaMemberKey, LuaSemanticDeclId, + LuaTypeDeclId, SemanticDeclLevel, SemanticModel, }; use emmylua_parser::{ - LuaAst, LuaAstNode, LuaAstToken, LuaNameToken, LuaStringToken, LuaSyntaxNode, LuaSyntaxToken, + LuaAssignStat, LuaAst, LuaAstNode, LuaAstToken, LuaNameToken, LuaStringToken, LuaSyntaxNode, + LuaSyntaxToken, }; use lsp_types::Location; @@ -20,7 +21,7 @@ pub fn search_references( { match semantic_decl { LuaSemanticDeclId::LuaDecl(decl_id) => { - search_decl_references(semantic_model, decl_id, &mut result); + search_decl_references(semantic_model, compilation, decl_id, &mut result); } LuaSemanticDeclId::Member(member_id) => { search_member_references(semantic_model, compilation, member_id, &mut result); @@ -36,11 +37,16 @@ pub fn search_references( fuzzy_search_references(compilation, token, &mut result); } + // 简单过滤, 同行的多个引用只保留一个 + // let filtered_result = filter_duplicate_and_covered_locations(result); + // Some(filtered_result) + Some(result) } pub fn search_decl_references( semantic_model: &SemanticModel, + compilation: &LuaCompilation, decl_id: LuaDeclId, result: &mut Vec, ) -> Option<()> { @@ -58,9 +64,15 @@ pub fn search_decl_references( if let Some(location) = document.to_lsp_location(decl.get_range()) { result.push(location); } + let typ = semantic_model.get_type(decl.get_id().into()); + let is_signature = typ.is_signature(); + for decl_ref in decl_refs { let location = document.to_lsp_location(decl_ref.range.clone())?; result.push(location); + if is_signature { + get_signature_decl_member_references(semantic_model, compilation, result, decl_ref); + } } return Some(()); @@ -119,7 +131,7 @@ pub fn search_member_references( let range = in_filed_syntax_id.value.get_range(); let location = document.to_lsp_location(range)?; result.push(location); - search_member_secondary_references(semantic_model, node, result); + search_member_secondary_references(semantic_model, compilation, node, result); } } @@ -128,6 +140,7 @@ pub fn search_member_references( fn search_member_secondary_references( semantic_model: &SemanticModel, + compilation: &LuaCompilation, node: LuaSyntaxNode, result: &mut Vec, ) -> Option<()> { @@ -141,7 +154,7 @@ fn search_member_secondary_references( .position(|value| value.get_position() == position)?; let var = vars.get(idx)?; let decl_id = LuaDeclId::new(semantic_model.get_file_id(), var.get_position()); - search_decl_references(semantic_model, decl_id, result); + search_decl_references(semantic_model, compilation, decl_id, result); let document = semantic_model.get_document(); let range = document.to_lsp_location(var.get_range())?; result.push(range); @@ -152,7 +165,7 @@ fn search_member_secondary_references( let idx = values.position(|value| value.get_position() == position)?; let name = local_names.get(idx)?; let decl_id = LuaDeclId::new(semantic_model.get_file_id(), name.get_position()); - search_decl_references(semantic_model, decl_id, result); + search_decl_references(semantic_model, compilation, decl_id, result); let document = semantic_model.get_document(); let range = document.to_lsp_location(name.get_range())?; result.push(range); @@ -241,3 +254,80 @@ fn search_type_decl_references( Some(()) } + +fn get_signature_decl_member_references( + semantic_model: &SemanticModel, + compilation: &LuaCompilation, + result: &mut Vec, + decl_ref: &DeclReference, +) -> Option> { + let root = semantic_model.get_root(); + let position = decl_ref.range.start(); + let token = root.syntax().token_at_offset(position).right_biased()?; + let parent = token.parent()?; + + match parent.parent()? { + assign_stat_node if LuaAssignStat::can_cast(assign_stat_node.kind().into()) => { + let assign_stat = LuaAssignStat::cast(assign_stat_node)?; + let (vars, values) = assign_stat.get_var_and_expr_list(); + let idx = values + .iter() + .position(|value| value.get_position() == position)?; + let var = vars.get(idx)?; + let decl_id = semantic_model + .find_decl(var.syntax().clone().into(), SemanticDeclLevel::default())?; + if let LuaSemanticDeclId::Member(member_id) = decl_id { + search_member_references(semantic_model, compilation, member_id, result); + } + } + + _ => {} + } + None +} + +#[allow(unused)] +fn filter_duplicate_and_covered_locations(locations: Vec) -> Vec { + if locations.is_empty() { + return locations; + } + let mut sorted_locations = locations; + sorted_locations.sort_by(|a, b| { + a.uri + .to_string() + .cmp(&b.uri.to_string()) + .then_with(|| a.range.start.line.cmp(&b.range.start.line)) + .then_with(|| b.range.end.line.cmp(&a.range.end.line)) + }); + + let mut result = Vec::new(); + let mut seen_lines_by_uri: HashMap> = HashMap::new(); + + for location in sorted_locations { + let uri_str = location.uri.to_string(); + let seen_lines = seen_lines_by_uri.entry(uri_str).or_default(); + + let start_line = location.range.start.line; + let end_line = location.range.end.line; + + let is_covered = (start_line..=end_line).any(|line| seen_lines.contains(&line)); + + if !is_covered { + for line in start_line..=end_line { + seen_lines.insert(line); + } + result.push(location); + } + } + + // 最终按位置排序 + result.sort_by(|a, b| { + a.uri + .to_string() + .cmp(&b.uri.to_string()) + .then_with(|| a.range.start.line.cmp(&b.range.start.line)) + .then_with(|| a.range.start.character.cmp(&b.range.start.character)) + }); + + result +} diff --git a/crates/emmylua_ls/src/handlers/test/mod.rs b/crates/emmylua_ls/src/handlers/test/mod.rs index 7cd8c8c78..ed95cd3f8 100644 --- a/crates/emmylua_ls/src/handlers/test/mod.rs +++ b/crates/emmylua_ls/src/handlers/test/mod.rs @@ -6,6 +6,7 @@ mod hover_function_test; mod hover_test; mod implementation_test; mod inlay_hint_test; +mod references_test; mod rename_test; mod semantic_token_test; mod signature_helper_test; diff --git a/crates/emmylua_ls/src/handlers/test/references_test.rs b/crates/emmylua_ls/src/handlers/test/references_test.rs new file mode 100644 index 000000000..ad5be9170 --- /dev/null +++ b/crates/emmylua_ls/src/handlers/test/references_test.rs @@ -0,0 +1,29 @@ +#[cfg(test)] +mod tests { + + use crate::handlers::test_lib::ProviderVirtualWorkspace; + + #[test] + fn test_function_references() { + let mut ws = ProviderVirtualWorkspace::new(); + ws.def_file( + "1.lua", + r#" + local flush = require("virtual_0").flush + flush() + "#, + ); + let result = ws.check_references( + r#" + local export = {} + local function flush() + end + export.flush = flush + return export + "#, + ); + assert!(result.is_some()); + let locations = result.unwrap(); + assert!(locations.len() >= 4); + } +} diff --git a/crates/emmylua_ls/src/handlers/test_lib/mod.rs b/crates/emmylua_ls/src/handlers/test_lib/mod.rs index 43ebe1616..222612b36 100644 --- a/crates/emmylua_ls/src/handlers/test_lib/mod.rs +++ b/crates/emmylua_ls/src/handlers/test_lib/mod.rs @@ -20,7 +20,7 @@ use crate::{ }, }; -use super::{hover::hover, implementation::implementation}; +use super::{hover::hover, implementation::implementation, references::references}; /// A virtual workspace for testing. #[allow(unused)] @@ -375,4 +375,16 @@ impl ProviderVirtualWorkspace { true } + + pub fn check_references(&mut self, block_str: &str) -> Option> { + let content = Self::handle_file_content(block_str); + let Some((content, position)) = content else { + return None; + }; + let file_id = self.def(&content); + let result = references(&self.analysis, file_id, position); + // dbg!(&result); + dbg!(&result.as_ref().unwrap().len()); + result + } } From b4977b1b9ef74dc703396f174ece5c4cbcd58369 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Tue, 1 Jul 2025 13:33:00 +0800 Subject: [PATCH 33/54] optimize semantic_tokens --- .../src/handlers/semantic_token/build_semantic_tokens.rs | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs index 7715c6b31..e1ade36bb 100644 --- a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs +++ b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs @@ -397,9 +397,14 @@ fn build_node_semantic_token( return Some(()); } } - _ => {} + _ => { + if !prefix_type.is_function() { + return Some(()); + } + } } } + builder.push(name.syntax(), SemanticTokenType::FUNCTION); } LuaExpr::IndexExpr(index_expr) => { From e6710056d7aa9247309be5c1d44dcb1584eeb73a Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Tue, 1 Jul 2025 20:14:22 +0800 Subject: [PATCH 34/54] optimize auto-require --- .../completion/add_completions/mod.rs | 2 +- .../providers/auto_require_provider.rs | 7 ++++-- .../handlers/references/reference_seacher.rs | 13 ++++++++-- .../src/handlers/test/completion_test.rs | 2 +- .../src/handlers/test/references_test.rs | 24 +++++++++++++++++++ 5 files changed, 42 insertions(+), 6 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/completion/add_completions/mod.rs b/crates/emmylua_ls/src/handlers/completion/add_completions/mod.rs index 07d692141..9c52f7da0 100644 --- a/crates/emmylua_ls/src/handlers/completion/add_completions/mod.rs +++ b/crates/emmylua_ls/src/handlers/completion/add_completions/mod.rs @@ -30,7 +30,7 @@ pub fn check_visibility(builder: &mut CompletionBuilder, id: LuaSemanticDeclId) Some(()) } -fn get_completion_kind(typ: &LuaType) -> CompletionItemKind { +pub fn get_completion_kind(typ: &LuaType) -> CompletionItemKind { if typ.is_function() { return CompletionItemKind::FUNCTION; } else if typ.is_const() { diff --git a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs index a157299a4..dcb5255dd 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/auto_require_provider.rs @@ -7,7 +7,10 @@ use lsp_types::{CompletionItem, Position}; use crate::{ handlers::{ command::make_auto_require, - completion::{completion_builder::CompletionBuilder, completion_data::CompletionData}, + completion::{ + add_completions::get_completion_kind, completion_builder::CompletionBuilder, + completion_data::CompletionData, + }, }, util::{key_name_convert, module_name_convert}, }; @@ -177,7 +180,7 @@ fn try_add_member_completion_items( let completion_item = CompletionItem { label: key_name, - kind: Some(lsp_types::CompletionItemKind::MODULE), + kind: Some(get_completion_kind(&member_info.typ)), label_details: Some(lsp_types::CompletionItemLabelDetails { detail: Some(format!(" (in {})", module_info.full_module_name)), ..Default::default() diff --git a/crates/emmylua_ls/src/handlers/references/reference_seacher.rs b/crates/emmylua_ls/src/handlers/references/reference_seacher.rs index 0b117ee08..16e9432ba 100644 --- a/crates/emmylua_ls/src/handlers/references/reference_seacher.rs +++ b/crates/emmylua_ls/src/handlers/references/reference_seacher.rs @@ -6,7 +6,7 @@ use emmylua_code_analysis::{ }; use emmylua_parser::{ LuaAssignStat, LuaAst, LuaAstNode, LuaAstToken, LuaNameToken, LuaStringToken, LuaSyntaxNode, - LuaSyntaxToken, + LuaSyntaxToken, LuaTableField, }; use lsp_types::Location; @@ -280,7 +280,16 @@ fn get_signature_decl_member_references( search_member_references(semantic_model, compilation, member_id, result); } } - + table_field_node if LuaTableField::can_cast(table_field_node.kind().into()) => { + let table_field = LuaTableField::cast(table_field_node)?; + let decl_id = semantic_model.find_decl( + table_field.syntax().clone().into(), + SemanticDeclLevel::default(), + )?; + if let LuaSemanticDeclId::Member(member_id) = decl_id { + search_member_references(semantic_model, compilation, member_id, result); + } + } _ => {} } None diff --git a/crates/emmylua_ls/src/handlers/test/completion_test.rs b/crates/emmylua_ls/src/handlers/test/completion_test.rs index 34949e689..7bf755b7f 100644 --- a/crates/emmylua_ls/src/handlers/test/completion_test.rs +++ b/crates/emmylua_ls/src/handlers/test/completion_test.rs @@ -928,7 +928,7 @@ mod tests { "#, vec![VirtualCompletionItem { label: "MapName".to_string(), - kind: CompletionItemKind::MODULE, + kind: CompletionItemKind::CLASS, label_detail: Some(" (in aaaa)".to_string()), },], )); diff --git a/crates/emmylua_ls/src/handlers/test/references_test.rs b/crates/emmylua_ls/src/handlers/test/references_test.rs index ad5be9170..604dc462a 100644 --- a/crates/emmylua_ls/src/handlers/test/references_test.rs +++ b/crates/emmylua_ls/src/handlers/test/references_test.rs @@ -26,4 +26,28 @@ mod tests { let locations = result.unwrap(); assert!(locations.len() >= 4); } + + #[test] + fn test_function_references_2() { + let mut ws = ProviderVirtualWorkspace::new(); + ws.def_file( + "1.lua", + r#" + local flush = require("virtual_0").flush + flush() + "#, + ); + let result = ws.check_references( + r#" + local function flush() + end + return { + flush = flush, + } + "#, + ); + assert!(result.is_some()); + let locations = result.unwrap(); + assert!(locations.len() >= 4); + } } From ea9d237cacc1c93d3a839199c6cedb10680f13af Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Tue, 1 Jul 2025 20:14:36 +0800 Subject: [PATCH 35/54] fix #565 --- .../src/diagnostic/checker/cast_type_mismatch.rs | 13 ++++++++++++- .../diagnostic/test/cast_type_mismatch_test.rs | 16 ++++++++++++++++ 2 files changed, 28 insertions(+), 1 deletion(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/cast_type_mismatch.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/cast_type_mismatch.rs index c73398bae..1eeeb7e52 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/cast_type_mismatch.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/cast_type_mismatch.rs @@ -242,7 +242,12 @@ fn expand_type_recursive( LuaType::Union(union_type) => { // 递归展开 union 中的每个类型 let mut expanded_types = Vec::new(); + let mut has_nil = false; for inner_type in union_type.get_types() { + if inner_type.is_nil() { + has_nil = true; + continue; + } if let Some(expanded) = expand_type_recursive(db, inner_type, visited) { match expanded { LuaType::Union(inner_union) => { @@ -260,7 +265,13 @@ fn expand_type_recursive( let expanded_types = expanded_types.into_iter().unique().collect::>(); return match expanded_types.len() { - 0 => Some(LuaType::Unknown), + 0 => { + if has_nil { + Some(LuaType::Nil) + } else { + Some(LuaType::Unknown) + } + } 1 => Some(expanded_types[0].clone().into()), _ => Some(LuaType::Union(LuaUnionType::new(expanded_types).into())), }; diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/cast_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/cast_type_mismatch_test.rs index c76db8f65..788687950 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/cast_type_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/cast_type_mismatch_test.rs @@ -233,4 +233,20 @@ mod tests { "# )); } + + #[test] + fn test_issue_565() { + let mut ws = VirtualWorkspace::new(); + ws.def( + r#" + "#, + ); + assert!(ws.check_code_for( + DiagnosticCode::CastTypeMismatch, + r#" + local a --- @type table? + --- @cast a [integer,integer]? + "# + )); + } } From d5b7b1f1e4f2ca0bc56aaae5332a09ea22e86cb9 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Tue, 1 Jul 2025 20:29:01 +0800 Subject: [PATCH 36/54] fix #567 --- .../diagnostic/checker/check_return_count.rs | 14 ++++++++-- .../test/check_return_count_test.rs | 27 +++++++++++++++++++ 2 files changed, 39 insertions(+), 2 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/check_return_count.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/check_return_count.rs index 1cc686f35..53c40b38e 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/check_return_count.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/check_return_count.rs @@ -270,11 +270,12 @@ fn check_return_count( }; // 计算实际返回的表达式数量并记录多余的范围 - let expr_list = return_stat.get_expr_list(); + let expr_list = return_stat.get_expr_list().collect::>(); let mut total_return_count = 0; + let mut tail_return_nil = false; let mut redundant_ranges = Vec::new(); - for expr in expr_list { + for (index, expr) in expr_list.iter().enumerate() { let expr_type = semantic_model .infer_expr(expr.clone()) .unwrap_or(LuaType::Unknown); @@ -282,10 +283,19 @@ fn check_return_count( LuaType::Variadic(variadic) => { total_return_count += variadic.get_max_len()?; } + LuaType::Nil => { + if index == expr_list.len() - 1 { + tail_return_nil = true; + } + total_return_count += 1; + } _ => total_return_count += 1, }; if max_expected_return_count.is_some() && total_return_count > max_expected_return_count? { + if tail_return_nil && total_return_count - 1 == max_expected_return_count? { + continue; + } redundant_ranges.push(expr.get_range()); } } diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/check_return_count_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/check_return_count_test.rs index 987811c3c..42e600dec 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/check_return_count_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/check_return_count_test.rs @@ -524,4 +524,31 @@ mod tests { "#, )); } + + #[test] + fn test_issue_567() { + let mut ws = VirtualWorkspace::new_with_init_std_lib(); + assert!(ws.check_code_for( + DiagnosticCode::RedundantReturnValue, + r#" + local function fnil() + end + + local f --- @type fun(c: fun()) + f(function() + return fnil() + end) + "#, + )); + + assert!(ws.check_code_for( + DiagnosticCode::RedundantReturnValue, + r#" + --- @return nil + local function f1() + return nil + end + "#, + )); + } } From 06651c436c7c1531f05d4a90fc86fde2d066e135 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Thu, 3 Jul 2025 12:14:29 +0800 Subject: [PATCH 37/54] Some adjustments to the experiential details --- .../providers/table_field_provider.rs | 7 +++- .../src/handlers/definition/goto_function.rs | 11 +++++- .../handlers/inlay_hint/build_inlay_hint.rs | 2 +- .../src/handlers/test/definition_test.rs | 39 +++++++++++++++++++ .../src/handlers/test/inlay_hint_test.rs | 8 ++-- 5 files changed, 59 insertions(+), 8 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs index 8d2e56618..17224df35 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs @@ -98,7 +98,7 @@ fn add_field_key_completion( }; let typ = member_info.typ; - let (label, insert_text) = { + let (label, insert_text, insert_text_format) = { let is_nullable = if typ.is_nullable() { "?" } else { "" }; if in_env(builder, &name, &typ).is_some() { ( @@ -107,7 +107,8 @@ fn add_field_key_completion( name = name, nullable = is_nullable, ), - format!("{name} = {name},", name = name,), + format!("{name} = ${{1:{name}}},", name = name), + Some(InsertTextFormat::SNIPPET), ) } else { // 函数类型不补空格, 留空格让用户触发字符补全 @@ -120,6 +121,7 @@ fn add_field_key_completion( space = space ), format!("{name} ={space}", name = name, space = space), + None, ) } }; @@ -146,6 +148,7 @@ fn add_field_key_completion( data, deprecated, insert_text: Some(insert_text), + insert_text_format, ..Default::default() }; diff --git a/crates/emmylua_ls/src/handlers/definition/goto_function.rs b/crates/emmylua_ls/src/handlers/definition/goto_function.rs index 44f2d8406..9b24c920f 100644 --- a/crates/emmylua_ls/src/handlers/definition/goto_function.rs +++ b/crates/emmylua_ls/src/handlers/definition/goto_function.rs @@ -70,11 +70,20 @@ fn get_call_function( if let Some(func) = func { let call_expr_args_count = call_expr.get_args_count(); if let Some(mut call_expr_args_count) = call_expr_args_count { - let func_params_count = func.get_params().len(); + let mut func_params_count = func.get_params().len(); if !func.is_colon_define() && call_expr.is_colon_call() { // 不是冒号定义的函数, 但是是冒号调用 call_expr_args_count += 1; } + // 如果参数有可空参数, 则需要减去 + for (_, param_type) in func.get_params().iter() { + if let Some(param_type) = param_type { + if param_type.is_optional() { + func_params_count -= 1; + } + } + } + if call_expr_args_count == func_params_count { return Some(func); } diff --git a/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs b/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs index d624458de..dcbad5d7d 100644 --- a/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs +++ b/crates/emmylua_ls/src/handlers/inlay_hint/build_inlay_hint.rs @@ -334,7 +334,7 @@ fn build_local_name_hint( // 目前没时间完善结合 ast 的类型过滤, 所以只允许一些类型显示 match typ { - LuaType::Def(_) | LuaType::Ref(_) => {} + LuaType::Ref(_) => {} _ => { return Some(()); } diff --git a/crates/emmylua_ls/src/handlers/test/definition_test.rs b/crates/emmylua_ls/src/handlers/test/definition_test.rs index 49872ac3a..cd0e8fb55 100644 --- a/crates/emmylua_ls/src/handlers/test/definition_test.rs +++ b/crates/emmylua_ls/src/handlers/test/definition_test.rs @@ -173,4 +173,43 @@ mod tests { } } } + + #[test] + fn test_goto_return_field_2() { + let mut ws = ProviderVirtualWorkspace::new_with_init_std_lib(); + ws.def_file( + "test.lua", + r#" + ---@export + ---@class Export + local export = {} + ---@generic T + ---@param name `T`|T + ---@param tbl? table + ---@return T + local function new(name, tbl) + end + + export.new = new + return export + "#, + ); + let result = ws + .check_definition( + r#" + local new = require("test").new + new("A") + "#, + ) + .unwrap(); + match result { + GotoDefinitionResponse::Array(locations) => { + assert_eq!(locations.len(), 1); + assert_eq!(locations[0].range.start.line, 8); + } + _ => { + panic!("expect scalar"); + } + } + } } diff --git a/crates/emmylua_ls/src/handlers/test/inlay_hint_test.rs b/crates/emmylua_ls/src/handlers/test/inlay_hint_test.rs index c2e0e44a2..a666f3a22 100644 --- a/crates/emmylua_ls/src/handlers/test/inlay_hint_test.rs +++ b/crates/emmylua_ls/src/handlers/test/inlay_hint_test.rs @@ -108,7 +108,7 @@ mod tests { "#, ) .unwrap(); - assert!(result.len() == 4); + assert!(result.len() == 3); } #[test] @@ -123,7 +123,7 @@ mod tests { "#, ) .unwrap(); - assert!(result.len() == 1); + assert!(result.len() == 0); } #[test] @@ -148,9 +148,9 @@ mod tests { "#, ) .unwrap(); - assert!(result.len() == 2); + assert!(result.len() == 1); - let location = match &result.get(1).unwrap().label { + let location = match &result.get(0).unwrap().label { InlayHintLabel::LabelParts(parts) => parts.first().unwrap().location.as_ref().unwrap(), InlayHintLabel::String(_) => panic!(), }; From 930b63e736cd48e8a0824441eee4e5145071abf0 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Thu, 3 Jul 2025 12:37:15 +0800 Subject: [PATCH 38/54] fix typecheck: def/ref match Generic --- .../src/db_index/type/humanize_type.rs | 4 +- .../checker/return_type_mismatch.rs | 97 +++++-------------- .../test/return_type_mismatch_test.rs | 23 +++++ .../src/semantic/type_check/ref_type.rs | 17 +++- 4 files changed, 67 insertions(+), 74 deletions(-) diff --git a/crates/emmylua_code_analysis/src/db_index/type/humanize_type.rs b/crates/emmylua_code_analysis/src/db_index/type/humanize_type.rs index dc8d845d5..89a3b150a 100644 --- a/crates/emmylua_code_analysis/src/db_index/type/humanize_type.rs +++ b/crates/emmylua_code_analysis/src/db_index/type/humanize_type.rs @@ -476,7 +476,7 @@ fn humanize_generic_type(db: &DbIndex, generic: &LuaGenericType, level: RenderLe None => return base_id.get_name().to_string(), }; - let simple_name = type_decl.get_name(); + let full_name = type_decl.get_full_name(); match level { RenderLevel::Brief => { if type_decl.is_alias() { @@ -501,7 +501,7 @@ fn humanize_generic_type(db: &DbIndex, generic: &LuaGenericType, level: RenderLe .collect::>() .join(","); - format!("{}<{}>", simple_name, generic_params) + format!("{}<{}>", full_name, generic_params) } fn humanize_table_const_type_detail_and_simple( diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs index d76909965..1aa2f6b3a 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs @@ -4,8 +4,8 @@ use emmylua_parser::{ use rowan::{NodeOrToken, TextRange}; use crate::{ - diagnostic::checker::assign_type_mismatch::check_table_expr, humanize_type, DiagnosticCode, - LuaSemanticDeclId, LuaSignatureId, LuaType, RenderLevel, SemanticDeclLevel, SemanticModel, + diagnostic::checker::{assign_type_mismatch::check_table_expr, humanize_lint_type}, + DiagnosticCode, LuaSemanticDeclId, LuaSignatureId, LuaType, SemanticDeclLevel, SemanticModel, SignatureReturnStatus, TypeCheckFailReason, TypeCheckResult, }; @@ -127,6 +127,8 @@ fn check_return_stat( let return_expr_type = &return_expr_types[0]; let return_expr_range = return_expr_ranges[0]; let result = semantic_model.type_check(check_type, &return_expr_type); + dbg!(&check_type); + dbg!(&return_expr_type); if !result.is_ok() { if return_expr_type.is_table() { if let Some(return_expr) = return_exprs.get(0) { @@ -160,34 +162,6 @@ fn check_return_stat( Some(()) } -// fn check_variadic_return_type_match( -// context: &mut DiagnosticContext, -// semantic_model: &SemanticModel, -// start_idx: usize, -// variadic_type: &LuaType, -// return_expr_types: &[LuaType], -// return_expr_ranges: &[TextRange], -// ) { -// let mut idx = start_idx; -// for (return_expr_type, return_expr_range) in -// return_expr_types.iter().zip(return_expr_ranges.iter()) -// { -// let result = semantic_model.type_check(variadic_type, return_expr_type); -// if !result.is_ok() { -// add_type_check_diagnostic( -// context, -// semantic_model, -// start_idx + idx, -// *return_expr_range, -// variadic_type, -// return_expr_type, -// result, -// ); -// } -// idx += 1; -// } -// } - fn add_type_check_diagnostic( context: &mut DiagnosticContext, semantic_model: &SemanticModel, @@ -200,47 +174,28 @@ fn add_type_check_diagnostic( let db = semantic_model.get_db(); match result { Ok(_) => return, - Err(reason) => match reason { - TypeCheckFailReason::TypeNotMatchWithReason(reason) => { - context.add_diagnostic( - DiagnosticCode::ReturnTypeMismatch, - range, - t!( - "Annotations specify that return value %{index} has a type of `%{source}`, returning value of type `%{found}` here instead. %{reason}", - index = index + 1, - source = humanize_type(db, ¶m_type, RenderLevel::Simple), - found = humanize_type(db, &expr_type, RenderLevel::Simple), - reason = reason - ) - .to_string(), - None, - ); - } - TypeCheckFailReason::TypeNotMatch => { - context.add_diagnostic( - DiagnosticCode::ReturnTypeMismatch, - range, - t!( - "Annotations specify that return value %{index} has a type of `%{source}`, returning value of type `%{found}` here instead. %{reason}", - index = index + 1, - source = humanize_type(db, ¶m_type, RenderLevel::Simple), - found = humanize_type(db, &expr_type, RenderLevel::Simple), - reason = "" - ) - .to_string(), - None, - ); - } - TypeCheckFailReason::TypeRecursion => { - context.add_diagnostic( - DiagnosticCode::ReturnTypeMismatch, - range, - "type recursion".into(), - None, - ); - } - TypeCheckFailReason::DonotCheck => {} - }, + Err(reason) => { + let reason_message = match reason { + TypeCheckFailReason::TypeNotMatchWithReason(reason) => reason, + TypeCheckFailReason::TypeNotMatch | TypeCheckFailReason::DonotCheck => { + "".to_string() + } + TypeCheckFailReason::TypeRecursion => "type recursion".to_string(), + }; + context.add_diagnostic( + DiagnosticCode::ReturnTypeMismatch, + range, + t!( + "Annotations specify that return value %{index} has a type of `%{source}`, returning value of type `%{found}` here instead. %{reason}", + index = index + 1, + source = humanize_lint_type(db, ¶m_type), + found = humanize_lint_type(db, &expr_type), + reason = reason_message + ) + .to_string(), + None, + ); + } } } diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs index a2014621a..f97a475b3 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs @@ -423,4 +423,27 @@ mod tests { "# )); } + + #[test] + fn test_super_alias() { + let mut ws = VirtualWorkspace::new_with_init_std_lib(); + assert!(ws.check_code_for( + DiagnosticCode::ReturnTypeMismatch, + r#" + ---@namespace Test + + ---@alias A fun() + + ---@class B: A + + ---@return A + local function subscribe() + ---@type B + local a + + return a + end + "# + )); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/type_check/ref_type.rs b/crates/emmylua_code_analysis/src/semantic/type_check/ref_type.rs index 4c93d4b75..a0929a07e 100644 --- a/crates/emmylua_code_analysis/src/semantic/type_check/ref_type.rs +++ b/crates/emmylua_code_analysis/src/semantic/type_check/ref_type.rs @@ -27,12 +27,16 @@ pub fn check_ref_type_compact( if type_decl.is_alias() { if let Some(origin_type) = type_decl.get_alias_origin(db, None) { - return check_general_type_compact( + let result = check_general_type_compact( db, &origin_type, compact_type, check_guard.next_level()?, ); + if result.is_err() && origin_type.is_function() { + return check_ref_class(db, source_id, compact_type, check_guard); + } + return result; } return Err(TypeCheckFailReason::TypeNotMatch); @@ -176,6 +180,17 @@ fn check_ref_class( LuaType::Tuple(tuple_type) => { check_ref_type_compact_tuple(db, tuple_type, source_id, check_guard.next_level()?) } + LuaType::Generic(generic) => { + let base_type_id = generic.get_base_type_id(); + if source_id == &base_type_id + || is_sub_type_of(db, &base_type_id, source_id) + || is_sub_type_of(db, source_id, &base_type_id) + { + Ok(()) + } else { + Err(TypeCheckFailReason::TypeNotMatch) + } + } _ => { if let Some(base_type_id) = get_base_type_id(compact_type) { if source_id == &base_type_id From a2c722d85b925535ade16d1baf8e94beff36c54b Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Fri, 4 Jul 2025 12:30:50 +0800 Subject: [PATCH 39/54] fix #572 --- .../completion/providers/member_provider.rs | 204 ++++++++++++------ .../src/handlers/test/completion_test.rs | 36 ++++ 2 files changed, 175 insertions(+), 65 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/completion/providers/member_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/member_provider.rs index 09cf0ac64..5e2390d24 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/member_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/member_provider.rs @@ -1,5 +1,6 @@ use emmylua_code_analysis::{ enum_variable_is_param, DbIndex, LuaMemberInfo, LuaSemanticDeclId, LuaType, LuaTypeDeclId, + SemanticModel, }; use emmylua_parser::{LuaAstNode, LuaAstToken, LuaIndexExpr, LuaStringToken}; @@ -40,7 +41,11 @@ pub fn add_completion(builder: &mut CompletionBuilder) -> Option<()> { } let member_info_map = builder.semantic_model.get_member_info_map(&prefix_type)?; - for (_, member_infos) in member_info_map.iter() { + // 排序 + let mut sorted_entries: Vec<_> = member_info_map.iter().collect(); + sorted_entries.sort_unstable_by(|(name1, _), (name2, _)| name1.cmp(name2)); + + for (_, member_infos) in sorted_entries { add_resolve_member_infos(builder, &member_infos, completion_status); } @@ -53,11 +58,28 @@ fn add_resolve_member_infos( completion_status: CompletionTriggerStatus, ) -> Option<()> { if member_infos.len() == 1 { - let overload_count = count_function_overloads( - builder.semantic_model.get_db(), - &member_infos.iter().map(|info| info).collect::>(), - ); let member_info = &member_infos[0]; + let overload_count = match &member_info.typ { + LuaType::DocFunction(_) => None, + LuaType::Signature(id) => { + if let Some(signature) = builder + .semantic_model + .get_db() + .get_signature_index() + .get(&id) + { + let count = signature.overloads.len(); + if count == 0 { + None + } else { + Some(count) + } + } else { + None + } + } + _ => None, + }; add_member_completion( builder, member_info.clone(), @@ -67,46 +89,12 @@ fn add_resolve_member_infos( return Some(()); } - let mut resolve_state = MemberResolveState::All; - if builder - .semantic_model - .get_db() - .get_emmyrc() - .strict - .meta_override_file_define - { - for member_info in member_infos { - match member_info.feature { - Some(feature) => { - if feature.is_meta_decl() { - resolve_state = MemberResolveState::Meta; - break; - } else if feature.is_file_decl() { - resolve_state = MemberResolveState::FileDecl; - } - } - None => {} - } - } - } - - // 屏蔽掉父类成员 - let first_owner = get_owner_type_id(builder.semantic_model.get_db(), member_infos.first()?); - let member_infos: Vec<&LuaMemberInfo> = member_infos - .iter() - .filter(|member_info| { - get_owner_type_id(builder.semantic_model.get_db(), member_info) == first_owner - }) - .collect(); - - // 当全为`DocFunction`时, 只取第一个作为补全项 - let limit_doc_function = member_infos - .iter() - .all(|info| matches!(info.typ, LuaType::DocFunction(_))); + let (filtered_member_infos, overload_count) = + filter_member_infos(&builder.semantic_model, member_infos)?; - let overload_count = count_function_overloads(builder.semantic_model.get_db(), &member_infos); + let resolve_state = get_resolve_state(builder.semantic_model.get_db(), &filtered_member_infos); - for member_info in member_infos { + for member_info in filtered_member_infos { match resolve_state { MemberResolveState::All => { add_member_completion( @@ -115,9 +103,6 @@ fn add_resolve_member_infos( completion_status, overload_count, ); - if limit_doc_function { - break; - } } MemberResolveState::Meta => { if let Some(feature) = member_info.feature { @@ -128,9 +113,6 @@ fn add_resolve_member_infos( completion_status, overload_count, ); - if limit_doc_function { - break; - } } } } @@ -143,9 +125,6 @@ fn add_resolve_member_infos( completion_status, overload_count, ); - if limit_doc_function { - break; - } } } } @@ -155,30 +134,105 @@ fn add_resolve_member_infos( Some(()) } -fn count_function_overloads(db: &DbIndex, member_infos: &Vec<&LuaMemberInfo>) -> Option { - let mut count = 0; +/// 过滤成员信息，返回需要的成员列表和重载数量 +fn filter_member_infos<'a>( + semantic_model: &SemanticModel, + member_infos: &'a Vec, +) -> Option<(Vec<&'a LuaMemberInfo>, Option)> { + if member_infos.is_empty() { + return None; + } + + let mut file_decl_member: Option<&LuaMemberInfo> = None; + let mut member_with_owners: Vec<(&LuaMemberInfo, Option)> = + Vec::with_capacity(member_infos.len()); + let mut all_doc_function = true; + let mut overload_count = 0; + + // 一次遍历收集所有信息 for member_info in member_infos { + let owner_id = get_owner_type_id(semantic_model.get_db(), member_info); + member_with_owners.push((member_info, owner_id.clone())); + + // 寻找第一个 file_decl 作为参考，如果没有则使用第一个 + if file_decl_member.is_none() { + if let Some(feature) = member_info.feature { + if feature.is_file_decl() { + file_decl_member = Some(member_info); + } + } + } + + // 检查是否全为 DocFunction，同时计算重载数量 match &member_info.typ { LuaType::DocFunction(_) => { - count += 1; + overload_count += 1; } LuaType::Signature(id) => { - count += 1; - if let Some(signature) = db.get_signature_index().get(&id) { - count += signature.overloads.len(); + all_doc_function = false; + overload_count += 1; + if let Some(signature) = semantic_model.get_db().get_signature_index().get(&id) { + overload_count += signature.overloads.len(); } } - _ => {} + _ => { + all_doc_function = false; + } } } - if count >= 1 { - count -= 1; - } - if count == 0 { - None + + // 确定最终使用的参考 owner + let final_reference_owner = if let Some(file_decl_member_info) = file_decl_member { + // 与第一个成员进行类型检查, 确保子类成员的类型与父类成员的类型一致 + if let Some((first_member, first_owner)) = member_with_owners.first() { + let type_check_result = + semantic_model.type_check(&file_decl_member_info.typ, &first_member.typ); + if type_check_result.is_ok() { + get_owner_type_id(semantic_model.get_db(), file_decl_member_info) + } else { + first_owner.clone() + } + } else { + get_owner_type_id(semantic_model.get_db(), file_decl_member_info) + } + } else { + // 没有找到 file_decl，使用第一个成员作为参考 + member_with_owners + .first() + .map(|(_, owner)| owner.clone()) + .flatten() + }; + + // 过滤出相同 owner_type_id 的成员 + let mut filtered_member_infos: Vec<&LuaMemberInfo> = member_with_owners + .into_iter() + .filter_map(|(member_info, owner_id)| { + if owner_id == final_reference_owner { + Some(member_info) + } else { + None + } + }) + .collect(); + + // 处理重载计数 + let final_overload_count = if overload_count >= 1 { + let count = overload_count - 1; + if count == 0 { + None + } else { + Some(count) + } } else { - Some(count) + None + }; + + // 如果全为 DocFunction, 只保留第一个 + if all_doc_function && !filtered_member_infos.is_empty() { + filtered_member_infos.truncate(1); } + + Some((filtered_member_infos, final_overload_count)) } enum MemberResolveState { @@ -198,3 +252,23 @@ fn get_owner_type_id(db: &DbIndex, info: &LuaMemberInfo) -> Option None, } } + +fn get_resolve_state(db: &DbIndex, member_infos: &Vec<&LuaMemberInfo>) -> MemberResolveState { + let mut resolve_state = MemberResolveState::All; + if db.get_emmyrc().strict.meta_override_file_define { + for member_info in member_infos.iter() { + match member_info.feature { + Some(feature) => { + if feature.is_meta_decl() { + resolve_state = MemberResolveState::Meta; + break; + } else if feature.is_file_decl() { + resolve_state = MemberResolveState::FileDecl; + } + } + None => {} + } + } + } + resolve_state +} diff --git a/crates/emmylua_ls/src/handlers/test/completion_test.rs b/crates/emmylua_ls/src/handlers/test/completion_test.rs index 7bf755b7f..077175889 100644 --- a/crates/emmylua_ls/src/handlers/test/completion_test.rs +++ b/crates/emmylua_ls/src/handlers/test/completion_test.rs @@ -1095,4 +1095,40 @@ mod tests { },], )); } + + #[test] + fn test_issue_572() { + let mut ws = ProviderVirtualWorkspace::new(); + assert!(ws.check_completion( + r#" + ---@class A + ---@field optional_num number? + local a = {} + + function a:set() + end + + --- @class B : A + local b = {} + + function b:set() + self.optional_num = 2 + end + b. + + "#, + vec![ + VirtualCompletionItem { + label: "optional_num".to_string(), + kind: CompletionItemKind::VARIABLE, + ..Default::default() + }, + VirtualCompletionItem { + label: "set".to_string(), + kind: CompletionItemKind::FUNCTION, + label_detail: Some("(self) -> nil".to_string()), + }, + ], + )); + } } From 5312a09aac54339828c3a58657c31bc69cee406b Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Fri, 4 Jul 2025 16:18:43 +0800 Subject: [PATCH 40/54] =?UTF-8?q?fix:=20find=5Fmember=5Forigin=5Fowner=20?= =?UTF-8?q?=E7=A6=81=E6=AD=A2=E8=BF=BD=E6=BA=AF=E5=88=B0=E5=8F=82=E6=95=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/handlers/hover/find_origin.rs | 23 ++++++++++++++++--- .../src/handlers/test/rename_test.rs | 22 ++++++++++++++++++ 2 files changed, 42 insertions(+), 3 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/hover/find_origin.rs b/crates/emmylua_ls/src/handlers/hover/find_origin.rs index 954605feb..a4d0b7f9d 100644 --- a/crates/emmylua_ls/src/handlers/hover/find_origin.rs +++ b/crates/emmylua_ls/src/handlers/hover/find_origin.rs @@ -187,7 +187,7 @@ fn resolve_member_owner( let root = semantic_model.get_root().syntax(); let current_node = member_id.get_syntax_id().to_node_from_root(&root)?; - match member_id.get_syntax_id().get_kind() { + let result = match member_id.get_syntax_id().get_kind() { LuaSyntaxKind::TableFieldAssign => { if LuaTableField::can_cast(current_node.kind().into()) { let table_field = LuaTableField::cast(current_node.clone())?; @@ -213,18 +213,35 @@ fn resolve_member_owner( let assign_stat = LuaAssignStat::cast(assign_node)?; let (vars, exprs) = assign_stat.get_var_and_expr_list(); + let mut result = None; for (var, expr) in vars.iter().zip(exprs.iter()) { if var.syntax().text_range() == current_node.text_range() { let expr_node = expr.get_syntax_id().to_node_from_root(&root)?; - return semantic_model.find_decl( + result = semantic_model.find_decl( expr_node.into(), emmylua_code_analysis::SemanticDeclLevel::default(), ); + break; } } - None + result } _ => None, + }; + + // 禁止追溯到参数 + match result { + Some(LuaSemanticDeclId::LuaDecl(decl_id)) => { + let decl = semantic_model + .get_db() + .get_decl_index() + .get_decl(&decl_id)?; + if decl.is_param() { + return None; + } + result + } + _ => result, } } diff --git a/crates/emmylua_ls/src/handlers/test/rename_test.rs b/crates/emmylua_ls/src/handlers/test/rename_test.rs index 9aaa473d0..83d7843cb 100644 --- a/crates/emmylua_ls/src/handlers/test/rename_test.rs +++ b/crates/emmylua_ls/src/handlers/test/rename_test.rs @@ -46,4 +46,26 @@ mod tests { ); assert!(result); } + + #[test] + fn test_rename_class_field() { + let mut ws = ProviderVirtualWorkspace::new(); + let result = ws.check_rename( + r#" + ---@class AnonymousObserver + local AnonymousObserver + + function AnonymousObserver:__init(next) + self.next = next + end + + function AnonymousObserver:onNextCore(value) + self.next(value) + end + "#, + "_next".to_string(), + 2, + ); + assert!(result); + } } From b337baa62dbb19ec676f57ad37e07973b99139e2 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Fri, 4 Jul 2025 17:13:47 +0800 Subject: [PATCH 41/54] update diagnostic: `GenericConstraintMismatch` support check union --- .../generic/generic_constraint_mismatch.rs | 103 +++++++++++++----- .../checker/return_type_mismatch.rs | 2 - .../test/generic_constraint_mismatch_test.rs | 39 +++++++ 3 files changed, 113 insertions(+), 31 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/generic/generic_constraint_mismatch.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/generic/generic_constraint_mismatch.rs index 8474d523d..b00e28678 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/generic/generic_constraint_mismatch.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/generic/generic_constraint_mismatch.rs @@ -110,37 +110,86 @@ fn check_call_expr( continue; }; - match param_type { - LuaType::StrTplRef(str_tpl_ref) => { - let extend_type = get_extend_type( - semantic_model, - &call_expr, - str_tpl_ref.get_tpl_id(), - signature, - ); - check_str_tpl_ref( + check_param_type( + context, + semantic_model, + &call_expr, + i, + param_type, + signature, + &arg_infos, + false, + ); + } + } + + Some(()) +} + +fn check_param_type( + context: &mut DiagnosticContext, + semantic_model: &SemanticModel, + call_expr: &LuaCallExpr, + param_index: usize, + param_type: &LuaType, + signature: &LuaSignature, + arg_infos: &[(LuaType, TextRange)], + from_union: bool, +) -> Option<()> { + // 应该先通过泛型体操约束到唯一类型再进行检查 + match param_type { + LuaType::StrTplRef(str_tpl_ref) => { + let extend_type = get_extend_type( + semantic_model, + &call_expr, + str_tpl_ref.get_tpl_id(), + signature, + ); + let arg_expr = call_expr.get_args_list()?.get_args().nth(param_index)?; + let arg_type = semantic_model.infer_expr(arg_expr.clone()).ok()?; + + if from_union && !arg_type.is_string() { + return None; + } + + check_str_tpl_ref( + context, + semantic_model, + str_tpl_ref, + &arg_type, + arg_expr.get_range(), + extend_type, + ); + } + LuaType::TplRef(tpl_ref) => { + let extend_type = + get_extend_type(semantic_model, &call_expr, tpl_ref.get_tpl_id(), signature); + check_tpl_ref( + context, + semantic_model, + &extend_type, + arg_infos.get(param_index), + ); + } + LuaType::Union(union_type) => { + // 如果不是来自 union, 才展开 union 中的每个类型进行检查 + if !from_union { + for union_member_type in union_type.get_types() { + check_param_type( context, semantic_model, - &call_expr, - i, - str_tpl_ref, - extend_type, - ); - } - LuaType::TplRef(tpl_ref) => { - let extend_type = get_extend_type( - semantic_model, - &call_expr, - tpl_ref.get_tpl_id(), + call_expr, + param_index, + union_member_type, signature, + arg_infos, + true, ); - check_tpl_ref(context, semantic_model, &extend_type, arg_infos.get(i)); } - _ => {} } } + _ => {} } - Some(()) } @@ -182,15 +231,11 @@ fn get_extend_type( fn check_str_tpl_ref( context: &mut DiagnosticContext, semantic_model: &SemanticModel, - call_expr: &LuaCallExpr, - param_index: usize, str_tpl_ref: &LuaStringTplType, + arg_type: &LuaType, + range: TextRange, extend_type: Option, ) -> Option<()> { - let arg_expr = call_expr.get_args_list()?.get_args().nth(param_index)?; - let arg_type = semantic_model.infer_expr(arg_expr.clone()).ok()?; - let range = arg_expr.get_range(); - match arg_type { LuaType::StringConst(str) | LuaType::DocStringConst(str) => { let full_type_name = format!( diff --git a/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs b/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs index 1aa2f6b3a..92c420b11 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/checker/return_type_mismatch.rs @@ -127,8 +127,6 @@ fn check_return_stat( let return_expr_type = &return_expr_types[0]; let return_expr_range = return_expr_ranges[0]; let result = semantic_model.type_check(check_type, &return_expr_type); - dbg!(&check_type); - dbg!(&return_expr_type); if !result.is_ok() { if return_expr_type.is_table() { if let Some(return_expr) = return_exprs.get(0) { diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/generic_constraint_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/generic_constraint_mismatch_test.rs index 9be7912b0..145d6fe00 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/generic_constraint_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/generic_constraint_mismatch_test.rs @@ -200,4 +200,43 @@ mod test { "# )); } + + #[test] + fn test_union() { + let mut ws = VirtualWorkspace::new(); + ws.def( + r#" + ---@class ab + + ---@generic T + ---@param a `T`|T + ---@return T + function name(a) + return a + end + "#, + ); + assert!(ws.check_code_for( + DiagnosticCode::GenericConstraintMismatch, + r#" + ---@type ab + local a + + name(a) + "# + )); + assert!(ws.check_code_for( + DiagnosticCode::GenericConstraintMismatch, + r#" + name("ab") + "# + )); + + assert!(!ws.check_code_for( + DiagnosticCode::GenericConstraintMismatch, + r#" + name("a") + "# + )); + } } From 2faff7ff3f915c762ad7cd0214bedd20371fdf8c Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Fri, 4 Jul 2025 17:35:00 +0800 Subject: [PATCH 42/54] =?UTF-8?q?change:=20=E5=87=BD=E6=95=B0=E6=B3=9B?= =?UTF-8?q?=E5=9E=8B=E8=BF=94=E5=9B=9E=E5=80=BC=E4=BC=9A=E5=B0=86=20`def`?= =?UTF-8?q?=20=E8=BD=AC=E4=B8=BA=20`ref`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../generic/instantiate_type_generic.rs | 5 +++- .../src/semantic/generic/test.rs | 27 +++++++++++++++++++ .../src/semantic/generic/type_substitutor.rs | 25 +++++++++++++++++ 3 files changed, 56 insertions(+), 1 deletion(-) diff --git a/crates/emmylua_code_analysis/src/semantic/generic/instantiate_type_generic.rs b/crates/emmylua_code_analysis/src/semantic/generic/instantiate_type_generic.rs index fff1fde23..935cdc915 100644 --- a/crates/emmylua_code_analysis/src/semantic/generic/instantiate_type_generic.rs +++ b/crates/emmylua_code_analysis/src/semantic/generic/instantiate_type_generic.rs @@ -141,7 +141,10 @@ pub fn instantiate_doc_function( } } - let inst_ret_type = instantiate_type_generic(db, &tpl_ret, substitutor); + // 将 substitutor 中存储的类型的 def 转为 ref + let mut modified_substitutor = substitutor.clone(); + modified_substitutor.convert_def_to_ref(); + let inst_ret_type = instantiate_type_generic(db, &tpl_ret, &modified_substitutor); LuaType::DocFunction( LuaFunctionType::new(is_async, colon_define, new_params, inst_ret_type).into(), ) diff --git a/crates/emmylua_code_analysis/src/semantic/generic/test.rs b/crates/emmylua_code_analysis/src/semantic/generic/test.rs index 2f6c2937a..2ca4e838a 100644 --- a/crates/emmylua_code_analysis/src/semantic/generic/test.rs +++ b/crates/emmylua_code_analysis/src/semantic/generic/test.rs @@ -93,4 +93,31 @@ mod test { assert_eq!(b, expected_b); assert_eq!(c, expected_c); } + + #[test] + fn test_return() { + let mut ws = crate::VirtualWorkspace::new(); + ws.def( + r#" + ---@class ab + ---@field a number + local A + + ---@generic T + ---@param a T + ---@return T + local function name(a) + return a + end + + local a = name(A) + a.b = 1 + R = A.b + "#, + ); + + let a = ws.expr_ty("R"); + let expected = ws.ty("any"); + assert_eq!(a, expected); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/generic/type_substitutor.rs b/crates/emmylua_code_analysis/src/semantic/generic/type_substitutor.rs index 3a73ec645..7d80c1655 100644 --- a/crates/emmylua_code_analysis/src/semantic/generic/type_substitutor.rs +++ b/crates/emmylua_code_analysis/src/semantic/generic/type_substitutor.rs @@ -111,6 +111,31 @@ impl TypeSubstitutor { pub fn get_self_type(&self) -> Option<&LuaType> { self.self_type.as_ref() } + + pub fn convert_def_to_ref(&mut self) { + for (_, value) in self.tpl_replace_map.iter_mut() { + match value { + SubstitutorValue::Type(ty) => { + *ty = convert_type_def_to_ref(ty); + } + SubstitutorValue::Params(params) => { + for (_, param_ty) in params.iter_mut() { + if let Some(ty) = param_ty { + *ty = convert_type_def_to_ref(ty); + } + } + } + _ => {} + } + } + } +} + +fn convert_type_def_to_ref(ty: &LuaType) -> LuaType { + match ty { + LuaType::Def(type_decl_id) => LuaType::Ref(type_decl_id.clone()), + _ => ty.clone(), + } } #[derive(Debug, Clone)] From 8fe6a1b6443244e42831767c86d9c6b0c15c4a37 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Fri, 4 Jul 2025 17:37:07 +0800 Subject: [PATCH 43/54] add config: `doc.privateName` --- .../resources/schema.json | 19 ++++++++++++ .../src/config/configs/doc.rs | 18 +++++++++++ .../src/config/configs/mod.rs | 2 ++ .../emmylua_code_analysis/src/config/mod.rs | 4 ++- .../src/semantic/visibility/mod.rs | 30 +++++++++++++++++++ .../inlay_hint/build_function_hint.rs | 18 +++++++++++ 6 files changed, 90 insertions(+), 1 deletion(-) create mode 100644 crates/emmylua_code_analysis/src/config/configs/doc.rs diff --git a/crates/emmylua_code_analysis/resources/schema.json b/crates/emmylua_code_analysis/resources/schema.json index d272899b4..dc7871b95 100644 --- a/crates/emmylua_code_analysis/resources/schema.json +++ b/crates/emmylua_code_analysis/resources/schema.json @@ -46,6 +46,12 @@ "severity": {} } }, + "doc": { + "$ref": "#/$defs/EmmyrcDoc", + "default": { + "privateName": [] + } + }, "documentColor": { "$ref": "#/$defs/EmmyrcDocumentColor", "default": { @@ -542,6 +548,19 @@ } } }, + "EmmyrcDoc": { + "type": "object", + "properties": { + "privateName": { + "description": "Treat specific field names as private, e.g. `m_*` means `XXX.m_id` and `XXX.m_type` are private, witch can only be accessed in the class where the definition is located.", + "type": "array", + "default": [], + "items": { + "type": "string" + } + } + } + }, "EmmyrcDocumentColor": { "type": "object", "properties": { diff --git a/crates/emmylua_code_analysis/src/config/configs/doc.rs b/crates/emmylua_code_analysis/src/config/configs/doc.rs new file mode 100644 index 000000000..dbe4c8a2f --- /dev/null +++ b/crates/emmylua_code_analysis/src/config/configs/doc.rs @@ -0,0 +1,18 @@ +use schemars::JsonSchema; +use serde::{Deserialize, Serialize}; + +#[derive(Serialize, Deserialize, Debug, JsonSchema, Clone)] +#[serde(rename_all = "camelCase")] +pub struct EmmyrcDoc { + #[serde(default)] + /// Treat specific field names as private, e.g. `m_*` means `XXX.m_id` and `XXX.m_type` are private, witch can only be accessed in the class where the definition is located. + pub private_name: Vec, +} + +impl Default for EmmyrcDoc { + fn default() -> Self { + Self { + private_name: Default::default(), + } + } +} diff --git a/crates/emmylua_code_analysis/src/config/configs/mod.rs b/crates/emmylua_code_analysis/src/config/configs/mod.rs index e67e207a7..9e49a0630 100644 --- a/crates/emmylua_code_analysis/src/config/configs/mod.rs +++ b/crates/emmylua_code_analysis/src/config/configs/mod.rs @@ -13,6 +13,7 @@ mod semantictoken; mod signature; mod strict; mod workspace; +mod doc; pub use code_action::EmmyrcCodeAction; pub use codelen::EmmyrcCodeLen; @@ -29,3 +30,4 @@ pub use semantictoken::EmmyrcSemanticToken; pub use signature::EmmyrcSignature; pub use strict::EmmyrcStrict; pub use workspace::EmmyrcWorkspace; +pub use doc::EmmyrcDoc; diff --git a/crates/emmylua_code_analysis/src/config/mod.rs b/crates/emmylua_code_analysis/src/config/mod.rs index 4a9f380bb..64568324f 100644 --- a/crates/emmylua_code_analysis/src/config/mod.rs +++ b/crates/emmylua_code_analysis/src/config/mod.rs @@ -12,7 +12,7 @@ pub use configs::EmmyrcFilenameConvention; pub use configs::EmmyrcLuaVersion; use configs::{EmmyrcCodeAction, EmmyrcDocumentColor}; use configs::{ - EmmyrcCodeLen, EmmyrcCompletion, EmmyrcDiagnostic, EmmyrcHover, EmmyrcInlayHint, + EmmyrcCodeLen, EmmyrcCompletion, EmmyrcDiagnostic, EmmyrcDoc, EmmyrcHover, EmmyrcInlayHint, EmmyrcInlineValues, EmmyrcReference, EmmyrcResource, EmmyrcRuntime, EmmyrcSemanticToken, EmmyrcSignature, EmmyrcStrict, EmmyrcWorkspace, }; @@ -58,6 +58,8 @@ pub struct Emmyrc { pub code_action: EmmyrcCodeAction, #[serde(default)] pub inline_values: EmmyrcInlineValues, + #[serde(default)] + pub doc: EmmyrcDoc, } impl Emmyrc { diff --git a/crates/emmylua_code_analysis/src/semantic/visibility/mod.rs b/crates/emmylua_code_analysis/src/semantic/visibility/mod.rs index ac35909ad..fa040793a 100644 --- a/crates/emmylua_code_analysis/src/semantic/visibility/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/visibility/mod.rs @@ -59,6 +59,36 @@ pub fn check_visibility( } } + if let LuaSemanticDeclId::Member(member_id) = property_owner { + if let Some(member) = db.get_member_index().get_member(&member_id) { + if let Some(name) = member.get_key().get_name() { + let config = emmyrc; + for pattern in &config.doc.private_name { + let is_match = if let Some(prefix) = pattern.strip_suffix('*') { + name.starts_with(prefix) + } else if let Some(suffix) = pattern.strip_prefix('*') { + name.ends_with(suffix) + } else { + name == pattern + }; + if is_match { + return Some( + check_visibility_by_visibility( + db, + infer_config, + file_id, + property_owner, + token, + VisibilityKind::Private, + ) + .unwrap_or(false), + ); + } + } + } + } + } + Some(true) } diff --git a/crates/emmylua_ls/src/handlers/inlay_hint/build_function_hint.rs b/crates/emmylua_ls/src/handlers/inlay_hint/build_function_hint.rs index e7d371826..9e5274416 100644 --- a/crates/emmylua_ls/src/handlers/inlay_hint/build_function_hint.rs +++ b/crates/emmylua_ls/src/handlers/inlay_hint/build_function_hint.rs @@ -160,6 +160,10 @@ fn get_type_location(semantic_model: &SemanticModel, typ: &LuaType) -> Option { + let base_type_id = generic.get_base_type_id(); + get_type_location(semantic_model, &LuaType::Ref(base_type_id)) + } LuaType::Array(base) => get_type_location(semantic_model, base), LuaType::Any => get_base_type_location(semantic_model, "any"), LuaType::Nil => get_base_type_location(semantic_model, "nil"), @@ -207,6 +211,20 @@ fn hint_humanize_type(semantic_model: &SemanticModel, typ: &LuaType, level: Rend id.get_name().to_string() } } + LuaType::Generic(generic) => { + let base_type_id = generic.get_base_type_id(); + let base_type_name = + hint_humanize_type(semantic_model, &LuaType::Ref(base_type_id), level); + + let generic_params = generic + .get_params() + .iter() + .map(|ty| hint_humanize_type(semantic_model, ty, level.next_level())) + .collect::>() + .join(","); + + format!("{}<{}>", base_type_name, generic_params) + } LuaType::Union(union) => hint_humanize_union_type(semantic_model, union, level), _ => humanize_type(semantic_model.get_db(), typ, level), } From 089da9fa9fca8313d61407024bd7d0f3661c59c1 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 6 Jul 2025 09:37:35 +0800 Subject: [PATCH 44/54] fix diagnostic: generic_type TypeNotFound --- .../src/compilation/analyzer/doc/infer_type.rs | 8 ++++++++ .../src/compilation/test/annotation_test.rs | 12 ++++++++++++ .../emmylua_code_analysis/src/config/configs/mod.rs | 4 ++-- 3 files changed, 22 insertions(+), 2 deletions(-) diff --git a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs index c536191fb..4cb2f8a93 100644 --- a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs +++ b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs @@ -215,6 +215,14 @@ fn infer_generic_type(analyzer: &mut DocAnalyzer, generic_type: &LuaDocGenericTy { name_type_decl.get_id() } else { + analyzer.db.get_diagnostic_index_mut().add_diagnostic( + analyzer.file_id, + AnalyzeError::new( + DiagnosticCode::TypeNotFound, + &t!("Type '%{name}' not found", name = name), + generic_type.get_range(), + ), + ); return LuaType::Unknown; }; diff --git a/crates/emmylua_code_analysis/src/compilation/test/annotation_test.rs b/crates/emmylua_code_analysis/src/compilation/test/annotation_test.rs index f17cc6dd3..b93eb92b0 100644 --- a/crates/emmylua_code_analysis/src/compilation/test/annotation_test.rs +++ b/crates/emmylua_code_analysis/src/compilation/test/annotation_test.rs @@ -112,4 +112,16 @@ mod test { let expected = ws.ty("string"); assert_eq!(ty, expected); } + + #[test] + fn test_generic_type_inference() { + let mut ws = VirtualWorkspace::new(); + + assert!(!ws.check_code_for( + DiagnosticCode::TypeNotFound, + r#" + ---@class AnonymousObserver: Observer + "#, + )); + } } diff --git a/crates/emmylua_code_analysis/src/config/configs/mod.rs b/crates/emmylua_code_analysis/src/config/configs/mod.rs index 9e49a0630..973084028 100644 --- a/crates/emmylua_code_analysis/src/config/configs/mod.rs +++ b/crates/emmylua_code_analysis/src/config/configs/mod.rs @@ -2,6 +2,7 @@ mod code_action; mod codelen; mod completion; mod diagnostics; +mod doc; mod document_color; mod hover; mod inlayhint; @@ -13,12 +14,12 @@ mod semantictoken; mod signature; mod strict; mod workspace; -mod doc; pub use code_action::EmmyrcCodeAction; pub use codelen::EmmyrcCodeLen; pub use completion::{EmmyrcCompletion, EmmyrcFilenameConvention}; pub use diagnostics::EmmyrcDiagnostic; +pub use doc::EmmyrcDoc; pub use document_color::EmmyrcDocumentColor; pub use hover::EmmyrcHover; pub use inlayhint::EmmyrcInlayHint; @@ -30,4 +31,3 @@ pub use semantictoken::EmmyrcSemanticToken; pub use signature::EmmyrcSignature; pub use strict::EmmyrcStrict; pub use workspace::EmmyrcWorkspace; -pub use doc::EmmyrcDoc; From e138c070a5956be9dc46860b6d256b4ddd9ffe5f Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 6 Jul 2025 12:23:26 +0800 Subject: [PATCH 45/54] fix diagnostic: typecheck now knows how to handle generics --- .../src/db_index/type/types.rs | 4 ++++ .../test/return_type_mismatch_test.rs | 24 +++++++++++++++++++ .../src/semantic/type_check/sub_type.rs | 10 ++++++++ 3 files changed, 38 insertions(+) diff --git a/crates/emmylua_code_analysis/src/db_index/type/types.rs b/crates/emmylua_code_analysis/src/db_index/type/types.rs index 38f058348..f54614ae0 100644 --- a/crates/emmylua_code_analysis/src/db_index/type/types.rs +++ b/crates/emmylua_code_analysis/src/db_index/type/types.rs @@ -865,6 +865,10 @@ impl LuaGenericType { self.base.clone() } + pub fn get_base_type_id_ref(&self) -> &LuaTypeDeclId { + &self.base + } + pub fn get_params(&self) -> &Vec { &self.params } diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs index f97a475b3..5cfe7fc8a 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs @@ -446,4 +446,28 @@ mod tests { "# )); } + + #[test] + fn test_generic_type_extends() { + let mut ws = VirtualWorkspace::new_with_init_std_lib(); + assert!(ws.check_code_for( + DiagnosticCode::ReturnTypeMismatch, + r#" + ---@class AnonymousObserver: Observer + + ---@class Observer: IDisposable + + ---@class IDisposable + + ---@generic T + ---@return IDisposable + local function createAnonymousObserver() + ---@type AnonymousObserver + local observer = {} + + return observer + end + "# + )); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/type_check/sub_type.rs b/crates/emmylua_code_analysis/src/semantic/type_check/sub_type.rs index 6dd5d4812..b79b9f369 100644 --- a/crates/emmylua_code_analysis/src/semantic/type_check/sub_type.rs +++ b/crates/emmylua_code_analysis/src/semantic/type_check/sub_type.rs @@ -45,6 +45,16 @@ fn check_sub_type_of_iterative( stack.push(super_id); } } + // TODO: 应该检查泛型参数是否匹配 + LuaType::Generic(generic) => { + let base_type_id = generic.get_base_type_id_ref(); + if base_type_id == super_type_ref_id { + return Some(true); + } + if !visited.contains(&base_type_id) { + stack.push(base_type_id); + } + } _ => { if let Some(base_id) = get_base_type_id(super_type) { if base_id == *super_type_ref_id { From bc72d51cf00c78d7a124679824f164ef8bc895b9 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 6 Jul 2025 21:05:39 +0800 Subject: [PATCH 46/54] optimize definition: support generic type --- .../definition/goto_def_definition.rs | 56 ++++++++++++++----- .../src/handlers/test/definition_test.rs | 39 +++++++++++++ 2 files changed, 80 insertions(+), 15 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs b/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs index 9c2f108de..8d3ed81c5 100644 --- a/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs +++ b/crates/emmylua_ls/src/handlers/definition/goto_def_definition.rs @@ -213,24 +213,26 @@ pub fn goto_str_tpl_ref_definition( } _ => params.get(string_token_idx), }?; - if let Some(LuaType::StrTplRef(str_tpl)) = target_param.1.clone() { - let prefix = str_tpl.get_prefix(); - let suffix = str_tpl.get_suffix(); - let type_decl_id = LuaTypeDeclId::new(format!("{}{}{}", prefix, name, suffix).as_str()); - let type_decl = semantic_model - .get_db() - .get_type_index() - .get_type_decl(&type_decl_id)?; - let mut locations = Vec::new(); - for lua_location in type_decl.get_locations() { - let document = semantic_model.get_document_by_file_id(lua_location.file_id)?; - let location = document.to_lsp_location(lua_location.range)?; - locations.push(location); - } - + // 首先尝试直接匹配StrTplRef类型 + if let Some(locations) = + try_extract_str_tpl_ref_locations(semantic_model, &target_param.1, &name) + { return Some(GotoDefinitionResponse::Array(locations)); } + // 如果参数类型是union，尝试从中提取StrTplRef类型 + if let Some(LuaType::Union(union_type)) = target_param.1.clone() { + for union_member in union_type.get_types() { + if let Some(locations) = try_extract_str_tpl_ref_locations( + semantic_model, + &Some(union_member.clone()), + &name, + ) { + return Some(GotoDefinitionResponse::Array(locations)); + } + } + } + None } @@ -336,3 +338,27 @@ fn get_decl_location(semantic_model: &SemanticModel, decl_id: &LuaDeclId) -> Opt let location = document.to_lsp_location(decl.get_range())?; Some(location) } + +fn try_extract_str_tpl_ref_locations( + semantic_model: &SemanticModel, + param_type: &Option, + name: &str, +) -> Option> { + if let Some(LuaType::StrTplRef(str_tpl)) = param_type { + let prefix = str_tpl.get_prefix(); + let suffix = str_tpl.get_suffix(); + let type_decl_id = LuaTypeDeclId::new(format!("{}{}{}", prefix, name, suffix).as_str()); + let type_decl = semantic_model + .get_db() + .get_type_index() + .get_type_decl(&type_decl_id)?; + let mut locations = Vec::new(); + for lua_location in type_decl.get_locations() { + let document = semantic_model.get_document_by_file_id(lua_location.file_id)?; + let location = document.to_lsp_location(lua_location.range)?; + locations.push(location); + } + return Some(locations); + } + None +} diff --git a/crates/emmylua_ls/src/handlers/test/definition_test.rs b/crates/emmylua_ls/src/handlers/test/definition_test.rs index cd0e8fb55..81f3e9692 100644 --- a/crates/emmylua_ls/src/handlers/test/definition_test.rs +++ b/crates/emmylua_ls/src/handlers/test/definition_test.rs @@ -212,4 +212,43 @@ mod tests { } } } + + #[test] + fn test_goto_generic_type() { + let mut ws = ProviderVirtualWorkspace::new(); + ws.def_file( + "1.lua", + r#" + ---@generic T + ---@param name `T`|T + ---@return T + function new(name) + end + "#, + ); + ws.def_file( + "2.lua", + r#" + ---@namespace AAA + ---@class BBB + "#, + ); + let result = ws + .check_definition( + r#" + new("AAA.BBB") + "#, + ) + .unwrap(); + match result { + GotoDefinitionResponse::Array(array) => { + assert_eq!(array.len(), 1); + let location = &array[0]; + assert_eq!(location.uri.path().as_str().ends_with("2.lua"), true); + } + _ => { + panic!("expect array"); + } + } + } } From c13c34b8d2da7fa942fa9a75c4e1c74942d5d869 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Sun, 6 Jul 2025 23:32:07 +0800 Subject: [PATCH 47/54] fix generic type rename --- .../src/compilation/analyzer/doc/infer_type.rs | 7 +++++++ .../emmylua_ls/src/handlers/test/rename_test.rs | 15 +++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs index 4cb2f8a93..4a550828d 100644 --- a/crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs +++ b/crates/emmylua_code_analysis/src/compilation/analyzer/doc/infer_type.rs @@ -236,6 +236,13 @@ fn infer_generic_type(analyzer: &mut DocAnalyzer, generic_type: &LuaDocGenericTy generic_params.push(param_type); } } + if let Some(name_type) = generic_type.get_name_type() { + analyzer.db.get_reference_index_mut().add_type_reference( + analyzer.file_id, + id.clone(), + name_type.get_range(), + ); + } return LuaType::Generic(LuaGenericType::new(id, generic_params).into()); } diff --git a/crates/emmylua_ls/src/handlers/test/rename_test.rs b/crates/emmylua_ls/src/handlers/test/rename_test.rs index 83d7843cb..078d22592 100644 --- a/crates/emmylua_ls/src/handlers/test/rename_test.rs +++ b/crates/emmylua_ls/src/handlers/test/rename_test.rs @@ -68,4 +68,19 @@ mod tests { ); assert!(result); } + + #[test] + fn test_rename_generic_type() { + let mut ws = ProviderVirtualWorkspace::new(); + let result = ws.check_rename( + r#" + ---@class Params + + ---@type Params + "#, + "Params1".to_string(), + 2, + ); + assert!(result); + } } From 250b34f6508f633aaa5a5d28d9de52e49d8a3012 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 7 Jul 2025 00:21:43 +0800 Subject: [PATCH 48/54] optimize completion table field value: do not actively add global variables to std --- .../completion/providers/table_field_provider.rs | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs b/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs index 17224df35..65e50300b 100644 --- a/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs +++ b/crates/emmylua_ls/src/handlers/completion/providers/table_field_provider.rs @@ -156,6 +156,7 @@ fn add_field_key_completion( Some(()) } +/// 是否在当前文件的 env 中, 将会排除掉`std` fn in_env(builder: &mut CompletionBuilder, target_name: &str, target_type: &LuaType) -> Option<()> { let file_id = builder.semantic_model.get_file_id(); let decl_tree = builder @@ -168,7 +169,16 @@ fn in_env(builder: &mut CompletionBuilder, target_name: &str, target_type: &LuaT .semantic_model .get_db() .get_global_index() - .get_all_global_decl_ids(); + .get_all_global_decl_ids() + .into_iter() + .filter(|id| { + !builder + .semantic_model + .get_db() + .get_module_index() + .is_std(&id.file_id) + }) + .collect(); let all_env = [local_env, global_env].concat(); for decl_id in all_env.iter() { From f55faa209c9cdf8646abb5aa750b4335f8b0bb87 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 7 Jul 2025 01:05:19 +0800 Subject: [PATCH 49/54] Support for generic matching table --- .../diagnostic/test/param_type_check_test.rs | 33 +++++ .../src/semantic/type_check/generic_type.rs | 128 +++++++++++++++--- 2 files changed, 142 insertions(+), 19 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs index 83fe6cec2..a4dcccfa2 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs @@ -1134,4 +1134,37 @@ mod test { "# )); } + + #[test] + fn test_generic_type() { + let mut ws = VirtualWorkspace::new(); + ws.def( + r#" + ---@class ObserverParams + ---@field next fun( value: T) + ---@field errorResume? fun(error: any) + + + ---@class Observer + local Observer = {} + + ---@param observer ObserverParams + function Observer:subscribe(observer) + end + "#, + ); + assert!(ws.check_code_for( + DiagnosticCode::ParamTypeNotMatch, + r#" + ---@type Observer + local observer + + observer:subscribe({ + next = function(value) + print(value) + end + }) + "# + )); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/type_check/generic_type.rs b/crates/emmylua_code_analysis/src/semantic/type_check/generic_type.rs index 32c0c64d2..c04c26dec 100644 --- a/crates/emmylua_code_analysis/src/semantic/type_check/generic_type.rs +++ b/crates/emmylua_code_analysis/src/semantic/type_check/generic_type.rs @@ -1,4 +1,9 @@ -use crate::{DbIndex, LuaGenericType, LuaType, TypeSubstitutor}; +use std::{collections::HashMap, sync::Arc}; + +use crate::{ + humanize_type, semantic::member::find_members, DbIndex, LuaGenericType, LuaMemberOwner, + LuaType, LuaTypeCache, RenderLevel, TypeSubstitutor, +}; use super::{ check_general_type_compact, type_check_fail_reason::TypeCheckFailReason, @@ -11,7 +16,7 @@ pub fn check_generic_type_compact( compact_type: &LuaType, check_guard: TypeCheckGuard, ) -> TypeCheckResult { - // Do not check generic classes that have not been instantiated yet + // 不检查尚未实例化的泛型类 if source_generic.contain_tpl() { return Ok(()); } @@ -22,9 +27,8 @@ pub fn check_generic_type_compact( .get_type_decl(&source_base_id) .ok_or(TypeCheckFailReason::TypeNotMatch)?; - let type_params = source_generic.get_params(); - if type_decl.is_alias() { + let type_params = source_generic.get_params(); let substitutor = TypeSubstitutor::from_alias(type_params.clone(), source_base_id); if let Some(origin_type) = type_decl.get_alias_origin(db, Some(&substitutor)) { return check_general_type_compact( @@ -37,17 +41,19 @@ pub fn check_generic_type_compact( } match compact_type { - LuaType::Generic(compact_generic) => { - return check_generic_type_compact_generic( - db, - source_generic, - compact_generic, - check_guard.next_level()?, - ) - } - _ => { - return Err(TypeCheckFailReason::TypeNotMatch); - } + LuaType::Generic(compact_generic) => check_generic_type_compact_generic( + db, + source_generic, + compact_generic, + check_guard.next_level()?, + ), + LuaType::TableConst(range) => check_generic_type_compact_table( + db, + source_generic, + LuaMemberOwner::Element(range.clone()), + check_guard.next_level()?, + ), + _ => Err(TypeCheckFailReason::TypeNotMatch), } } @@ -69,10 +75,94 @@ fn check_generic_type_compact_generic( return Err(TypeCheckFailReason::TypeNotMatch); } - for i in 0..source_params.len() { - let source_param = &source_params[i]; - let compact_param = &compact_params[i]; - check_general_type_compact(db, source_param, compact_param, check_guard.next_level()?)?; + let next_guard = check_guard.next_level()?; + for (source_param, compact_param) in source_params.iter().zip(compact_params.iter()) { + check_general_type_compact(db, source_param, compact_param, next_guard)?; + } + + Ok(()) +} + +fn check_generic_type_compact_table( + db: &DbIndex, + source_generic: &LuaGenericType, + table_owner: LuaMemberOwner, + check_guard: TypeCheckGuard, +) -> TypeCheckResult { + let member_index = db.get_member_index(); + + // 构建表成员映射 + let table_member_map: HashMap<_, _> = member_index + .get_members(&table_owner) + .map(|members| { + members + .iter() + .map(|m| (m.get_key().clone(), m.get_id().clone())) + .collect() + }) + .unwrap_or_default(); + + // 获取泛型类型的成员，使用 find_members 来获取包括继承的所有成员 + let source_type = LuaType::Generic(Arc::new(source_generic.clone())); + let Some(source_type_members) = find_members(db, &source_type) else { + return Ok(()); // 空成员无需检查 + }; + + // 提前计算下一级检查守卫 + let next_guard = check_guard.next_level()?; + + for source_member in source_type_members { + let source_member_type = source_member.typ; + let key = source_member.key; + + match table_member_map.get(&key) { + Some(table_member_id) => { + let table_member = member_index + .get_member(table_member_id) + .ok_or(TypeCheckFailReason::TypeNotMatch)?; + let table_member_type = db + .get_type_index() + .get_type_cache(&table_member.get_id().into()) + .unwrap_or(&LuaTypeCache::InferType(LuaType::Any)) + .as_type(); + + if let Err(TypeCheckFailReason::TypeNotMatch) = check_general_type_compact( + db, + &source_member_type, + &table_member_type, + next_guard, + ) { + return Err(TypeCheckFailReason::TypeNotMatchWithReason( + t!( + "member %{name} type not match, expect %{expect}, got %{got}", + name = key.to_path(), + expect = humanize_type(db, &source_member_type, RenderLevel::Simple), + got = humanize_type(db, &table_member_type, RenderLevel::Simple) + ) + .to_string(), + )); + } + } + None if !source_member_type.is_optional() => { + return Err(TypeCheckFailReason::TypeNotMatchWithReason( + t!("missing member %{name}, in table", name = key.to_path()).to_string(), + )); + } + _ => {} // 可选成员未找到，继续检查 + } + } + + // 检查超类型 + let source_base_id = source_generic.get_base_type_id(); + if let Some(supers) = db.get_type_index().get_super_types(&source_base_id) { + let element_range = table_owner + .get_element_range() + .ok_or(TypeCheckFailReason::TypeNotMatch)?; + let table_type = LuaType::TableConst(element_range.clone()); + + for super_type in supers { + check_general_type_compact(db, &super_type, &table_type, next_guard)?; + } } Ok(()) From 1351438597223b89e92b4a7ae04e31cc2aa27661 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 7 Jul 2025 13:43:12 +0800 Subject: [PATCH 50/54] fix #573 --- .../diagnostic/test/param_type_check_test.rs | 21 +++++++++++ .../complex_type/array_type_check.rs | 36 +++++++++++++++++++ 2 files changed, 57 insertions(+) diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs index a4dcccfa2..13f90d461 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs @@ -1167,4 +1167,25 @@ mod test { "# )); } + + #[test] + fn test_issue_573() { + let mut ws = VirtualWorkspace::new(); + ws.def( + r#" + --- @class A + --- @field [integer] string + --- @field data any + + --- @param a string[] + function takesArray(a) end + "#, + ); + assert!(ws.check_code_for( + DiagnosticCode::ParamTypeNotMatch, + r#" + takesArray({} --[[@as A]]) + "# + )); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/array_type_check.rs b/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/array_type_check.rs index 411693104..4a101db3d 100644 --- a/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/array_type_check.rs +++ b/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/array_type_check.rs @@ -1,4 +1,5 @@ use crate::{ + find_index_operations, semantic::type_check::{check_general_type_compact, type_check_guard::TypeCheckGuard}, DbIndex, LuaMemberKey, LuaMemberOwner, LuaType, TypeCheckFailReason, TypeCheckResult, TypeOps, }; @@ -63,12 +64,47 @@ pub fn check_array_type_compact( } } LuaType::Any => return Ok(()), + LuaType::Ref(_) | LuaType::Def(_) => { + return check_array_type_compact_ref_def( + db, + &source_base, + compact_type, + check_guard.next_level()?, + ); + } _ => {} } Err(TypeCheckFailReason::DonotCheck) } +fn check_array_type_compact_ref_def( + db: &DbIndex, + source_base: &LuaType, + compact_type: &LuaType, + check_guard: TypeCheckGuard, +) -> TypeCheckResult { + let Some(members) = find_index_operations(db, compact_type) else { + return Err(TypeCheckFailReason::TypeNotMatch); + }; + + for member in &members { + match &member.key { + LuaMemberKey::ExprType(key_type) => { + if key_type.is_integer() { + match check_general_type_compact(db, source_base, &member.typ, check_guard) { + Ok(()) => return Ok(()), + _ => {} + } + } + } + _ => {} + } + } + + Err(TypeCheckFailReason::TypeNotMatch) +} + fn check_array_type_compact_table( db: &DbIndex, source_base: &LuaType, From f1984c2cfe469c4546729bfb3f08875d04a993aa Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Mon, 7 Jul 2025 14:00:49 +0800 Subject: [PATCH 51/54] fix #574 --- .../diagnostic/test/param_type_check_test.rs | 24 ++++ .../complex_type/intersection_type_check.rs | 114 ++++++++++++++++++ .../semantic/type_check/complex_type/mod.rs | 16 ++- 3 files changed, 151 insertions(+), 3 deletions(-) create mode 100644 crates/emmylua_code_analysis/src/semantic/type_check/complex_type/intersection_type_check.rs diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs index 13f90d461..1b9e6e071 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/param_type_check_test.rs @@ -1188,4 +1188,28 @@ mod test { "# )); } + + #[test] + fn test_issue_574() { + let mut ws = VirtualWorkspace::new(); + ws.def( + r#" + --- @param x { y: integer } & { z: string } + function foo(x) end + "#, + ); + assert!(!ws.check_code_for( + DiagnosticCode::ParamTypeNotMatch, + r#" + foo({y = "", z = ""}) + "# + )); + + assert!(ws.check_code_for( + DiagnosticCode::ParamTypeNotMatch, + r#" + foo({y = 1, z = ""}) + "# + )); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/intersection_type_check.rs b/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/intersection_type_check.rs new file mode 100644 index 000000000..819130df2 --- /dev/null +++ b/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/intersection_type_check.rs @@ -0,0 +1,114 @@ +use crate::{ + semantic::type_check::{check_general_type_compact, type_check_guard::TypeCheckGuard}, + DbIndex, LuaIntersectionType, LuaMemberOwner, LuaType, TypeCheckFailReason, TypeCheckResult, +}; + +pub fn check_intersection_type_compact( + db: &DbIndex, + source_intersection: &LuaIntersectionType, + compact_type: &LuaType, + check_guard: TypeCheckGuard, +) -> TypeCheckResult { + match compact_type { + LuaType::TableConst(range) => check_intersection_type_compact_table( + db, + source_intersection, + LuaMemberOwner::Element(range.clone()), + check_guard.next_level()?, + ), + LuaType::Object(_) => { + // 检查对象是否满足交叉类型的所有组成部分 + for intersection_component in source_intersection.get_types() { + check_general_type_compact( + db, + intersection_component, + compact_type, + check_guard.next_level()?, + )?; + } + Ok(()) + } + LuaType::Intersection(compact_intersection) => { + // 交叉类型对交叉类型：检查所有组成部分 + check_intersection_type_compact_intersection( + db, + source_intersection, + compact_intersection, + check_guard.next_level()?, + ) + } + LuaType::Table => Ok(()), // 通用表类型可以匹配任何交叉类型 + _ => { + // 对于其他类型，检查是否至少满足一个组成部分 + for intersection_component in source_intersection.get_types() { + if check_general_type_compact( + db, + intersection_component, + compact_type, + check_guard.next_level()?, + ) + .is_ok() + { + return Ok(()); + } + } + Err(TypeCheckFailReason::TypeNotMatch) + } + } +} + +fn check_intersection_type_compact_table( + db: &DbIndex, + source_intersection: &LuaIntersectionType, + table_owner: LuaMemberOwner, + check_guard: TypeCheckGuard, +) -> TypeCheckResult { + // 交叉类型要求 TableConst 必须满足所有组成部分 + for intersection_component in source_intersection.get_types() { + check_general_type_compact( + db, + intersection_component, + &LuaType::TableConst( + table_owner + .get_element_range() + .ok_or(TypeCheckFailReason::TypeNotMatch)? + .clone(), + ), + check_guard.next_level()?, + )?; + } + + Ok(()) +} + +fn check_intersection_type_compact_intersection( + db: &DbIndex, + source_intersection: &LuaIntersectionType, + compact_intersection: &LuaIntersectionType, + check_guard: TypeCheckGuard, +) -> TypeCheckResult { + // 检查源交叉类型的每个组成部分是否都能在目标交叉类型中找到匹配 + for source_component in source_intersection.get_types() { + let mut component_matched = false; + + for compact_component in compact_intersection.get_types() { + if check_general_type_compact( + db, + source_component, + compact_component, + check_guard.next_level()?, + ) + .is_ok() + { + component_matched = true; + break; + } + } + + if !component_matched { + return Err(TypeCheckFailReason::TypeNotMatch); + } + } + + Ok(()) +} diff --git a/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/mod.rs b/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/mod.rs index 841303fda..72e42488d 100644 --- a/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/mod.rs +++ b/crates/emmylua_code_analysis/src/semantic/type_check/complex_type/mod.rs @@ -1,9 +1,11 @@ mod array_type_check; +mod intersection_type_check; mod object_type_check; mod table_generic_check; mod tuple_type_check; use array_type_check::check_array_type_compact; +use intersection_type_check::check_intersection_type_compact; use object_type_check::check_object_type_compact; use table_generic_check::check_table_generic_type_compact; use tuple_type_check::check_tuple_type_compact; @@ -52,6 +54,17 @@ pub fn check_complex_type_compact( result => return result, } } + LuaType::Intersection(source_intersection) => { + match check_intersection_type_compact( + db, + source_intersection, + compact_type, + check_guard, + ) { + Err(TypeCheckFailReason::DonotCheck) => {} + result => return result, + } + } LuaType::Union(union_type) => { match compact_type { LuaType::Union(compact_union) => { @@ -92,9 +105,6 @@ pub fn check_complex_type_compact( check_guard.next_level()?, ); } - - // check later - LuaType::Intersection(_) => return Ok(()), _ => {} } // Do I need to check union types? From e45282d63d3e6963c9fbfa4a1ed8b8753217edd7 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Thu, 10 Jul 2025 00:15:56 +0800 Subject: [PATCH 52/54] optimize semantic token --- .../handlers/semantic_token/build_semantic_tokens.rs | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs index e1ade36bb..67f29b931 100644 --- a/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs +++ b/crates/emmylua_ls/src/handlers/semantic_token/build_semantic_tokens.rs @@ -337,12 +337,11 @@ fn build_node_semantic_token( ); } LuaAst::LuaNameExpr(name_expr) => { - handle_name_node( - semantic_model, - builder, - name_expr.syntax(), - &name_expr.get_name_token()?, - ); + let name_token = name_expr.get_name_token()?; + handle_name_node(semantic_model, builder, name_expr.syntax(), &name_token) + .unwrap_or_else(|| { + builder.push(name_token.syntax(), SemanticTokenType::VARIABLE); + }); } LuaAst::LuaForRangeStat(for_range_stat) => { for name in for_range_stat.get_var_name_list() { From 51c1753f1a4d832fe2abba7b80527d9ddb0a6078 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Thu, 10 Jul 2025 23:39:51 +0800 Subject: [PATCH 53/54] update typecheck: generic type match --- .../test/return_type_mismatch_test.rs | 26 +++++++++++++++++++ .../src/semantic/type_check/generic_type.rs | 10 +++++-- 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs b/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs index 5cfe7fc8a..6ecc595c9 100644 --- a/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs +++ b/crates/emmylua_code_analysis/src/diagnostic/test/return_type_mismatch_test.rs @@ -470,4 +470,30 @@ mod tests { "# )); } + + #[test] + fn test_generic_type_1() { + let mut ws = VirtualWorkspace::new(); + ws.def( + r#" + ---@class Range: Observable + ---@class Observable + + ---@return Range + function newRange() + end + "#, + ); + assert!(ws.check_code_for( + DiagnosticCode::ReturnTypeMismatch, + r#" + + ---@return Observable + function range() + return newRange() + end + + "# + )); + } } diff --git a/crates/emmylua_code_analysis/src/semantic/type_check/generic_type.rs b/crates/emmylua_code_analysis/src/semantic/type_check/generic_type.rs index c04c26dec..0dad15e70 100644 --- a/crates/emmylua_code_analysis/src/semantic/type_check/generic_type.rs +++ b/crates/emmylua_code_analysis/src/semantic/type_check/generic_type.rs @@ -6,8 +6,8 @@ use crate::{ }; use super::{ - check_general_type_compact, type_check_fail_reason::TypeCheckFailReason, - type_check_guard::TypeCheckGuard, TypeCheckResult, + check_general_type_compact, check_ref_type_compact, + type_check_fail_reason::TypeCheckFailReason, type_check_guard::TypeCheckGuard, TypeCheckResult, }; pub fn check_generic_type_compact( @@ -53,6 +53,12 @@ pub fn check_generic_type_compact( LuaMemberOwner::Element(range.clone()), check_guard.next_level()?, ), + LuaType::Ref(_) | LuaType::Def(_) => check_ref_type_compact( + db, + &source_generic.get_base_type_id(), + compact_type, + check_guard.next_level()?, + ), _ => Err(TypeCheckFailReason::TypeNotMatch), } } From 30d16f404e33f9ac2161112380386717c2cf6a08 Mon Sep 17 00:00:00 2001 From: xuhuanzy <501417909@qq.com> Date: Fri, 11 Jul 2025 00:14:03 +0800 Subject: [PATCH 54/54] fix hover doc function --- .../src/handlers/hover/function_humanize.rs | 3 +- .../src/handlers/test/hover_function_test.rs | 31 +++++++++++++++++++ 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/crates/emmylua_ls/src/handlers/hover/function_humanize.rs b/crates/emmylua_ls/src/handlers/hover/function_humanize.rs index 4dc527c8c..b0962a650 100644 --- a/crates/emmylua_ls/src/handlers/hover/function_humanize.rs +++ b/crates/emmylua_ls/src/handlers/hover/function_humanize.rs @@ -259,14 +259,13 @@ fn hover_doc_function_type( } else { func_name.to_string() }; - let params = lua_func .get_params() .iter() .enumerate() .map(|(index, param)| { let name = param.0.clone(); - if index == 0 && is_method { + if index == 0 && is_method && !lua_func.is_colon_define() { "".to_string() } else if let Some(ty) = ¶m.1 { format!("{}: {}", name, humanize_type(db, ty, RenderLevel::Normal)) diff --git a/crates/emmylua_ls/src/handlers/test/hover_function_test.rs b/crates/emmylua_ls/src/handlers/test/hover_function_test.rs index d8ef171aa..399e488b2 100644 --- a/crates/emmylua_ls/src/handlers/test/hover_function_test.rs +++ b/crates/emmylua_ls/src/handlers/test/hover_function_test.rs @@ -394,4 +394,35 @@ mod tests { }, )); } + + #[test] + fn test_generic_function() { + let mut ws = ProviderVirtualWorkspace::new(); + ws.def_file( + "test.lua", + r#" + ---@class Observable + local Observable + + ---@generic R + ---@param selector fun(value: T, index?: integer): R + function Observable:select(selector) + end + + ---@type Observable + source = {} + + "#, + ); + assert!(ws.check_hover( + r#" + source:select(function(value) + return value + end) + "#, + VirtualHoverResult { + value: "```lua\n(method) Observable:select(selector: fun(value: integer, index: integer?) -> R)\n```".to_string(), + }, + )); + } }