Merge remote-tracking branch 'EmmyLuaLs/main' into Generics

Author: xuhuanzy

CHANGELOG.md

@@ -4,6 +4,24 @@
 
 ---
 
+## [0.15.0] - 2025-10-10
+
+### ✨ Added
+- **Use Clippy as linter**: core codebase now uses Clippy as the linter, improving code quality and consistency.
+- **Support `textdocument/diagnostic`**: Added support for the `textDocument/diagnostic` request, allowing clients to fetch diagnostics for a specific document.
+- **Support annotation `@readonly`**: You can now use the `@readonly` annotation to mark fields as read-only. For example:
+```lua
+---@readonly
+local myVar = 42
+```
+- **Add check for `global in non module`**: Added a new diagnostic to check for global variable declarations in non-module scope. This helps detect unintended global variable declarations.
+
+### 🔧 Changed
+- **Optimize semantic token**: Optimized semantic token handling for delimiter symbols.
+
+### 🐛 Fixed
+- **Fix generic pattern matching issue**: Fixed an issue where generic pattern matching aliases could lead to incorrect type inference.
+
 ## [0.14.0] - 2025-9-19
 
 ### 🔧 Changed

Cargo.lock

@@ -7,9 +7,9 @@ members = [
 
 [workspace.dependencies]
 # local
-emmylua_code_analysis = { path = "crates/emmylua_code_analysis", version = "0.14.0" }
-emmylua_parser = { path = "crates/emmylua_parser", version = "0.16.0" }
-emmylua_parser_desc = { path = "crates/emmylua_parser_desc", version = "0.16.0" }
+emmylua_code_analysis = { path = "crates/emmylua_code_analysis", version = "0.15.0" }
+emmylua_parser = { path = "crates/emmylua_parser", version = "0.17.0" }
+emmylua_parser_desc = { path = "crates/emmylua_parser_desc", version = "0.17.0" }
 emmylua_diagnostic_macro = { path = "crates/emmylua_diagnostic_macro", version = "0.5.0" }
 
 # external

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "emmylua_check"
-version = "0.14.0"
+version = "0.15.0"
 edition = "2024"
 authors = ["CppCXY"]
 description = "A command-line tool for checking lua code."

crates/emmylua_check/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "emmylua_code_analysis"
-version = "0.14.0"
+version = "0.15.0"
 edition = "2024"
 authors = ["CppCXY"]
 description = "A library for analyzing lua code."

crates/emmylua_code_analysis/Cargo.toml

@@ -430,6 +430,11 @@
           "description": "readonly",
           "type": "string",
           "const": "read-only"
+        },
+        {
+          "description": "Global variable defined in non-module scope",
+          "type": "string",
+          "const": "global-in-non-module"
         }
       ]
     },

crates/emmylua_code_analysis/resources/schema.json

@@ -0,0 +1,74 @@
+use emmylua_parser::{LuaAssignStat, LuaAst, LuaAstNode, LuaBlock, LuaVarExpr};
+
+use crate::{DiagnosticCode, LuaDeclId, SemanticModel};
+
+use super::{Checker, DiagnosticContext};
+
+pub struct GlobalInNonModuleChecker;
+
+impl Checker for GlobalInNonModuleChecker {
+    const CODES: &[DiagnosticCode] = &[DiagnosticCode::GlobalInNonModule];
+
+    fn check(context: &mut DiagnosticContext, semantic_model: &SemanticModel) {
+        let root = semantic_model.get_root().clone();
+        for assign_stat in root.descendants::<LuaAssignStat>() {
+            check_assign_stat(context, semantic_model, assign_stat);
+        }
+    }
+}
+
+fn check_assign_stat(
+    context: &mut DiagnosticContext,
+    semantic_model: &SemanticModel,
+    assign_stat: LuaAssignStat,
+) -> Option<()> {
+    let file_id = semantic_model.get_file_id();
+
+    let (vars, _) = assign_stat.get_var_and_expr_list();
+    for var in vars {
+        let decl_id = LuaDeclId::new(file_id, var.get_position());
+        if let Some(decl) = semantic_model.get_db().get_decl_index().get_decl(&decl_id)
+            && decl.is_global()
+            && is_global_define_in_non_module_scope(semantic_model, var.clone(), decl_id)
+        {
+            context.add_diagnostic(
+                DiagnosticCode::GlobalInNonModule,
+                var.get_range(),
+                t!("Global variable should only be defined in module scope").to_string(),
+                None,
+            );
+        }
+    }
+
+    Some(())
+}
+
+fn is_global_define_in_non_module_scope(
+    semantic_model: &SemanticModel,
+    var: LuaVarExpr,
+    decl_id: LuaDeclId,
+) -> bool {
+    for block in var.ancestors::<LuaBlock>() {
+        let parent = block.get_parent::<LuaAst>();
+        match parent {
+            Some(LuaAst::LuaChunk(_)) => {
+                return false;
+            }
+            Some(LuaAst::LuaClosureExpr(_)) => {
+                break;
+            }
+            _ => {}
+        }
+    }
+
+    let name = var.get_text();
+    let Some(global_id) = semantic_model
+        .get_db()
+        .get_global_index()
+        .resolve_global_decl_id(semantic_model.get_db(), &name)
+    else {
+        return true;
+    };
+
+    global_id == decl_id
+}

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

@@ -17,6 +17,7 @@ mod duplicate_require;
 mod duplicate_type;
 mod enum_value_mismatch;
 mod generic;
+mod global_in_non_module;
 mod incomplete_signature_doc;
 mod local_const_reassign;
 mod missing_fields;
@@ -120,6 +121,7 @@ pub fn check_file(context: &mut DiagnosticContext, semantic_model: &SemanticMode
         semantic_model,
     );
     run_check::<readonly_check::ReadOnlyChecker>(context, semantic_model);
+    run_check::<global_in_non_module::GlobalInNonModuleChecker>(context, semantic_model);
     Some(())
 }
 

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

@@ -105,6 +105,8 @@ pub enum DiagnosticCode {
     PreferredLocalAlias,
     /// readonly
     ReadOnly,
+    /// Global variable defined in non-module scope
+    GlobalInNonModule,
 
     #[serde(other)]
     None,

crates/emmylua_code_analysis/src/diagnostic/lua_diagnostic_code.rs

@@ -0,0 +1,17 @@
+#[cfg(test)]
+mod tests {
+    use crate::{DiagnosticCode, VirtualWorkspace};
+
+    #[test]
+    fn test_global_in_non_module() {
+        let mut ws = VirtualWorkspace::new();
+        assert!(!ws.check_code_for(
+            DiagnosticCode::GlobalInNonModule,
+            r#"
+            local function name()
+                bbbb = 123
+            end
+        "#
+        ));
+    }
+}