Merge remote-tracking branch 'origin' into avoid-returning-widgets-option

Author: incendial

.github/workflows/package_analyze.yaml

@@ -116,19 +116,6 @@ jobs:
           dart run coverage:format_coverage --in coverage --out coverage/coverage.lcov --lcov --report-on=lib
           bash <(curl -s https://codecov.io/bash) -f coverage/coverage.lcov
 
-      - name: Publish test results
-        uses: dorny/[email protected]
-        if: success() || failure() # run this step even if previous step failed
-        with:
-          name: Tests result
-          path: reports/tests.json
-          reporter: dart-json
-          list-suites: "all"
-          list-tests: "all"
-          max-annotations: 16
-          fail-on-error: true
-          token: ${{ secrets.GITHUB_TOKEN }}
-
   check-minimal-supported-dart-compatibility:
     needs: analysis
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -3,6 +3,8 @@
 ## Unreleased
 
 * feat: add `allow-nullable` config option for [`avoid-returning-widgets`](https://dcm.dev/docs/individuals/rules/common/avoid-returning-widgets).
+* fix: support `assert(mounted)` for [`use-setstate-synchronously`](https://dcm.dev/docs/individuals/rules/flutter/use-setstate-synchronously).
+* fix: correctly support dartdoc tags for [`format-comment`](https://dcm.dev/docs/individuals/rules/common/format-comment).
 
 ## 5.6.0-dev.1
 

lib/src/analyzer_plugin/analyzer_plugin_utils.dart

@@ -1,12 +1,9 @@
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer_plugin/protocol/protocol_common.dart' as plugin;
 import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
-import 'package:source_span/source_span.dart';
 
-import '../analyzers/lint_analyzer/lint_analysis_config.dart';
 import '../analyzers/lint_analyzer/models/issue.dart';
 import '../analyzers/lint_analyzer/models/severity.dart';
-import '../config_builder/models/deprecated_option.dart';
 import '../utils/path_utils.dart';
 
 plugin.AnalysisErrorFixes codeIssueToAnalysisErrorFixes(
@@ -62,67 +59,6 @@ plugin.AnalysisErrorFixes codeIssueToAnalysisErrorFixes(
   );
 }
 
-plugin.AnalysisErrorFixes metricReportToAnalysisErrorFixes(
-  SourceLocation startLocation,
-  int length,
-  String message,
-  String metricId,
-) =>
-    plugin.AnalysisErrorFixes(plugin.AnalysisError(
-      plugin.AnalysisErrorSeverity.INFO,
-      plugin.AnalysisErrorType.LINT,
-      plugin.Location(
-        startLocation.sourceUrl!.path,
-        startLocation.offset,
-        length,
-        startLocation.line,
-        startLocation.column,
-        endLine: startLocation.line,
-        endColumn: startLocation.column,
-      ),
-      message,
-      metricId,
-      hasFix: false,
-    ));
-
-Iterable<plugin.AnalysisErrorFixes> checkConfigDeprecatedOptions(
-  LintAnalysisConfig config,
-  Iterable<DeprecatedOption> deprecatedOptions,
-  String analysisOptionPath,
-) {
-  final ids = {
-    ...config.codeRules.map((rule) => rule.id),
-    ...config.methodsMetrics.map((metric) => metric.id),
-    ...config.antiPatterns.map((pattern) => pattern.id),
-    ...config.metricsConfig.keys,
-  };
-
-  final location =
-      SourceLocation(0, sourceUrl: analysisOptionPath, line: 0, column: 0);
-
-  final documentation = Uri.parse(
-    'https://github.com/dart-code-checker/dart-code-metrics/blob/master/CHANGELOG.md',
-  );
-
-  return deprecatedOptions
-      .where((option) => ids.contains(option.deprecated))
-      .map((option) => codeIssueToAnalysisErrorFixes(
-            Issue(
-              ruleId: 'dart-code-metrics',
-              documentation: documentation,
-              location: SourceSpan(location, location, ''),
-              severity: Severity.warning,
-              message:
-                  '${option.deprecated} deprecated option. This option will be removed in ${option.supportUntilVersion} version.',
-              verboseMessage: option.replacement != null
-                  ? 'Please migrate on ${option.replacement}, and restart analysis server.'
-                  : null,
-            ),
-            null,
-          ))
-      .toList();
-}
-
 const _severityMapping = {
   Severity.error: plugin.AnalysisErrorSeverity.ERROR,
   Severity.warning: plugin.AnalysisErrorSeverity.WARNING,

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

@@ -8,7 +8,6 @@ import '../../../../utils/node_utils.dart';
 import '../../lint_utils.dart';
 import '../../metrics/metric_utils.dart';
 import '../../metrics/metrics_list/source_lines_of_code/source_lines_of_code_metric.dart';
-import '../../models/entity_type.dart';
 import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
 import '../../models/report.dart';
@@ -35,7 +34,6 @@ class LongMethod extends Pattern {
         ),
         super(
           id: patternId,
-          supportedType: EntityType.methodEntity,
           severity: readSeverity(patternSettings, Severity.none),
           excludes: readExcludes(patternSettings),
         );

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

@@ -4,7 +4,6 @@ import '../../../../utils/node_utils.dart';
 import '../../lint_utils.dart';
 import '../../metrics/metric_utils.dart';
 import '../../metrics/metrics_list/number_of_parameters_metric.dart';
-import '../../models/entity_type.dart';
 import '../../models/function_type.dart';
 import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
@@ -33,7 +32,6 @@ class LongParameterList extends Pattern {
         ),
         super(
           id: patternId,
-          supportedType: EntityType.methodEntity,
           severity: readSeverity(patternSettings, Severity.none),
           excludes: readExcludes(patternSettings),
         );

lib/src/analyzers/lint_analyzer/anti_patterns/models/pattern.dart

@@ -1,4 +1,3 @@
-import '../../models/entity_type.dart';
 import '../../models/internal_resolved_unit_result.dart';
 import '../../models/issue.dart';
 import '../../models/report.dart';
@@ -13,9 +12,6 @@ abstract class Pattern {
   /// The id of the pattern.
   final String id;
 
-  /// The type of entities which will be analyzed by the pattern.
-  final EntityType supportedType;
-
   /// The severity of issues emitted by the pattern.
   final Severity severity;
 
@@ -27,7 +23,6 @@ abstract class Pattern {
 
   const Pattern({
     required this.id,
-    required this.supportedType,
     required this.severity,
     required this.excludes,
   });

lib/src/analyzers/lint_analyzer/anti_patterns/pattern_utils.dart

@@ -1,8 +1,6 @@
-import 'package:analyzer/dart/ast/ast.dart';
 import 'package:source_span/source_span.dart';
 
 import '../models/issue.dart';
-import '../models/scoped_function_declaration.dart';
 import 'models/pattern.dart';
 
 Issue createIssue({
@@ -31,17 +29,3 @@ Uri documentation(Pattern pattern) => Uri(
         pattern.id,
       ],
     );
-
-int getArgumentsCount(ScopedFunctionDeclaration dec) {
-  final declaration = dec.declaration;
-
-  int? argumentsCount;
-  if (declaration is FunctionDeclaration) {
-    argumentsCount =
-        declaration.functionExpression.parameters?.parameters.length;
-  } else if (declaration is MethodDeclaration) {
-    argumentsCount = declaration.parameters?.parameters.length;
-  }
-
-  return argumentsCount ?? 0;
-}

lib/src/analyzers/lint_analyzer/anti_patterns/patterns_factory.dart

@@ -17,9 +17,6 @@ final _implementedPatterns = <String, CreatePattern>{
       ),
 };
 
-Iterable<Pattern> get allPatterns =>
-    _implementedPatterns.keys.map((id) => _implementedPatterns[id]!({}, {}));
-
 Iterable<Pattern> getPatternsById(LintConfig config) =>
     List.unmodifiable(_implementedPatterns.keys
         .where((id) => config.antiPatterns.keys.contains(id))

lib/src/analyzers/lint_analyzer/reporters/reporters_list/code_climate/models/code_climate_issue_category.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: unused-code
+
 /// Represents a Code Climate issue category.
 class CodeClimateIssueCategory {
   static const bugRisk = CodeClimateIssueCategory._('Bug Risk');

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

@@ -170,9 +170,6 @@ final _implementedRules = <String, Rule Function(Map<String, Object>)>{
 
 Iterable<String> get allRuleIds => _implementedRules.keys;
 
-Iterable<Rule> get allRules =>
-    _implementedRules.keys.map((id) => _implementedRules[id]!({}));
-
 Iterable<Rule> getRulesById(Map<String, Map<String, Object>> rulesConfig) =>
     List.unmodifiable(_implementedRules.keys
         .where((id) => rulesConfig.keys.contains(id))

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

@@ -3,8 +3,7 @@ part of 'format_comment_rule.dart';
 const _punctuation = ['.', '!', '?', ':'];
 
 final _sentencesRegExp = RegExp(r'(?<=([\.|:](?=\s|\n|$)))');
-final _regMacrosExp = RegExp('{@(template|macro) .+}');
-const _macrosEndExp = '{@endtemplate}';
+final _regMacrosExp = RegExp('{@.+}');
 const _ignoreExp = 'ignore:';
 const _ignoreForFileExp = 'ignore_for_file:';
 
@@ -141,16 +140,14 @@ class _Visitor extends RecursiveAstVisitor<void> {
     final trimmed = text.trim();
 
     return _regMacrosExp.hasMatch(text) ||
-        text.contains(_macrosEndExp) ||
         _isIgnoreComment(trimmed) ||
         _isIgnoredPattern(trimmed);
   }
 
   bool _isIgnoreComment(String text) =>
       text.startsWith(_ignoreExp) || text.startsWith(_ignoreForFileExp);
 
-  bool _isMacros(String text) =>
-      _regMacrosExp.hasMatch(text) || text == _macrosEndExp;
+  bool _isMacros(String text) => _regMacrosExp.hasMatch(text);
 
   bool _isIgnoredPattern(String text) =>
       _ignoredPatterns.any((regExp) => regExp.hasMatch(text));

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

@@ -11,8 +11,6 @@ const _constructorNameOnly = 'only';
 class _Visitor extends RecursiveAstVisitor<void> {
   final _expressions = <InstanceCreationExpression, EdgeInsetsData>{};
 
-  final _Validator validator = _Validator();
-
   Map<InstanceCreationExpression, EdgeInsetsData> get expressions =>
       _expressions;
 

lib/src/analyzers/lint_analyzer/rules/rules_list/use_setstate_synchronously/use_setstate_synchronously_rule.dart

@@ -11,15 +11,15 @@ import '../../../models/severity.dart';
 import '../../models/flutter_rule.dart';
 import '../../rule_utils.dart';
 
+part 'config.dart';
 part 'fact.dart';
 part 'helpers.dart';
-part 'config.dart';
 part 'visitor.dart';
 
 class UseSetStateSynchronouslyRule extends FlutterRule {
   static const ruleId = 'use-setstate-synchronously';
 
-  Set<String> methods;
+  final Set<String> methods;
 
   UseSetStateSynchronouslyRule([Map<String, Object> options = const {}])
       : methods = readMethods(options),

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

@@ -2,6 +2,7 @@ part of 'use_setstate_synchronously_rule.dart';
 
 class _Visitor extends RecursiveAstVisitor<void> {
   final Set<String> methods;
+
   _Visitor({required this.methods});
 
   final nodes = <SimpleIdentifier>[];
@@ -43,6 +44,13 @@ class _AsyncSetStateVisitor extends RecursiveAstVisitor<void> {
     super.visitAwaitExpression(node);
   }
 
+  @override
+  void visitAssertStatement(AssertStatement node) {
+    final newMounted = _extractMountedCheck(node.condition);
+    mounted = newMounted.or(mounted);
+    super.visitAssertStatement(node);
+  }
+
   @override
   void visitMethodInvocation(MethodInvocation node) {
     if (!inAsync) {
@@ -65,7 +73,8 @@ class _AsyncSetStateVisitor extends RecursiveAstVisitor<void> {
       return node.visitChildren(this);
     }
 
-    node.condition.visitChildren(this);
+    node.condition.accept(this);
+
     final newMounted = _extractMountedCheck(node.condition);
     mounted = newMounted.or(mounted);
 
@@ -99,7 +108,7 @@ class _AsyncSetStateVisitor extends RecursiveAstVisitor<void> {
       return node.visitChildren(this);
     }
 
-    node.condition.visitChildren(this);
+    node.condition.accept(this);
 
     final oldMounted = mounted;
     final newMounted = _extractMountedCheck(node.condition);
@@ -121,7 +130,7 @@ class _AsyncSetStateVisitor extends RecursiveAstVisitor<void> {
       return node.visitChildren(this);
     }
 
-    node.forLoopParts.visitChildren(this);
+    node.forLoopParts.accept(this);
 
     final oldInControlFlow = inControlFlow;
     inControlFlow = true;
@@ -153,9 +162,8 @@ class _AsyncSetStateVisitor extends RecursiveAstVisitor<void> {
     final oldMounted = mounted;
     node.body.visitChildren(this);
     final afterBody = mounted;
-    // ignore: omit_local_variable_types
-    final MountedFact beforeCatch =
-        mounted == oldMounted ? oldMounted : false.asFact();
+    final beforeCatch =
+        mounted == oldMounted ? oldMounted : false.asFact<BinaryExpression>();
     for (final clause in node.catchClauses) {
       mounted = beforeCatch;
       clause.visitChildren(this);
@@ -176,7 +184,7 @@ class _AsyncSetStateVisitor extends RecursiveAstVisitor<void> {
       return node.visitChildren(this);
     }
 
-    node.expression.visitChildren(this);
+    node.expression.accept(this);
 
     final oldInControlFlow = inControlFlow;
     inControlFlow = true;

lib/src/cli/commands/analyze_command.dart

@@ -2,8 +2,6 @@
 
 import 'dart:io';
 
-import 'package:collection/collection.dart';
-
 import '../../analyzers/lint_analyzer/lint_analyzer.dart';
 import '../../analyzers/lint_analyzer/metrics/metrics_factory.dart';
 import '../../analyzers/lint_analyzer/metrics/models/metric_value_level.dart';
@@ -13,7 +11,6 @@ import '../../analyzers/lint_analyzer/reporters/lint_report_params.dart';
 import '../../analyzers/lint_analyzer/reporters/reporters_list/json/lint_json_reporter.dart';
 import '../../analyzers/lint_analyzer/utils/report_utils.dart';
 import '../../config_builder/config_builder.dart';
-import '../../config_builder/models/deprecated_option.dart';
 import '../../logger/logger.dart';
 import '../models/flag_names.dart';
 import '../models/parsed_arguments.dart';
@@ -160,15 +157,9 @@ class AnalyzeCommand extends BaseCommand {
     argParser.addSeparator('');
 
     for (final metric in getMetrics(config: {})) {
-      final deprecation = deprecatedOptions
-          .firstWhereOrNull((option) => option.deprecated == metric.id);
-      final deprecationMessage = deprecation != null
-          ? ' (deprecated, will be removed in ${deprecation.supportUntilVersion} version)'
-          : '';
-
       argParser.addOption(
         metric.id,
-        help: '${metric.documentation.name} threshold$deprecationMessage.',
+        help: '${metric.documentation.name} threshold.',
         valueHelp: '${metric.documentation.recommendedThreshold}',
         callback: (i) {
           if (i != null && int.tryParse(i) == null) {