feat: add support for discovering analysis options file from contex (#396)

Author: incendial

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+* Add support for analysis options auto discovery.
+
 ## 4.0.1
 
 * Improve static code diagnostic `always-remove-listener`.

analysis_options.yaml

@@ -2,8 +2,8 @@ include: package:lints/recommended.yaml
 
 analyzer:
   exclude:
-    - test/resources/**
-    - test/resources/unused_files_analyzer/generated/**/**
+    - test/resources/*
+    - test/resources/unused_files_analyzer/**
     - test/**/examples/**
   plugins:
     - dart_code_metrics
@@ -20,7 +20,15 @@ dart_code_metrics:
     maximum-nesting: 5
     number-of-parameters: 4
   metrics-exclude:
-    - test/**
+    - test/analyzer_plugin/**
+    - test/analyzers/**
+    - test/cli/**
+    - test/config_builder/**
+    - test/helpers/**
+    - test/reporters/**
+    - test/utils/**
+    - test/resources/*
+    - test/*
   rules:
     - avoid-unused-parameters
     - binary-expression-operand-order

example/example.dart

@@ -1,6 +1,5 @@
 import 'dart:io';
 
-import 'package:dart_code_metrics/config.dart';
 import 'package:dart_code_metrics/lint_analyzer.dart';
 
 Future<void> main() async {
@@ -11,7 +10,7 @@ Future<void> main() async {
   const rootFolder = 'projectRoot';
 
   // First of all config has to be created for a checker
-  const config = Config(
+  const config = LintConfig(
     excludePatterns: ['test/resources/**'],
     excludeForMetricsPatterns: ['test/**'],
     metrics: {
@@ -25,12 +24,10 @@ Future<void> main() async {
     antiPatterns: {'long-method': {}},
   );
 
-  final lintConfig = ConfigBuilder.getLintConfig(config, rootFolder);
-
   const analyzer = LintAnalyzer();
 
   final result =
-      await analyzer.runCliAnalysis(foldersToAnalyze, rootFolder, lintConfig);
+      await analyzer.runCliAnalysis(foldersToAnalyze, rootFolder, config);
 
   // Now runner.results() contains some insights about analyzed code. Let's report it!
   // For a simple example we would report results to terminal

lib/config.dart

@@ -1,3 +1,2 @@
 export 'package:dart_code_metrics/src/config_builder/config_builder.dart';
 export 'package:dart_code_metrics/src/config_builder/models/analysis_options.dart';
-export 'package:dart_code_metrics/src/config_builder/models/config.dart';

lib/src/analyzer_plugin/analyzer_plugin.dart

@@ -13,8 +13,8 @@ import 'package:analyzer/src/dart/analysis/driver_based_analysis_context.dart';
 import 'package:analyzer_plugin/plugin/plugin.dart';
 import 'package:analyzer_plugin/protocol/protocol_generated.dart' as plugin;
 
+import '../analyzers/lint_analyzer/lint_analysis_config.dart';
 import '../analyzers/lint_analyzer/lint_analyzer.dart';
-import '../analyzers/lint_analyzer/lint_config.dart';
 import '../analyzers/lint_analyzer/metrics/metrics_list/cyclomatic_complexity/cyclomatic_complexity_metric.dart';
 import '../analyzers/lint_analyzer/metrics/metrics_list/number_of_parameters_metric.dart';
 import '../config_builder/config_builder.dart';
@@ -25,7 +25,7 @@ import 'analyzer_plugin_utils.dart';
 class MetricsAnalyzerPlugin extends ServerPlugin {
   static const _analyzer = LintAnalyzer();
 
-  final _configs = <AnalysisDriverGeneric, LintConfig>{};
+  final _configs = <AnalysisDriverGeneric, LintAnalysisConfig>{};
 
   var _filesFromSetPriorityFilesRequest = <String>[];
 
@@ -236,14 +236,14 @@ class MetricsAnalyzerPlugin extends ServerPlugin {
     return result;
   }
 
-  LintConfig? _createConfig(AnalysisDriver driver, String rootPath) {
+  LintAnalysisConfig? _createConfig(AnalysisDriver driver, String rootPath) {
     final file = driver.analysisContext?.contextRoot.optionsFile;
     if (file != null && file.exists) {
       final options = AnalysisOptions(yamlMapToDartMap(
         AnalysisOptionsProvider(driver.sourceFactory).getOptionsFromFile(file),
       ));
-      final config = ConfigBuilder.getConfig(options);
-      final lintConfig = ConfigBuilder.getLintConfig(
+      final config = ConfigBuilder.getLintConfigFromOptions(options);
+      final lintConfig = ConfigBuilder.getLintAnalysisConfig(
         config,
         rootPath,
         classMetrics: const [],

lib/src/analyzer_plugin/analyzer_plugin_utils.dart

@@ -3,7 +3,7 @@ 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_config.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';
@@ -102,7 +102,7 @@ plugin.AnalysisErrorFixes metricReportToAnalysisErrorFixes(
     ));
 
 Iterable<plugin.AnalysisErrorFixes> checkConfigDeprecatedOptions(
-  LintConfig config,
+  LintAnalysisConfig config,
   Iterable<DeprecatedOption> deprecatedOptions,
   String analysisOptionPath,
 ) {

lib/src/analyzers/lint_analyzer/lint_analysis_config.dart

@@ -0,0 +1,29 @@
+import 'package:glob/glob.dart';
+import 'package:meta/meta.dart';
+
+import 'anti_patterns/models/obsolete_pattern.dart';
+import 'metrics/models/metric.dart';
+import 'rules/models/rule.dart';
+
+/// Represents converted lint config which contains parsed entities.
+
+@immutable
+class LintAnalysisConfig {
+  final Iterable<Glob> globalExcludes;
+  final Iterable<Rule> codeRules;
+  final Iterable<ObsoletePattern> antiPatterns;
+  final Iterable<Metric> classesMetrics;
+  final Iterable<Metric> methodsMetrics;
+  final Iterable<Glob> metricsExcludes;
+  final Map<String, Object> metricsConfig;
+
+  const LintAnalysisConfig(
+    this.globalExcludes,
+    this.codeRules,
+    this.antiPatterns,
+    this.classesMetrics,
+    this.methodsMetrics,
+    this.metricsExcludes,
+    this.metricsConfig,
+  );
+}

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -5,14 +5,15 @@ import 'package:analyzer/dart/analysis/analysis_context_collection.dart';
 import 'package:analyzer/dart/analysis/results.dart';
 import 'package:analyzer/dart/ast/ast.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
-import 'package:file/local.dart';
-import 'package:glob/glob.dart';
 import 'package:path/path.dart';
 
-import '../../config_builder/models/config.dart';
+import '../../config_builder/config_builder.dart';
+import '../../config_builder/models/analysis_options.dart';
 import '../../reporters/models/reporter.dart';
 import '../../utils/exclude_utils.dart';
+import '../../utils/file_utils.dart';
 import '../../utils/node_utils.dart';
+import 'lint_analysis_config.dart';
 import 'lint_config.dart';
 import 'metrics/halstead_volume_ast_visitor.dart';
 import 'metrics/metric_utils.dart';
@@ -38,7 +39,7 @@ class LintAnalyzer {
   const LintAnalyzer();
 
   Reporter? getReporter({
-    required Config config,
+    required LintConfig config,
     required String name,
     required IOSink output,
     required String reportFolder,
@@ -52,7 +53,7 @@ class LintAnalyzer {
 
   LintFileReport? runPluginAnalysis(
     ResolvedUnitResult result,
-    LintConfig config,
+    LintAnalysisConfig config,
     String rootFolder,
   ) {
     if (!isExcluded(result.path, config.globalExcludes)) {
@@ -78,24 +79,23 @@ class LintAnalyzer {
       resourceProvider: PhysicalResourceProvider.INSTANCE,
     );
 
-    final filePaths = folders
-        .expand((directory) => Glob('$directory/**.dart')
-            .listFileSystemSync(
-              const LocalFileSystem(),
-              root: rootFolder,
-              followLinks: false,
-            )
-            .whereType<File>()
-            .where((entity) => !isExcluded(
-                  relative(entity.path, from: rootFolder),
-                  config.globalExcludes,
-                ))
-            .map((entity) => entity.path))
-        .toSet();
-
     final analyzerResult = <LintFileReport>[];
 
     for (final context in collection.contexts) {
+      final analysisOptions = await analysisOptionsFromContext(context) ??
+          await analysisOptionsFromFilePath(rootFolder);
+
+      final contextConfig =
+          ConfigBuilder.getLintConfigFromOptions(analysisOptions).merge(config);
+      final lintAnalysisConfig =
+          ConfigBuilder.getLintAnalysisConfig(contextConfig, rootFolder);
+
+      final filePaths = extractDartFilesFromFolders(
+        folders,
+        rootFolder,
+        lintAnalysisConfig.globalExcludes,
+      );
+
       final analyzedFiles =
           filePaths.intersection(context.contextRoot.analyzedFiles().toSet());
 
@@ -104,7 +104,7 @@ class LintAnalyzer {
         if (unit is ResolvedUnitResult) {
           final result = _runAnalysisForFile(
             unit,
-            config,
+            lintAnalysisConfig,
             rootFolder,
             filePath: filePath,
           );
@@ -121,7 +121,7 @@ class LintAnalyzer {
 
   LintFileReport? _runAnalysisForFile(
     ResolvedUnitResult result,
-    LintConfig config,
+    LintAnalysisConfig config,
     String rootFolder, {
     String? filePath,
   }) {
@@ -215,7 +215,7 @@ class LintAnalyzer {
   Iterable<Issue> _checkOnCodeIssues(
     Suppression ignores,
     InternalResolvedUnitResult source,
-    LintConfig config,
+    LintAnalysisConfig config,
     String filePath,
     String? rootFolder,
   ) =>
@@ -240,7 +240,7 @@ class LintAnalyzer {
     Suppression ignores,
     InternalResolvedUnitResult source,
     Iterable<ScopedFunctionDeclaration> functions,
-    LintConfig config,
+    LintAnalysisConfig config,
   ) =>
       config.antiPatterns
           .where((pattern) => !ignores.isSuppressed(pattern.id))
@@ -255,7 +255,7 @@ class LintAnalyzer {
   Map<ScopedClassDeclaration, Report> _checkClassMetrics(
     ScopeVisitor visitor,
     InternalResolvedUnitResult source,
-    LintConfig config,
+    LintAnalysisConfig config,
   ) {
     final classRecords = <ScopedClassDeclaration, Report>{};
 
@@ -292,7 +292,7 @@ class LintAnalyzer {
   Map<ScopedFunctionDeclaration, Report> _checkFunctionMetrics(
     ScopeVisitor visitor,
     InternalResolvedUnitResult source,
-    LintConfig config,
+    LintAnalysisConfig config,
   ) {
     final functionRecords = <ScopedFunctionDeclaration, Report>{};
 

lib/src/analyzers/lint_analyzer/lint_config.dart

@@ -1,27 +1,63 @@
-import 'package:glob/glob.dart';
 import 'package:meta/meta.dart';
 
-import 'anti_patterns/models/obsolete_pattern.dart';
-import 'metrics/models/metric.dart';
-import 'rules/models/rule.dart';
+import '../../cli/models/parsed_arguments.dart';
+import '../../config_builder/analysis_options_utils.dart';
+import '../../config_builder/models/analysis_options.dart';
+import 'metrics/metrics_factory.dart';
 
+/// Represents raw lint config which can be merged with other raw configs.
 @immutable
 class LintConfig {
-  final Iterable<Glob> globalExcludes;
-  final Iterable<Rule> codeRules;
-  final Iterable<ObsoletePattern> antiPatterns;
-  final Iterable<Metric> classesMetrics;
-  final Iterable<Metric> methodsMetrics;
-  final Iterable<Glob> metricsExcludes;
-  final Map<String, Object> metricsConfig;
+  final Iterable<String> excludePatterns;
+  final Iterable<String> excludeForMetricsPatterns;
+  final Map<String, Object> metrics;
+  final Map<String, Map<String, Object>> rules;
+  final Map<String, Map<String, Object>> antiPatterns;
 
-  const LintConfig(
-    this.globalExcludes,
-    this.codeRules,
-    this.antiPatterns,
-    this.classesMetrics,
-    this.methodsMetrics,
-    this.metricsExcludes,
-    this.metricsConfig,
-  );
+  const LintConfig({
+    required this.excludePatterns,
+    required this.excludeForMetricsPatterns,
+    required this.metrics,
+    required this.rules,
+    required this.antiPatterns,
+  });
+
+  factory LintConfig.fromAnalysisOptions(AnalysisOptions options) {
+    const _rootKey = 'dart_code_metrics';
+
+    return LintConfig(
+      excludePatterns: options.readIterableOfString(['analyzer', 'exclude']),
+      excludeForMetricsPatterns:
+          options.readIterableOfString([_rootKey, 'metrics-exclude']),
+      metrics: options.readMap([_rootKey, 'metrics']),
+      rules: options.readMapOfMap([_rootKey, 'rules']),
+      antiPatterns: options.readMapOfMap([_rootKey, 'anti-patterns']),
+    );
+  }
+
+  factory LintConfig.fromArgs(ParsedArguments arguments) => LintConfig(
+        excludePatterns: [arguments.excludePath],
+        excludeForMetricsPatterns: const [],
+        metrics: {
+          for (final metric in getMetrics(config: {}))
+            if (arguments.metricsConfig.containsKey(metric.id))
+              metric.id: arguments.metricsConfig[metric.id]!,
+        },
+        rules: const {},
+        antiPatterns: const {},
+      );
+
+  LintConfig merge(LintConfig overrides) => LintConfig(
+        excludePatterns: {...excludePatterns, ...overrides.excludePatterns},
+        excludeForMetricsPatterns: {
+          ...excludeForMetricsPatterns,
+          ...overrides.excludeForMetricsPatterns,
+        },
+        metrics: mergeMaps(defaults: metrics, overrides: overrides.metrics),
+        rules: mergeMaps(defaults: rules, overrides: overrides.rules)
+            .cast<String, Map<String, Object>>(),
+        antiPatterns:
+            mergeMaps(defaults: antiPatterns, overrides: overrides.antiPatterns)
+                .cast<String, Map<String, Object>>(),
+      );
 }