Merge 80714e4 into b8f190c

Author: incendial

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+* feat: add `strict` config option to [`avoid-collection-methods-with-unrelated-types`](https://dartcodemetrics.dev/docs/rules/common/avoid-collection-methods-with-unrelated-types).
+
 ## 5.2.1
 
 * fix: avoid null check exception in the analyzer.

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_collection_methods_with_unrelated_types/avoid_collection_methods_with_unrelated_types_rule.dart

@@ -16,16 +16,20 @@ import '../../../models/severity.dart';
 import '../../models/common_rule.dart';
 import '../../rule_utils.dart';
 
+part 'config_parser.dart';
 part 'visitor.dart';
 
 class AvoidCollectionMethodsWithUnrelatedTypesRule extends CommonRule {
   static const String ruleId = 'avoid-collection-methods-with-unrelated-types';
 
   static const _warning = 'Avoid collection methods with unrelated types.';
 
+  final bool _isStrictMode;
+
   AvoidCollectionMethodsWithUnrelatedTypesRule([
     Map<String, Object> config = const {},
-  ]) : super(
+  ])  : _isStrictMode = _ConfigParser.parseIsStrictMode(config),
+        super(
           id: ruleId,
           severity: readSeverity(config, Severity.warning),
           excludes: readExcludes(config),
@@ -34,7 +38,7 @@ class AvoidCollectionMethodsWithUnrelatedTypesRule extends CommonRule {
 
   @override
   Iterable<Issue> check(InternalResolvedUnitResult source) {
-    final visitor = _Visitor();
+    final visitor = _Visitor(_isStrictMode);
 
     source.unit.visitChildren(visitor);
 

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_collection_methods_with_unrelated_types/config_parser.dart

@@ -0,0 +1,8 @@
+part of 'avoid_collection_methods_with_unrelated_types_rule.dart';
+
+class _ConfigParser {
+  static const _strictConfig = 'strict';
+
+  static bool parseIsStrictMode(Map<String, Object> config) =>
+      config[_strictConfig] == null || config[_strictConfig] == true;
+}

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_collection_methods_with_unrelated_types/visitor.dart

@@ -3,8 +3,13 @@ part of 'avoid_collection_methods_with_unrelated_types_rule.dart';
 class _Visitor extends RecursiveAstVisitor<void> {
   final _expressions = <Expression>[];
 
+  final bool _isStrictMode;
+
   Iterable<Expression> get expressions => _expressions;
 
+  // ignore: avoid_positional_boolean_parameters
+  _Visitor(this._isStrictMode);
+
   // for `operator []` and `operator []=`
   @override
   void visitIndexExpression(IndexExpression node) {
@@ -66,13 +71,20 @@ class _Visitor extends RecursiveAstVisitor<void> {
   ) {
     if (parentElement != null &&
         childType != null &&
-        childType.asInstanceOf(parentElement.element) == null &&
+        (_isNotInstance(childType, parentElement) &&
+            _isNotDynamic(childType)) &&
         !(parentElement.type.nullabilitySuffix == NullabilitySuffix.question &&
             childType.isDartCoreNull)) {
       _expressions.add(node);
     }
   }
 
+  bool _isNotInstance(DartType type, _TypedClassElement parentElement) =>
+      type.asInstanceOf(parentElement.element) == null;
+
+  bool _isNotDynamic(DartType type) =>
+      _isStrictMode || !(type.isDynamic || type.isDartCoreObject);
+
   List<_TypedClassElement>? _getMapTypeElement(DartType? type) =>
       _getTypeArgElements(getSupertypeMap(type));
 

test/src/analyzers/lint_analyzer/rules/rules_list/avoid_collection_methods_with_unrelated_types/avoid_collection_methods_with_unrelated_types_rule_test.dart

@@ -8,6 +8,8 @@ const _examplePath =
     'avoid_collection_methods_with_unrelated_types/examples/example.dart';
 const _nullableExamplePath =
     'avoid_collection_methods_with_unrelated_types/examples/nullable_example.dart';
+const _dynamicExamplePath =
+    'avoid_collection_methods_with_unrelated_types/examples/dynamic_example.dart';
 
 void main() {
   group('AvoidCollectionMethodsWithUnrelatedTypesRule', () {
@@ -161,5 +163,33 @@ void main() {
         ],
       );
     });
+
+    test('reports about found issues for dynamic keys', () async {
+      final unit = await RuleTestHelper.resolveFromFile(_dynamicExamplePath);
+      final issues = AvoidCollectionMethodsWithUnrelatedTypesRule().check(unit);
+
+      RuleTestHelper.verifyIssues(
+        issues: issues,
+        startLines: [6, 13],
+        startColumns: [5, 5],
+        locationTexts: [
+          'regularMap[key]',
+          'regularMap[key]',
+        ],
+        messages: [
+          'Avoid collection methods with unrelated types.',
+          'Avoid collection methods with unrelated types.',
+        ],
+      );
+    });
+
+    test('reports no issues for dynamic keys if not in strict mode', () async {
+      final unit = await RuleTestHelper.resolveFromFile(_dynamicExamplePath);
+      final issues = AvoidCollectionMethodsWithUnrelatedTypesRule(const {
+        'strict': false,
+      }).check(unit);
+
+      RuleTestHelper.verifyNoIssues(issues);
+    });
   });
 }

test/src/analyzers/lint_analyzer/rules/rules_list/avoid_collection_methods_with_unrelated_types/examples/dynamic_example.dart

@@ -0,0 +1,15 @@
+void main() {
+  {
+    dynamic key = 1;
+
+    final regularMap = Map<int, String>();
+    regularMap[key] = "value"; // LINT
+  }
+
+  {
+    Object? key = 1;
+
+    final regularMap = Map<int, String>();
+    regularMap[key] = "value"; // LINT
+  }
+}

website/docs/rules/common/avoid-collection-methods-with-unrelated-types.mdx

@@ -12,6 +12,19 @@ Related: Dart's built-in `list_remove_unrelated_type` and `iterable_contains_unr
 
 :::
 
+Use `strict` configuration (default is `true`), if you want `dynamic` or `Object` type keys to not trigger the warning.
+
+### ⚙️ Config example {#config-example}
+
+```yaml
+dart_code_metrics:
+  ...
+  rules:
+    ...
+    - avoid-collection-methods-with-unrelated-types:
+        strict: false
+```
+
 ### Example {#example}
 
 **❌ Bad:**