feat: add print config to all commands

Author: incendial

CHANGELOG.md

@@ -12,7 +12,7 @@
 * feat: **Breaking change** change severity for avoid-banned-imports, prefer-trailing-comma, ban-name rules.
 * feat: support proxy calls for check-unused-l10n.
 * feat: **Breaking change** cleanup public API.
-* feat: add `print-config` option to the `analyze` command.
+* feat: add `print-config` option to all commands.
 
 ## 4.21.2
 

lib/src/analyzers/unnecessary_nullable_analyzer/unnecessary_nullable_analysis_config.dart

@@ -4,9 +4,18 @@ import 'package:glob/glob.dart';
 class UnnecessaryNullableAnalysisConfig {
   final Iterable<Glob> globalExcludes;
   final Iterable<Glob> analyzerExcludedPatterns;
+  final bool isMonorepo;
 
   const UnnecessaryNullableAnalysisConfig(
     this.globalExcludes,
-    this.analyzerExcludedPatterns,
-  );
+    this.analyzerExcludedPatterns, {
+    required this.isMonorepo,
+  });
+
+  Map<String, Object?> toJson() => {
+        'global-excludes': globalExcludes.map((glob) => glob.pattern).toList(),
+        'analyzer-excluded-patterns':
+            analyzerExcludedPatterns.map((glob) => glob.pattern).toList(),
+        'is-monorepo': isMonorepo,
+      };
 }

lib/src/analyzers/unnecessary_nullable_analyzer/unnecessary_nullable_analyzer.dart

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

lib/src/analyzers/unnecessary_nullable_analyzer/unnecessary_nullable_config.dart

@@ -5,11 +5,13 @@ class UnnecessaryNullableConfig {
   final Iterable<String> excludePatterns;
   final Iterable<String> analyzerExcludePatterns;
   final bool isMonorepo;
+  final bool shouldPrintConfig;
 
   const UnnecessaryNullableConfig({
     required this.excludePatterns,
     required this.analyzerExcludePatterns,
     required this.isMonorepo,
+    required this.shouldPrintConfig,
   });
 
   /// Creates the config from analysis [options].
@@ -21,14 +23,17 @@ class UnnecessaryNullableConfig {
         analyzerExcludePatterns:
             options.readIterableOfString(['analyzer', 'exclude']),
         isMonorepo: false,
+        shouldPrintConfig: false,
       );
 
   /// Creates the config from cli args.
   factory UnnecessaryNullableConfig.fromArgs(
     Iterable<String> excludePatterns, {
     required bool isMonorepo,
+    required bool shouldPrintConfig,
   }) =>
       UnnecessaryNullableConfig(
+        shouldPrintConfig: shouldPrintConfig,
         excludePatterns: excludePatterns,
         analyzerExcludePatterns: const [],
         isMonorepo: isMonorepo,
@@ -46,5 +51,6 @@ class UnnecessaryNullableConfig {
           ...overrides.analyzerExcludePatterns,
         },
         isMonorepo: isMonorepo || overrides.isMonorepo,
+        shouldPrintConfig: shouldPrintConfig || overrides.shouldPrintConfig,
       );
 }

lib/src/analyzers/unused_code_analyzer/unused_code_analysis_config.dart

@@ -4,9 +4,18 @@ import 'package:glob/glob.dart';
 class UnusedCodeAnalysisConfig {
   final Iterable<Glob> globalExcludes;
   final Iterable<Glob> analyzerExcludedPatterns;
+  final bool isMonorepo;
 
   const UnusedCodeAnalysisConfig(
     this.globalExcludes,
-    this.analyzerExcludedPatterns,
-  );
+    this.analyzerExcludedPatterns, {
+    required this.isMonorepo,
+  });
+
+  Map<String, Object?> toJson() => {
+        'global-excludes': globalExcludes.map((glob) => glob.pattern).toList(),
+        'analyzer-excluded-patterns':
+            analyzerExcludedPatterns.map((glob) => glob.pattern).toList(),
+        'is-monorepo': isMonorepo,
+      };
 }

lib/src/analyzers/unused_code_analyzer/unused_code_analyzer.dart

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

lib/src/analyzers/unused_code_analyzer/unused_code_config.dart

@@ -5,11 +5,13 @@ class UnusedCodeConfig {
   final Iterable<String> excludePatterns;
   final Iterable<String> analyzerExcludePatterns;
   final bool isMonorepo;
+  final bool shouldPrintConfig;
 
   const UnusedCodeConfig({
     required this.excludePatterns,
     required this.analyzerExcludePatterns,
     required this.isMonorepo,
+    required this.shouldPrintConfig,
   });
 
   /// Creates the config from analysis [options].
@@ -19,14 +21,17 @@ class UnusedCodeConfig {
         analyzerExcludePatterns:
             options.readIterableOfString(['analyzer', 'exclude']),
         isMonorepo: false,
+        shouldPrintConfig: false,
       );
 
   /// Creates the config from cli args.
   factory UnusedCodeConfig.fromArgs(
     Iterable<String> excludePatterns, {
     required bool isMonorepo,
+    required bool shouldPrintConfig,
   }) =>
       UnusedCodeConfig(
+        shouldPrintConfig: shouldPrintConfig,
         excludePatterns: excludePatterns,
         analyzerExcludePatterns: const [],
         isMonorepo: isMonorepo,
@@ -43,5 +48,6 @@ class UnusedCodeConfig {
           ...overrides.analyzerExcludePatterns,
         },
         isMonorepo: isMonorepo || overrides.isMonorepo,
+        shouldPrintConfig: shouldPrintConfig || overrides.shouldPrintConfig,
       );
 }

lib/src/analyzers/unused_files_analyzer/unused_files_analysis_config.dart

@@ -3,6 +3,15 @@ import 'package:glob/glob.dart';
 /// Represents converted unused files config which contains parsed entities.
 class UnusedFilesAnalysisConfig {
   final Iterable<Glob> globalExcludes;
+  final bool isMonorepo;
 
-  const UnusedFilesAnalysisConfig(this.globalExcludes);
+  const UnusedFilesAnalysisConfig(
+    this.globalExcludes, {
+    required this.isMonorepo,
+  });
+
+  Map<String, Object?> toJson() => {
+        'global-excludes': globalExcludes.map((glob) => glob.pattern).toList(),
+        'is-monorepo': isMonorepo,
+      };
 }

lib/src/analyzers/unused_files_analyzer/unused_files_analyzer.dart

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

lib/src/analyzers/unused_files_analyzer/unused_files_config.dart

@@ -5,11 +5,13 @@ class UnusedFilesConfig {
   final Iterable<String> excludePatterns;
   final Iterable<String> analyzerExcludePatterns;
   final bool isMonorepo;
+  final bool shouldPrintConfig;
 
   const UnusedFilesConfig({
     required this.excludePatterns,
     required this.analyzerExcludePatterns,
     required this.isMonorepo,
+    required this.shouldPrintConfig,
   });
 
   /// Creates the config from analysis [options].
@@ -19,14 +21,17 @@ class UnusedFilesConfig {
         analyzerExcludePatterns:
             options.readIterableOfString(['analyzer', 'exclude']),
         isMonorepo: false,
+        shouldPrintConfig: false,
       );
 
   /// Creates the config from cli args.
   factory UnusedFilesConfig.fromArgs(
     Iterable<String> excludePatterns, {
     required bool isMonorepo,
+    required bool shouldPrintConfig,
   }) =>
       UnusedFilesConfig(
+        shouldPrintConfig: shouldPrintConfig,
         excludePatterns: excludePatterns,
         analyzerExcludePatterns: const [],
         isMonorepo: isMonorepo,
@@ -43,5 +48,6 @@ class UnusedFilesConfig {
           ...overrides.analyzerExcludePatterns,
         },
         isMonorepo: isMonorepo || overrides.isMonorepo,
+        shouldPrintConfig: shouldPrintConfig || overrides.shouldPrintConfig,
       );
 }

lib/src/analyzers/unused_l10n_analyzer/unused_l10n_analysis_config.dart

@@ -10,4 +10,9 @@ class UnusedL10nAnalysisConfig {
     this.globalExcludes,
     String? classPattern,
   ) : classPattern = RegExp(classPattern ?? r'I18n$');
+
+  Map<String, Object?> toJson() => {
+        'global-excludes': globalExcludes.map((glob) => glob.pattern).toList(),
+        'class-pattern': classPattern.pattern,
+      };
 }

lib/src/analyzers/unused_l10n_analyzer/unused_l10n_analyzer.dart

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

lib/src/analyzers/unused_l10n_analyzer/unused_l10n_config.dart

@@ -5,11 +5,13 @@ class UnusedL10nConfig {
   final Iterable<String> excludePatterns;
   final Iterable<String> analyzerExcludePatterns;
   final String? classPattern;
+  final bool shouldPrintConfig;
 
   const UnusedL10nConfig({
     required this.excludePatterns,
     required this.analyzerExcludePatterns,
     required this.classPattern,
+    required this.shouldPrintConfig,
   });
 
   /// Creates the config from analysis [options].
@@ -21,14 +23,17 @@ class UnusedL10nConfig {
         analyzerExcludePatterns:
             options.readIterableOfString(['analyzer', 'exclude']),
         classPattern: null,
+        shouldPrintConfig: false,
       );
 
   /// Creates the config from cli args.
   factory UnusedL10nConfig.fromArgs(
     Iterable<String> excludePatterns,
-    String classPattern,
-  ) =>
+    String classPattern, {
+    required bool shouldPrintConfig,
+  }) =>
       UnusedL10nConfig(
+        shouldPrintConfig: shouldPrintConfig,
         excludePatterns: excludePatterns,
         analyzerExcludePatterns: const [],
         classPattern: classPattern,
@@ -45,5 +50,6 @@ class UnusedL10nConfig {
           ...overrides.analyzerExcludePatterns,
         },
         classPattern: overrides.classPattern ?? classPattern,
+        shouldPrintConfig: shouldPrintConfig || overrides.shouldPrintConfig,
       );
 }

lib/src/cli/commands/analyze_command.dart

@@ -123,13 +123,6 @@ class AnalyzeCommand extends BaseCommand {
 
   void _usesReporterOption() {
     argParser
-      ..addSeparator('')
-      ..addFlag(
-        FlagNames.printConfig,
-        abbr: 'c',
-        help: 'Print resolved config.',
-        negatable: false,
-      )
       ..addSeparator('')
       ..addOption(
         FlagNames.reporter,

lib/src/cli/commands/base_command.dart

@@ -81,13 +81,25 @@ abstract class BaseCommand extends Command<void> {
   }
 
   void addCommonFlags() {
+    usesPrintConfig();
     usesRootFolderOption();
     usesSdkPathOption();
     usesExcludeOption();
     usesCongratulateFlag();
     usesVerboseFlag();
   }
 
+  void usesPrintConfig() {
+    argParser
+      ..addSeparator('')
+      ..addFlag(
+        FlagNames.printConfig,
+        abbr: 'c',
+        help: 'Print resolved config.',
+        negatable: false,
+      );
+  }
+
   void usesRootFolderOption() {
     argParser
       ..addSeparator('')

lib/src/cli/commands/check_unnecessary_nullable_command.dart

@@ -42,10 +42,12 @@ class CheckUnnecessaryNullableCommand extends BaseCommand {
     final excludePath = argResults[FlagNames.exclude] as String;
     final reporterName = argResults[FlagNames.reporter] as String;
     final isMonorepo = argResults[FlagNames.isMonorepo] as bool;
+    final shouldPrintConfig = argResults[FlagNames.printConfig] as bool;
 
     final config = ConfigBuilder.getUnnecessaryNullableConfigFromArgs(
       [excludePath],
       isMonorepo: isMonorepo,
+      shouldPrintConfig: shouldPrintConfig,
     );
 
     final unusedCodeResult = await _analyzer.runCliAnalysis(

lib/src/cli/commands/check_unused_code_command.dart

@@ -41,10 +41,12 @@ class CheckUnusedCodeCommand extends BaseCommand {
     final excludePath = argResults[FlagNames.exclude] as String;
     final reporterName = argResults[FlagNames.reporter] as String;
     final isMonorepo = argResults[FlagNames.isMonorepo] as bool;
+    final shouldPrintConfig = argResults[FlagNames.printConfig] as bool;
 
     final config = ConfigBuilder.getUnusedCodeConfigFromArgs(
       [excludePath],
       isMonorepo: isMonorepo,
+      shouldPrintConfig: shouldPrintConfig,
     );
 
     final unusedCodeResult = await _analyzer.runCliAnalysis(

lib/src/cli/commands/check_unused_files_command.dart

@@ -42,10 +42,12 @@ class CheckUnusedFilesCommand extends BaseCommand {
     final reporterName = argResults[FlagNames.reporter] as String;
     final isMonorepo = argResults[FlagNames.isMonorepo] as bool;
     final deleteFiles = argResults[FlagNames.deleteFiles] as bool;
+    final shouldPrintConfig = argResults[FlagNames.printConfig] as bool;
 
     final config = ConfigBuilder.getUnusedFilesConfigFromArgs(
       [excludePath],
       isMonorepo: isMonorepo,
+      shouldPrintConfig: shouldPrintConfig,
     );
 
     final unusedFilesResult = await _analyzer.runCliAnalysis(

lib/src/cli/commands/check_unused_l10n_command.dart

@@ -40,12 +40,14 @@ class CheckUnusedL10nCommand extends BaseCommand {
     final classPattern = argResults[FlagNames.l10nClassPattern] as String;
     final excludePath = argResults[FlagNames.exclude] as String;
     final reporterName = argResults[FlagNames.reporter] as String;
+    final shouldPrintConfig = argResults[FlagNames.printConfig] as bool;
 
     final folders = argResults.rest;
 
     final config = ConfigBuilder.getUnusedL10nConfigFromArgs(
       [excludePath],
       classPattern,
+      shouldPrintConfig: shouldPrintConfig,
     );
 
     final unusedL10nResult = await _analyzer.runCliAnalysis(