fix: fix rule and metric excludes for monorepos (#439)

* fix: fix rule and metric excludes for monorepos

* chore: rename excludeRootFolder

Author: incendial

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 4.2.0-dev.4
 
+* Fix rule and metrics excludes for monorepos.
 * Revert: Changed the supported `analyzer` version to `^2.1.0`.
 * Revert: Changed the supported `analyzer` version to `^2.0.0`.
 * Revert: Changed the supported `analyzer_plugin` version to `^0.7.0`.

lib/src/analyzer_plugin/analyzer_plugin.dart

@@ -239,13 +239,17 @@ class MetricsAnalyzerPlugin extends ServerPlugin {
   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 options = AnalysisOptions(
+        file.path,
+        yamlMapToDartMap(
+          AnalysisOptionsProvider(driver.sourceFactory)
+              .getOptionsFromFile(file),
+        ),
+      );
       final config = ConfigBuilder.getLintConfigFromOptions(options);
       final lintConfig = ConfigBuilder.getLintAnalysisConfig(
         config,
-        rootPath,
+        options.folderPath ?? rootPath,
         classMetrics: const [],
         functionMetrics: [
           CyclomaticComplexityMetric(config: config.metrics),

lib/src/analyzers/lint_analyzer/lint_analysis_config.dart

@@ -16,6 +16,7 @@ class LintAnalysisConfig {
   final Iterable<Metric> methodsMetrics;
   final Iterable<Glob> metricsExcludes;
   final Map<String, Object> metricsConfig;
+  final String excludesRootFolder;
 
   const LintAnalysisConfig(
     this.globalExcludes,
@@ -25,5 +26,6 @@ class LintAnalysisConfig {
     this.methodsMetrics,
     this.metricsExcludes,
     this.metricsConfig,
+    this.excludesRootFolder,
   );
 }

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -85,10 +85,14 @@ class LintAnalyzer {
       final analysisOptions = await analysisOptionsFromContext(context) ??
           await analysisOptionsFromFilePath(rootFolder);
 
+      final excludesRootFolder = analysisOptions.folderPath ?? rootFolder;
+
       final contextConfig =
           ConfigBuilder.getLintConfigFromOptions(analysisOptions).merge(config);
-      final lintAnalysisConfig =
-          ConfigBuilder.getLintAnalysisConfig(contextConfig, rootFolder);
+      final lintAnalysisConfig = ConfigBuilder.getLintAnalysisConfig(
+        contextConfig,
+        excludesRootFolder,
+      );
 
       final contextFolders = folders
           .where((path) => normalize(join(rootFolder, path))
@@ -152,7 +156,6 @@ class LintAnalyzer {
         internalResult,
         config,
         filePath,
-        rootFolder,
       );
 
       if (!isExcluded(filePath, config.metricsExcludes)) {
@@ -222,16 +225,14 @@ class LintAnalyzer {
     InternalResolvedUnitResult source,
     LintAnalysisConfig config,
     String filePath,
-    String? rootFolder,
   ) =>
       config.codeRules
           .where((rule) =>
               !ignores.isSuppressed(rule.id) &&
-              (rootFolder == null ||
-                  !isExcluded(
-                    filePath,
-                    prepareExcludes(rule.excludes, rootFolder),
-                  )))
+              !isExcluded(
+                filePath,
+                prepareExcludes(rule.excludes, config.excludesRootFolder),
+              ))
           .expand(
             (rule) =>
                 rule.check(source).where((issue) => !ignores.isSuppressedAt(

lib/src/config_builder/config_builder.dart

@@ -20,12 +20,12 @@ class ConfigBuilder {
 
   static LintAnalysisConfig getLintAnalysisConfig(
     LintConfig config,
-    String rootPath, {
+    String excludesRootFolder, {
     Iterable<Metric<num>>? classMetrics,
     Iterable<Metric<num>>? functionMetrics,
   }) =>
       LintAnalysisConfig(
-        prepareExcludes(config.excludePatterns, rootPath),
+        prepareExcludes(config.excludePatterns, excludesRootFolder),
         getRulesById(config.rules),
         getPatternsById(config.antiPatterns),
         classMetrics ??
@@ -38,8 +38,9 @@ class ConfigBuilder {
               config: config.metrics,
               measuredType: EntityType.methodEntity,
             ),
-        prepareExcludes(config.excludeForMetricsPatterns, rootPath),
+        prepareExcludes(config.excludeForMetricsPatterns, excludesRootFolder),
         config.metrics,
+        excludesRootFolder,
       );
 
   static UnusedFilesConfig getUnusedFilesConfigFromArgs(

lib/src/config_builder/models/analysis_options.dart

@@ -16,7 +16,11 @@ const _analysisOptionsFileName = 'analysis_options.yaml';
 class AnalysisOptions {
   final Map<String, Object> options;
 
-  const AnalysisOptions(this.options);
+  final String? _path;
+
+  const AnalysisOptions(this._path, this.options);
+
+  String? get folderPath => _path?.split('/$_analysisOptionsFileName').first;
 
   Iterable<String> readIterableOfString(Iterable<String> pathSegments) {
     Object? data = options;
@@ -107,8 +111,8 @@ Future<AnalysisOptions> analysisOptionsFromFilePath(String path) {
 
 Future<AnalysisOptions> analysisOptionsFromFile(File? options) async =>
     options != null && options.existsSync()
-        ? AnalysisOptions(await _loadConfigFromYamlFile(options))
-        : const AnalysisOptions({});
+        ? AnalysisOptions(options.path, await _loadConfigFromYamlFile(options))
+        : const AnalysisOptions(null, {});
 
 Future<Map<String, Object>> _loadConfigFromYamlFile(File options) async {
   try {

test/analyzers/lint_analyzer/lint_config_test.dart

@@ -3,7 +3,7 @@ import 'package:dart_code_metrics/src/analyzers/lint_analyzer/lint_config.dart';
 import 'package:dart_code_metrics/src/config_builder/models/analysis_options.dart';
 import 'package:test/test.dart';
 
-const _options = AnalysisOptions({
+const _options = AnalysisOptions('path', {
   'include': 'package:pedantic/analysis_options.yaml',
   'analyzer': {
     'exclude': ['test/resources/**'],
@@ -91,7 +91,7 @@ void main() {
     group('fromAnalysisOptions constructs instance from passed', () {
       test('empty options', () {
         final config =
-            LintConfig.fromAnalysisOptions(const AnalysisOptions({}));
+            LintConfig.fromAnalysisOptions(const AnalysisOptions(null, {}));
 
         expect(config.excludePatterns, isEmpty);
         expect(config.excludeForMetricsPatterns, isEmpty);

test/config_builder/models/analysis_options_test.dart

@@ -102,7 +102,7 @@ void main() {
 
   group('AnalysisOptions', () {
     test('readIterableOfString returns iterables with data or not', () {
-      const options = AnalysisOptions(_options);
+      const options = AnalysisOptions(null, _options);
 
       expect(options.readIterableOfString([]), isEmpty);
       expect(options.readIterableOfString(['key']), isEmpty);
@@ -121,7 +121,7 @@ void main() {
     });
 
     test('readMap returns map with data or not', () {
-      const options = AnalysisOptions(_options);
+      const options = AnalysisOptions(null, _options);
 
       expect(options.readMap([]), equals(_options));
       expect(options.readMap(['include']), isEmpty);
@@ -140,7 +140,7 @@ void main() {
     });
 
     test('readMapOfMap returns map with data or not', () async {
-      const options = AnalysisOptions({
+      const options = AnalysisOptions(null, {
         'dart_code_metrics': {
           'metrics': {'metric-id1': 10},
           'metrics-exclude': ['documentation/**'],