feat(analyzer): add return, method, and iterator issue categories

This commit further expands the issue categorization system to provide users with more fine-grained control over the analysis.

Three new categories have been introduced:
- **`return_issues`**: Groups all diagnostics related to function and method return values.
- **`method_issues`**: Groups all diagnostics related to method access, visibility, and usage.
- **`iterator_issues`**: Groups all diagnostics related to iterating over expressions, such as in `foreach` loops.

These new categories can be disabled in `mago.toml`, allowing users to tailor the analysis more precisely to their project's needs.

Signed-off-by: azjezz <[email protected]>

Author: azjezz

crates/analyzer/src/code.rs

@@ -964,6 +964,96 @@ impl IssueCode {
             "undefined-string-array-index",
         ]
     }
+
+    pub const fn get_return_issue_codes() -> [Self; 9] {
+        [
+            Self::FalsableReturnStatement,
+            Self::HiddenGeneratorReturn,
+            Self::InvalidGeneratorReturnType,
+            Self::InvalidReturnStatement,
+            Self::LessSpecificNestedReturnStatement,
+            Self::LessSpecificReturnStatement,
+            Self::MixedReturnStatement,
+            Self::NeverReturn,
+            Self::NullableReturnStatement,
+        ]
+    }
+
+    pub const fn get_return_issue_code_values() -> [&'static str; 9] {
+        [
+            "falsable-return-statement",
+            "hidden-generator-return",
+            "invalid-generator-return-type",
+            "invalid-return-statement",
+            "less-specific-nested-return-statement",
+            "less-specific-return-statement",
+            "mixed-return-statement",
+            "never-return",
+            "nullable-return-statement",
+        ]
+    }
+
+    pub const fn get_method_issue_codes() -> [Self; 11] {
+        [
+            Self::AmbiguousObjectMethodAccess,
+            Self::DeprecatedMethod,
+            Self::InvalidMethodAccess,
+            Self::InvalidStaticMethodAccess,
+            Self::InvalidStaticMethodCall,
+            Self::MethodAccessOnNull,
+            Self::MixedMethodAccess,
+            Self::NonExistentMethod,
+            Self::PossibleMethodAccessOnNull,
+            Self::UnimplementedAbstractMethod,
+            Self::UnusedMethodCall,
+        ]
+    }
+
+    pub const fn get_method_issue_code_values() -> [&'static str; 11] {
+        [
+            "ambiguous-object-method-access",
+            "deprecated-method",
+            "invalid-method-access",
+            "invalid-static-method-access",
+            "invalid-static-method-call",
+            "method-access-on-null",
+            "mixed-method-access",
+            "non-existent-method",
+            "possible-method-access-on-null",
+            "unimplemented-abstract-method",
+            "unused-method-call",
+        ]
+    }
+
+    pub const fn get_iterator_issue_codes() -> [Self; 10] {
+        [
+            Self::FalseIterator,
+            Self::InvalidIterator,
+            Self::NonIterableObjectIteration,
+            Self::NullIterator,
+            Self::PossiblyFalseIterator,
+            Self::PossiblyInvalidIterator,
+            Self::PossiblyNullIterator,
+            Self::UnknownIteratorType,
+            Self::UnknownYieldFromIteratorType,
+            Self::YieldFromNonIterable,
+        ]
+    }
+
+    pub const fn get_iterator_issue_code_values() -> [&'static str; 10] {
+        [
+            "false-iterator",
+            "invalid-iterator",
+            "non-iterable-object-iteration",
+            "null-iterator",
+            "possibly-false-iterator",
+            "possibly-invalid-iterator",
+            "possibly-null-iterator",
+            "unknown-iterator-type",
+            "unknown-yield-from-iterator-type",
+            "yield-from-non-iterable",
+        ]
+    }
 }
 
 impl std::str::FromStr for IssueCode {

crates/analyzer/src/lib.rs

@@ -135,6 +135,18 @@ impl<'a> Analyzer<'a> {
             collector.add_disabled_codes(IssueCode::get_array_issue_code_values());
         }
 
+        if !self.settings.return_issues {
+            collector.add_disabled_codes(IssueCode::get_return_issue_code_values());
+        }
+
+        if !self.settings.method_issues {
+            collector.add_disabled_codes(IssueCode::get_method_issue_code_values());
+        }
+
+        if !self.settings.iterator_issues {
+            collector.add_disabled_codes(IssueCode::get_iterator_issue_code_values());
+        }
+
         let mut context = {
             Context::new(
                 self.interner,

crates/analyzer/src/settings.rs

@@ -57,6 +57,15 @@ pub struct Settings {
     /// Report all issues related to array operations and usage. Defaults to `true`.
     pub array_issues: bool,
 
+    /// Report issues related to the return type of functions and methods. Defaults to `true`.
+    pub return_issues: bool,
+
+    /// Report issues related to methods and their usage. Defaults to `true`.
+    pub method_issues: bool,
+
+    /// Report issues related to iterators and their usage. Defaults to `true`.
+    pub iterator_issues: bool,
+
     /// Find and report expressions whose results are not used (e.g., `$a + $b;`). Defaults to `false`.
     pub find_unused_expressions: bool,
 
@@ -123,6 +132,9 @@ impl Settings {
             property_issues: true,
             generator_issues: true,
             array_issues: true,
+            return_issues: true,
+            method_issues: true,
+            iterator_issues: true,
             find_unused_expressions: false,
             find_unused_definitions: false,
             analyze_dead_code: false,

src/config/analyzer.rs

@@ -65,6 +65,15 @@ pub struct AnalyzeConfiguration {
     /// Report all issues related to array operations and usage.
     pub array_issues: bool,
 
+    /// Report issues related to the return type of functions and methods.
+    pub return_issues: bool,
+
+    /// Report issues related to methods and their usage.
+    pub method_issues: bool,
+
+    /// Report issues related to iterators and their usage.
+    pub iterator_issues: bool,
+
     /// Whether to find unused expressions.
     pub find_unused_expressions: bool,
 
@@ -113,6 +122,9 @@ impl AnalyzeConfiguration {
             property_issues: self.property_issues,
             generator_issues: self.generator_issues,
             array_issues: self.array_issues,
+            return_issues: self.return_issues,
+            method_issues: self.method_issues,
+            iterator_issues: self.iterator_issues,
             analyze_dead_code: self.analyze_dead_code,
             find_unused_definitions: self.find_unused_definitions,
             find_unused_expressions: self.find_unused_expressions,
@@ -152,6 +164,9 @@ impl ConfigurationEntry for AnalyzeConfiguration {
             .set_default("analyze.property_issues", defaults.property_issues)?
             .set_default("analyze.generator_issues", defaults.generator_issues)?
             .set_default("analyze.array_issues", defaults.array_issues)?
+            .set_default("analyze.return_issues", defaults.return_issues)?
+            .set_default("analyze.method_issues", defaults.method_issues)?
+            .set_default("analyze.iterator_issues", defaults.iterator_issues)?
             .set_default("analyze.find_unused_definitions", defaults.find_unused_definitions)?
             .set_default("analyze.find_unused_expressions", defaults.find_unused_expressions)?
             .set_default("analyze.analyze_dead_code", defaults.analyze_dead_code)?
@@ -187,6 +202,9 @@ impl Default for AnalyzeConfiguration {
             property_issues: defaults.property_issues,
             generator_issues: defaults.generator_issues,
             array_issues: defaults.array_issues,
+            return_issues: defaults.return_issues,
+            method_issues: defaults.method_issues,
+            iterator_issues: defaults.iterator_issues,
             find_unused_expressions: defaults.find_unused_expressions,
             find_unused_definitions: defaults.find_unused_definitions,
             analyze_dead_code: defaults.analyze_dead_code,