diagnostic: add undefined_field

Author: xuhuanzy

crates/emmylua_code_analysis/locales/lint.yml

@@ -121,3 +121,8 @@ Cannot use `...` outside a vararg function.:
   en: 'Undefined doc param: `%{name}`'
   zh_CN: '指向了未定义的参数 `%{name}`'
   zh_HK: '指向了未定義的參數 `%{name}`'
+'Undefined field: `%{name}`':
+  en: 'Undefined field: `%{name}`'
+  zh_CN: '未定义字段 `%{name}`'
+  zh_HK: '未定義字段 `%{name}`'
+

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

@@ -16,6 +16,7 @@ mod syntax_error;
 mod undefined_doc_param;
 mod undefined_global;
 mod duplicate_doc_field;
+mod undefined_field;
 mod unused;
 
 use emmylua_parser::{LuaAstNode, LuaClosureExpr, LuaComment, LuaStat, LuaSyntaxKind};
@@ -48,6 +49,7 @@ pub fn check_file(context: &mut DiagnosticContext, semantic_model: &SemanticMode
     check!(unused);
     check!(deprecated);
     check!(undefined_global);
+    check!(undefined_field);
     check!(access_invisible);
     check!(missing_parameter);
     check!(redundant_parameter);

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

@@ -0,0 +1,45 @@
+use emmylua_parser::{LuaAstNode, LuaIndexExpr};
+
+use crate::{DiagnosticCode, LuaMemberOwner, LuaType, SemanticModel};
+
+use super::DiagnosticContext;
+
+pub const CODES: &[DiagnosticCode] = &[DiagnosticCode::UndefinedField];
+
+pub fn check(context: &mut DiagnosticContext, semantic_model: &SemanticModel) -> Option<()> {
+    let root = semantic_model.get_root().clone();
+    for index_expr in root.descendants::<LuaIndexExpr>() {
+        check_index_expr(context, semantic_model, index_expr);
+    }
+
+    Some(())
+}
+
+fn check_index_expr(
+    context: &mut DiagnosticContext,
+    semantic_model: &SemanticModel,
+    index_expr: LuaIndexExpr,
+) -> Option<()> {
+    let db = context.db;
+    let prefix_expr_type = semantic_model.infer_expr(index_expr.get_prefix_expr()?)?;
+    match prefix_expr_type {
+        LuaType::Ref(id) | LuaType::Def(id) => {
+            let member_map = db
+                .get_member_index()
+                .get_member_map(LuaMemberOwner::Type(id.clone()))?;
+            let key = index_expr.get_index_key()?;
+            let member = member_map.get(&key.clone().into());
+            if member.is_none() {
+                context.add_diagnostic(
+                    DiagnosticCode::UndefinedField,
+                    key.clone().get_range()?,
+                    t!("Undefined field: `%{name}`", name = key.get_path_part()).to_string(),
+                    None,
+                );
+            }
+        }
+        _ => {}
+    }
+
+    Some(())
+}

crates/emmylua_code_analysis/src/diagnostic/lua_diagnostic_code.rs

@@ -103,7 +103,7 @@ pub fn is_code_default_enable(code: &DiagnosticCode) -> bool {
     match code {
         DiagnosticCode::InjectFieldFail => false,
         DiagnosticCode::DisableGlobalDefine => false,
-        DiagnosticCode::UndefinedField => false,
+        // DiagnosticCode::UndefinedField => false,
         DiagnosticCode::IterVariableReassign => false,
         DiagnosticCode::CodeStyleCheck => false,
         // ... handle other variants

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

@@ -8,4 +8,5 @@ mod redundant_return_value_test;
 mod disable_line_test;
 mod undefined_doc_param_test;
 mod duplicate_doc_field_test;
+mod undefined_field_test;
 mod return_type_mismatch_test;

crates/emmylua_code_analysis/src/diagnostic/test/undefined_field_test.rs

@@ -0,0 +1,48 @@
+#[cfg(test)]
+mod test {
+    use crate::{DiagnosticCode, VirtualWorkspace};
+
+    #[test]
+    fn test() {
+        let mut ws = VirtualWorkspace::new();
+        assert!(!ws.check_code_for(
+            DiagnosticCode::UndefinedField,
+            r#"
+                ---@class diagnostic.test3
+                ---@field private a number
+
+                ---@type diagnostic.test3
+                local test = {}
+
+                local b = test.b
+            "#
+        ));
+
+        assert!(!ws.check_code_for(
+            DiagnosticCode::UndefinedField,
+            r#"
+                ---@class diagnostic.test3
+                ---@field private a number
+                local Test3 = {}
+
+                local b = Test3.b
+            "#
+        ));
+    }
+
+    #[test]
+    fn test_enum() {
+        let mut ws = VirtualWorkspace::new();
+        assert!(!ws.check_code_for(
+            DiagnosticCode::UndefinedField,
+            r#"
+                ---@enum diagnostic.enum
+                local Enum = {
+                    A = 1,
+                }
+
+                local enum_b = Enum["B"]
+            "#
+        ));
+    }
+}

crates/emmylua_parser/src/syntax/node/lua/mod.rs

@@ -11,6 +11,7 @@ use crate::{
 
 pub use expr::*;
 pub use path_trait::*;
+use rowan::TextRange;
 pub use stat::*;
 
 use super::{LuaLiteralToken, LuaNameToken, LuaNumberToken, LuaStringToken};
@@ -390,6 +391,16 @@ impl LuaIndexKey {
             }
         }
     }
+
+    pub fn get_range(&self) -> Option<TextRange> {
+        match self {
+            LuaIndexKey::Name(token) => Some(token.get_range()),
+            LuaIndexKey::String(token) => Some(token.get_range()),
+            LuaIndexKey::Integer(token) => Some(token.get_range()),
+            LuaIndexKey::Expr(expr) => Some(expr.syntax().text_range()),
+            LuaIndexKey::Idx(_) => None,
+        }
+    }
 }
 
 #[derive(Debug, Clone, PartialEq, Eq, Hash)]