feat: add print-config option to analyze command (#1057)

* feat: add print-config option to analyze command

* feat: print config for rules with extended config

* feat: add print config to all commands

Co-authored-by: Dmitry Krutskikh <dmitry.krutskikh@gmail.com>

Author: incendial

CHANGELOG.md

@@ -13,6 +13,7 @@
 * feat: support proxy calls for check-unused-l10n.
 * feat: **Breaking change** cleanup public API.
 * chore: restrict `analyzer` version to `>=5.1.0 <5.3.0`.
+* feat: add `print-config` option to all commands.
 
 ## 4.21.2
 

example/example.dart

@@ -23,6 +23,7 @@ Future<void> main() async {
       'newline-before-return': {'severity': 'info'},
     },
     antiPatterns: {'long-method': {}},
+    shouldPrintConfig: false,
   );
 
   const analyzer = LintAnalyzer();

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

@@ -38,4 +38,11 @@ abstract class Pattern {
     Map<ScopedClassDeclaration, Report> classMetrics,
     Map<ScopedFunctionDeclaration, Report> functionMetrics,
   );
+
+  Map<String, Object?> toJson() => {
+        'id': id,
+        'severity': severity.toString(),
+        'excludes': excludes.toList(),
+        'dependentMetricIds': dependentMetricIds.toList(),
+      };
 }

lib/src/analyzers/lint_analyzer/lint_analysis_config.dart

@@ -12,8 +12,8 @@ class LintAnalysisConfig {
   final Iterable<Glob> rulesExcludes;
   final Iterable<Pattern> antiPatterns;
   final Iterable<Metric> classesMetrics;
-  final Iterable<Metric> fileMetrics;
   final Iterable<Metric> methodsMetrics;
+  final Iterable<Metric> fileMetrics;
   final Iterable<Glob> metricsExcludes;
   final Map<String, Object> metricsConfig;
   final String excludesRootFolder;
@@ -30,4 +30,17 @@ class LintAnalysisConfig {
     this.metricsConfig,
     this.excludesRootFolder,
   );
+
+  Map<String, Object?> toJson() => {
+        'rules': codeRules.map((rule) => rule.toJson()).toList(),
+        'rules-excludes': rulesExcludes.map((glob) => glob.pattern).toList(),
+        'anti-patterns':
+            antiPatterns.map((pattern) => pattern.toJson()).toList(),
+        'metrics-config': metricsConfig,
+        'class-metrics': classesMetrics.map((metric) => metric.id).toList(),
+        'method-metrics': methodsMetrics.map((metric) => metric.id).toList(),
+        'file-metrics': fileMetrics.map((metric) => metric.id).toList(),
+        'metrics-excludes':
+            metricsExcludes.map((glob) => glob.pattern).toList(),
+      };
 }

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -85,6 +85,10 @@ class LintAnalyzer {
       final lintAnalysisConfig =
           _getAnalysisConfig(context, rootFolder, config);
 
+      if (config.shouldPrintConfig) {
+        _logger?.printConfig(lintAnalysisConfig.toJson());
+      }
+
       final filePaths = getFilePaths(
         folders,
         context,

lib/src/analyzers/lint_analyzer/lint_config.dart

@@ -11,6 +11,7 @@ class LintConfig {
   final Map<String, Map<String, Object>> rules;
   final Iterable<String> excludeForRulesPatterns;
   final Map<String, Map<String, Object>> antiPatterns;
+  final bool shouldPrintConfig;
 
   const LintConfig({
     required this.excludePatterns,
@@ -19,6 +20,7 @@ class LintConfig {
     required this.rules,
     required this.excludeForRulesPatterns,
     required this.antiPatterns,
+    required this.shouldPrintConfig,
   });
 
   /// Creates the config from analysis [options].
@@ -32,10 +34,12 @@ class LintConfig {
             .readIterableOfString(['rules-exclude'], packageRelated: true),
         antiPatterns:
             options.readMapOfMap(['anti-patterns'], packageRelated: true),
+        shouldPrintConfig: false,
       );
 
   /// Creates the config from cli [arguments].
   factory LintConfig.fromArgs(ParsedArguments arguments) => LintConfig(
+        shouldPrintConfig: arguments.shouldPrintConfig,
         excludePatterns:
             arguments.excludePath.isNotEmpty ? [arguments.excludePath] : [],
         excludeForMetricsPatterns: const [],
@@ -54,6 +58,7 @@ class LintConfig {
   /// Config coming from [overrides] has a higher priority
   /// and overrides conflicting entries.
   LintConfig merge(LintConfig overrides) => LintConfig(
+        shouldPrintConfig: shouldPrintConfig || overrides.shouldPrintConfig,
         excludePatterns: {...excludePatterns, ...overrides.excludePatterns},
         excludeForMetricsPatterns: {
           ...excludeForMetricsPatterns,

lib/src/analyzers/lint_analyzer/rules/models/rule.dart

@@ -29,4 +29,10 @@ abstract class Rule {
 
   /// Returns [Iterable] with [Issue]'s detected while check the passed [source]
   Iterable<Issue> check(InternalResolvedUnitResult source);
+
+  Map<String, Object?> toJson() => {
+        'id': id,
+        'severity': severity.toString(),
+        'excludes': excludes.toList(),
+      };
 }

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_banned_imports/avoid_banned_imports_rule.dart

@@ -27,6 +27,14 @@ class AvoidBannedImportsRule extends CommonRule {
           excludes: readExcludes(config),
         );
 
+  @override
+  Map<String, Object?> toJson() {
+    final json = super.toJson();
+    json[_entriesLabel] = _entries.map((entry) => entry.toJson()).toList();
+
+    return json;
+  }
+
   @override
   Iterable<Issue> check(InternalResolvedUnitResult source) {
     final activeEntries = _entries

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_banned_imports/utils/config_parser.dart

@@ -37,4 +37,10 @@ class _AvoidBannedImportsConfigEntry {
     required this.deny,
     required this.message,
   });
+
+  Map<String, Object?> toJson() => {
+        'paths': paths.map((exp) => exp.pattern).toList(),
+        'deny': deny.map((exp) => exp.pattern).toList(),
+        'message': message,
+      };
 }

lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_nested_conditional_expressions/avoid_nested_conditional_expressions_rule.dart

@@ -29,6 +29,14 @@ class AvoidNestedConditionalExpressionsRule extends CommonRule {
           excludes: readExcludes(config),
         );
 
+  @override
+  Map<String, Object?> toJson() {
+    final json = super.toJson();
+    json[_ConfigParser._acceptableLevelConfig] = _acceptableLevel;
+
+    return json;
+  }
+
   @override
   Iterable<Issue> check(InternalResolvedUnitResult source) {
     final visitor = _Visitor(_acceptableLevel);