Merge branch 'master' of https://github.com/dart-code-checker/dart-code-metrics

Author: incendial

CHANGELOG.md

@@ -3,6 +3,10 @@
 ## Unreleased
 
 * fix: handle dynamics in map literals for [`avoid-dynamic`](https://dcm.dev/docs/individuals/rules/common/avoid-dynamic).
+* fix: change anti-patterns default severity to `warning`.
+* feat: add static code diagnostic [`prefer-define-hero-tag`](https://dcm.dev/docs/individuals/rules/common/prefer-define-hero-tag).
+* chore: restrict `analyzer` version to `>=5.1.0 <5.8.0`.
+* feat: add static code diagnostic [`avoid-substring`](https://dcm.dev/docs/individuals/rules/common/avoid-substring).
 
 ## 5.6.0
 

README.md

@@ -70,7 +70,6 @@ analyzer:
 dart_code_metrics:
   rules:
     - avoid-dynamic
-    - avoid-redundant-async
     - avoid-passing-async-when-sync-expected
     - avoid-redundant-async
     - avoid-unnecessary-type-assertions
@@ -104,7 +103,6 @@ dart_code_metrics:
     - test/**
   rules:
     - avoid-dynamic
-    - avoid-redundant-async
     - avoid-passing-async-when-sync-expected
     - avoid-redundant-async
     - avoid-unnecessary-type-assertions

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_method.dart

@@ -34,7 +34,7 @@ class LongMethod extends Pattern {
         ),
         super(
           id: patternId,
-          severity: readSeverity(patternSettings, Severity.none),
+          severity: readSeverity(patternSettings, Severity.warning),
           excludes: readExcludes(patternSettings),
         );
 

lib/src/analyzers/lint_analyzer/anti_patterns/anti_patterns_list/long_parameter_list.dart

@@ -32,7 +32,7 @@ class LongParameterList extends Pattern {
         ),
         super(
           id: patternId,
-          severity: readSeverity(patternSettings, Severity.none),
+          severity: readSeverity(patternSettings, Severity.warning),
           excludes: readExcludes(patternSettings),
         );
 

lib/src/analyzers/lint_analyzer/rules/rules_factory.dart

@@ -24,6 +24,7 @@ import 'rules_list/avoid_redundant_async/avoid_redundant_async_rule.dart';
 import 'rules_list/avoid_redundant_async_on_load/avoid_redundant_async_on_load_rule.dart';
 import 'rules_list/avoid_returning_widgets/avoid_returning_widgets_rule.dart';
 import 'rules_list/avoid_shrink_wrap_in_lists/avoid_shrink_wrap_in_lists_rule.dart';
+import 'rules_list/avoid_substring/avoid_substring_rule.dart';
 import 'rules_list/avoid_throw_in_catch_block/avoid_throw_in_catch_block_rule.dart';
 import 'rules_list/avoid_top_level_members_in_tests/avoid_top_level_members_in_tests_rule.dart';
 import 'rules_list/avoid_unnecessary_conditionals/avoid_unnecessary_conditionals_rule.dart';
@@ -59,6 +60,7 @@ import 'rules_list/prefer_correct_edge_insets_constructor/prefer_correct_edge_in
 import 'rules_list/prefer_correct_identifier_length/prefer_correct_identifier_length_rule.dart';
 import 'rules_list/prefer_correct_test_file_name/prefer_correct_test_file_name_rule.dart';
 import 'rules_list/prefer_correct_type_name/prefer_correct_type_name_rule.dart';
+import 'rules_list/prefer_define_hero_tag/prefer_define_hero_tag_rule.dart';
 import 'rules_list/prefer_enums_by_name/prefer_enums_by_name_rule.dart';
 import 'rules_list/prefer_extracting_callbacks/prefer_extracting_callbacks_rule.dart';
 import 'rules_list/prefer_first/prefer_first_rule.dart';
@@ -107,6 +109,7 @@ final _implementedRules = <String, Rule Function(Map<String, Object>)>{
   AvoidRedundantAsyncOnLoadRule.ruleId: AvoidRedundantAsyncOnLoadRule.new,
   AvoidReturningWidgetsRule.ruleId: AvoidReturningWidgetsRule.new,
   AvoidShrinkWrapInListsRule.ruleId: AvoidShrinkWrapInListsRule.new,
+  AvoidSubstringRule.ruleId: AvoidSubstringRule.new,
   AvoidThrowInCatchBlockRule.ruleId: AvoidThrowInCatchBlockRule.new,
   AvoidTopLevelMembersInTestsRule.ruleId: AvoidTopLevelMembersInTestsRule.new,
   AvoidUnnecessaryConditionalsRule.ruleId: AvoidUnnecessaryConditionalsRule.new,
@@ -149,6 +152,7 @@ final _implementedRules = <String, Rule Function(Map<String, Object>)>{
       PreferCorrectIdentifierLengthRule.new,
   PreferCorrectTestFileNameRule.ruleId: PreferCorrectTestFileNameRule.new,
   PreferCorrectTypeNameRule.ruleId: PreferCorrectTypeNameRule.new,
+  PreferDefineHeroTagRule.ruleId: PreferDefineHeroTagRule.new,
   PreferEnumsByNameRule.ruleId: PreferEnumsByNameRule.new,
   PreferExtractingCallbacksRule.ruleId: PreferExtractingCallbacksRule.new,
   PreferFirstRule.ruleId: PreferFirstRule.new,

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

@@ -38,6 +38,7 @@ class _Visitor extends RecursiveAstVisitor<void> {
       !_isEmptyFutureOrType(type);
 
   bool _isEmptyType(DartType type) =>
+      // ignore: deprecated_member_use
       type.isBottom || type.isDartCoreNull || type.isVoid;
 
   bool _isEmptyFutureType(DartType type) =>

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_substring/avoid_substring_rule.dart

@@ -0,0 +1,47 @@
+// ignore_for_file: public_member_api_docs
+
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer/dart/ast/visitor.dart';
+
+import '../../../../../utils/node_utils.dart';
+import '../../../lint_utils.dart';
+import '../../../models/internal_resolved_unit_result.dart';
+import '../../../models/issue.dart';
+import '../../../models/severity.dart';
+import '../../models/common_rule.dart';
+import '../../rule_utils.dart';
+
+part 'visitor.dart';
+
+class AvoidSubstringRule extends CommonRule {
+  static const String ruleId = 'avoid-substring';
+
+  static const _warning =
+      'Avoid using substring if you are having emojis in the string. Consider using characters.getRange instead.';
+
+  AvoidSubstringRule([Map<String, Object> config = const {}])
+      : super(
+          id: ruleId,
+          severity: readSeverity(config, Severity.warning),
+          excludes: readExcludes(config),
+          includes: readIncludes(config),
+        );
+
+  @override
+  Iterable<Issue> check(InternalResolvedUnitResult source) {
+    final visitor = _Visitor();
+
+    source.unit.visitChildren(visitor);
+
+    return visitor.expressions
+        .map((expression) => createIssue(
+              rule: this,
+              location: nodeLocation(
+                node: expression,
+                source: source,
+              ),
+              message: _warning,
+            ))
+        .toList(growable: false);
+  }
+}

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

@@ -0,0 +1,19 @@
+part of 'avoid_substring_rule.dart';
+
+class _Visitor extends RecursiveAstVisitor<void> {
+  final _expressions = <Expression>[];
+
+  Iterable<Expression> get expressions => _expressions;
+
+  @override
+  void visitMethodInvocation(MethodInvocation node) {
+    super.visitMethodInvocation(node);
+    if (_isNotSubstringMethod(node)) {
+      return;
+    }
+    _expressions.add(node);
+  }
+
+  bool _isNotSubstringMethod(MethodInvocation node) =>
+      node.methodName.name != 'substring';
+}

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

@@ -97,6 +97,7 @@ class _ReturnVisitor extends RecursiveAstVisitor<void> {
 
     final type = node.expression?.staticType;
 
+    // ignore: deprecated_member_use
     if (type == null || type.isVoid) {
       _hasValidReturn = true;
     }

lib/src/analyzers/lint_analyzer/rules/rules_list/prefer_define_hero_tag/prefer_define_hero_tag_rule.dart

@@ -0,0 +1,41 @@
+// ignore_for_file: public_member_api_docs
+
+import 'package:analyzer/dart/ast/ast.dart';
+import 'package:analyzer/dart/ast/visitor.dart';
+
+import '../../../../../utils/node_utils.dart';
+import '../../../lint_utils.dart';
+import '../../../models/internal_resolved_unit_result.dart';
+import '../../../models/issue.dart';
+import '../../../models/severity.dart';
+import '../../models/flutter_rule.dart';
+import '../../rule_utils.dart';
+
+part 'visitor.dart';
+
+class PreferDefineHeroTagRule extends FlutterRule {
+  static const ruleId = 'prefer-define-hero-tag';
+  static const _issueMessage = 'Prefer define heroTag property.';
+
+  PreferDefineHeroTagRule([Map<String, Object> config = const {}])
+      : super(
+          id: ruleId,
+          severity: readSeverity(config, Severity.warning),
+          excludes: readExcludes(config),
+          includes: readIncludes(config),
+        );
+
+  @override
+  Iterable<Issue> check(InternalResolvedUnitResult source) {
+    final visitor = _Visitor();
+    source.unit.visitChildren(visitor);
+
+    return visitor.invocations
+        .map((invocation) => createIssue(
+              rule: this,
+              location: nodeLocation(node: invocation, source: source),
+              message: _issueMessage,
+            ))
+        .toList(growable: false);
+  }
+}