feat: add support for presets (#1025)

* feat: add support for presets

* refactor: move reusable code to function

* docs: add docs about presets

Author: incendial

CHANGELOG.md

@@ -1,9 +1,10 @@
 # Changelog
 
-## 4.21.0
+## Unreleased
 
 * fix: add rule 'missing-test-assertion' in rules factory.
 * feat: add static code diagnostic [`missing-test-assertion`](https://dartcodemetrics.dev/docs/rules/common/missing-test-assertion).
+* feat: add support for presets
 
 ## 4.20.0
 

lib/presets/all.yaml

@@ -0,0 +1,4 @@
+dart_code_metrics:
+  extends:
+    - package:dart_code_metrics/presets/dart_all.yaml
+    - package:dart_code_metrics/presets/flutter_all.yaml

lib/presets/dart_all.yaml

@@ -0,0 +1,49 @@
+dart_code_metrics:
+  rules:
+    - avoid-banned-imports
+    - avoid-collection-methods-with-unrelated-types
+    - avoid-duplicate-exports
+    - avoid-dynamic
+    - avoid-global-state
+    - avoid-ignoring-return-values
+    - avoid-late-keyword
+    - avoid-missing-enum-constant-in-map
+    - avoid-nested-conditional-expressions
+    - avoid-non-ascii-symbols
+    - avoid-non-null-assertion
+    - avoid-passing-async-when-sync-expected
+    - avoid-redundant-async
+    - avoid-throw-in-catch-block
+    - avoid-top-level-members-in-tests
+    - avoid-unnecessary-type-assertions
+    - avoid-unnecessary-type-casts
+    - avoid-unrelated-type-assertions
+    - avoid-unused-parameters
+    - ban-name
+    - binary-expression-operand-order
+    - double-literal-format
+    - format-comment
+    - member-ordering-extended
+    - newline-before-return
+    - no-boolean-literal-compare
+    - no-empty-block
+    - no-equal-arguments
+    - no-equal-then-else
+    - no-magic-number
+    - no-object-declaration
+    - prefer-async-await
+    - prefer-commenting-analyzer-ignores
+    - prefer-conditional-expressions
+    - prefer-correct-identifier-length
+    - prefer-correct-test-file-name
+    - prefer-correct-type-name
+    - prefer-enums-by-name
+    - prefer-first
+    - prefer-immediate-return
+    - prefer-iterable-of
+    - prefer-last
+    - prefer-match-file-name
+    - prefer-moving-to-variable
+    - prefer-trailing-comma
+    - prefer-trailing-comma
+    - tag-name

lib/presets/flutter_all.yaml

@@ -0,0 +1,15 @@
+dart_code_metrics:
+  rules:
+    - always-remove-listener
+    - avoid-border-all
+    - avoid-returning-widgets
+    - avoid-shrink-wrap-in-lists
+    - avoid-unnecessary-setstate
+    - avoid-use-expanded-as-spacer
+    - avoid-wrapping-in-padding
+    - check-for-equals-in-render-object-setters
+    - consistent-update-render-object
+    - prefer-const-border-radius
+    - prefer-correct-edge-insets-constructor
+    - prefer-extracting-callbacks
+    - prefer-single-widget-per-file

lib/src/analyzers/lint_analyzer/lint_config.dart

@@ -22,20 +22,17 @@ class LintConfig {
   });
 
   /// Creates the config from analysis [options].
-  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']),
-      excludeForRulesPatterns:
-          options.readIterableOfString([rootKey, 'rules-exclude']),
-      antiPatterns: options.readMapOfMap([rootKey, 'anti-patterns']),
-    );
-  }
+  factory LintConfig.fromAnalysisOptions(AnalysisOptions options) => LintConfig(
+        excludePatterns: options.readIterableOfString(['analyzer', 'exclude']),
+        excludeForMetricsPatterns: options
+            .readIterableOfString(['metrics-exclude'], packageRelated: true),
+        metrics: options.readMap(['metrics'], packageRelated: true),
+        rules: options.readMapOfMap(['rules'], packageRelated: true),
+        excludeForRulesPatterns: options
+            .readIterableOfString(['rules-exclude'], packageRelated: true),
+        antiPatterns:
+            options.readMapOfMap(['anti-patterns'], packageRelated: true),
+      );
 
   /// Creates the config from cli [arguments].
   factory LintConfig.fromArgs(ParsedArguments arguments) => LintConfig(

lib/src/config_builder/models/analysis_options.dart

@@ -10,6 +10,8 @@ import '../analysis_options_utils.dart';
 
 const _analysisOptionsFileName = 'analysis_options.yaml';
 
+const _rootKey = 'dart_code_metrics';
+
 /// Class representing dart analysis options.
 class AnalysisOptions {
   final Map<String, Object> options;
@@ -24,10 +26,16 @@ class AnalysisOptions {
     return finalPath == null ? null : p.dirname(finalPath);
   }
 
-  Iterable<String> readIterableOfString(Iterable<String> pathSegments) {
+  Iterable<String> readIterableOfString(
+    Iterable<String> pathSegments, {
+    bool packageRelated = false,
+  }) {
+    final usedSegments =
+        packageRelated ? [_rootKey, ...pathSegments] : pathSegments;
+
     Object? data = options;
 
-    for (final key in pathSegments) {
+    for (final key in usedSegments) {
       if (data is Map<String, Object> && data.containsKey(key)) {
         data = data[key];
       } else {
@@ -38,10 +46,16 @@ class AnalysisOptions {
     return isIterableOfStrings(data) ? (data as Iterable).cast<String>() : [];
   }
 
-  Map<String, Object> readMap(Iterable<String> pathSegments) {
+  Map<String, Object> readMap(
+    Iterable<String> pathSegments, {
+    bool packageRelated = false,
+  }) {
+    final usedSegments =
+        packageRelated ? [_rootKey, ...pathSegments] : pathSegments;
+
     Object? data = options;
 
-    for (final key in pathSegments) {
+    for (final key in usedSegments) {
       if (data is Map<String, Object?> && data.containsKey(key)) {
         data = data[key];
       } else {
@@ -52,10 +66,16 @@ class AnalysisOptions {
     return data is Map<String, Object> ? data : {};
   }
 
-  Map<String, Map<String, Object>> readMapOfMap(Iterable<String> pathSegments) {
+  Map<String, Map<String, Object>> readMapOfMap(
+    Iterable<String> pathSegments, {
+    bool packageRelated = false,
+  }) {
+    final usedSegments =
+        packageRelated ? [_rootKey, ...pathSegments] : pathSegments;
+
     Object? data = options;
 
-    for (final key in pathSegments) {
+    for (final key in usedSegments) {
       if (data is Map<String, Object?> && data.containsKey(key)) {
         data = data[key];
       } else {
@@ -154,24 +174,49 @@ Map<String, Object> _loadConfigFromYamlFile(
     var optionsNode =
         node is YamlMap ? yamlMapToDartMap(node) : <String, Object>{};
 
-    final includeNode = optionsNode['include'];
-    if (includeNode is String) {
-      final packageImport = includeNode.startsWith('package:');
-
-      final resolvedUri = packageImport
-          ? converter.uriToPath(Uri.parse(includeNode))
-          : p.absolute(p.dirname(options.path), includeNode);
+    final path = optionsNode['include'];
+    if (path is String) {
+      optionsNode =
+          _resolveImportAsOptions(options, converter, path, optionsNode);
+    }
 
-      if (resolvedUri != null) {
-        final resolvedYamlMap =
-            _loadConfigFromYamlFile(File(resolvedUri), converter);
-        optionsNode =
-            mergeMaps(defaults: resolvedYamlMap, overrides: optionsNode);
-      }
+    final rootConfig = optionsNode[_rootKey];
+    final extendedNode =
+        rootConfig is Map<String, Object> ? rootConfig['extends'] : null;
+    final extendConfig = extendedNode is String
+        ? [extendedNode]
+        : extendedNode is Iterable<Object>
+            ? extendedNode.cast<String>()
+            : <String>[];
+    for (final path in extendConfig) {
+      optionsNode =
+          _resolveImportAsOptions(options, converter, path, optionsNode);
     }
 
     return optionsNode;
   } on YamlException catch (e) {
     throw FormatException(e.message, e.span);
   }
 }
+
+Map<String, Object> _resolveImportAsOptions(
+  File options,
+  UriConverter converter,
+  String path,
+  Map<String, Object> optionsNode,
+) {
+  final packageImport = path.startsWith('package:');
+
+  final resolvedUri = packageImport
+      ? converter.uriToPath(Uri.parse(path))
+      : p.absolute(p.dirname(options.path), path);
+
+  if (resolvedUri != null) {
+    final resolvedYamlMap =
+        _loadConfigFromYamlFile(File(resolvedUri), converter);
+
+    return mergeMaps(defaults: resolvedYamlMap, overrides: optionsNode);
+  }
+
+  return optionsNode;
+}

test/resources/analysis_options_with_extends.yaml

@@ -0,0 +1,17 @@
+include: package:lints/recommended.yaml
+
+analyzer:
+  exclude:
+    - example/**
+  strong-mode:
+    implicit-casts: false
+    implicit-dynamic: false
+
+dart_code_metrics:
+  extends:
+    - package:test_lints/presets.yaml
+  metrics-exclude:
+    - test/**
+  rules:
+    - rule-id4
+    - rule-id5

test/resources/test_lints/lib/presets.yaml

@@ -0,0 +1,3 @@
+dart_code_metrics:
+  rules:
+    - rule-id10

test/src/config_builder/models/analysis_options_test.dart

@@ -12,6 +12,7 @@ const _options = {
     'strong-mode': {'implicit-casts': false, 'implicit-dynamic': false},
   },
   'dart_code_metrics': {
+    'extends': ['package:test_lint/presets.yaml'],
     'anti-patterns': {
       'anti-pattern-id1': true,
       'anti-pattern-id2': false,
@@ -125,6 +126,22 @@ void main() {
         equals(['dart_code_metrics']),
       );
     });
+
+    test('extends config', () {
+      const yamlFilePath =
+          './test/resources/analysis_options_with_extends.yaml';
+
+      final options = analysisOptionsFromFile(
+        File(yamlFilePath),
+        collection.contexts.first,
+      );
+
+      expect(options.options['dart_code_metrics'], contains('rules'));
+      expect(
+        (options.options['dart_code_metrics'] as Map<String, Object>)['rules'],
+        allOf(contains('rule-id10')),
+      );
+    });
   });
 
   group('AnalysisOptions', () {
@@ -134,15 +151,15 @@ void main() {
       expect(options.readIterableOfString([]), isEmpty);
       expect(options.readIterableOfString(['key']), isEmpty);
       expect(
-        options.readIterableOfString(['dart_code_metrics', 'anti-patterns']),
+        options.readIterableOfString(['anti-patterns'], packageRelated: true),
         isEmpty,
       );
       expect(
         options.readIterableOfString(['analyzer', 'exclude']),
         equals(['test/resources/**']),
       );
       expect(
-        options.readIterableOfString(['dart_code_metrics', 'metrics-exclude']),
+        options.readIterableOfString(['metrics-exclude'], packageRelated: true),
         equals(['test/**', 'examples/**']),
       );
     });
@@ -152,12 +169,13 @@ void main() {
 
       expect(options.readMap([]), equals(_options));
       expect(options.readMap(['include']), isEmpty);
+      expect(options.readMap(['extends'], packageRelated: true), isEmpty);
       expect(
-        options.readMap(['dart_code_metrics', 'metrics-exclude']),
+        options.readMap(['metrics-exclude'], packageRelated: true),
         isEmpty,
       );
       expect(
-        options.readMap(['dart_code_metrics', 'rules']),
+        options.readMap(['rules'], packageRelated: true),
         allOf(
           containsPair('rule-id1', false),
           containsPair('rule-id2', true),
@@ -193,7 +211,7 @@ void main() {
       expect(options.readMapOfMap(['key']), isEmpty);
 
       expect(
-        options.readMapOfMap(['dart_code_metrics', 'rules1']),
+        options.readMapOfMap(['rules1'], packageRelated: true),
         allOf(
           containsPair('rule-id1', <String, Object>{}),
           containsPair('rule-id2', <String, Object>{}),
@@ -202,26 +220,26 @@ void main() {
       );
 
       expect(
-        options.readMapOfMap(['dart_code_metrics', 'rules2']),
+        options.readMapOfMap(['rules2'], packageRelated: true),
         allOf(
           containsPair('rule-id2', <String, Object>{}),
           containsPair('rule-id3', <String, Object>{}),
         ),
       );
 
       expect(
-        options.readMapOfMap(['dart_code_metrics', 'rules3']),
+        options.readMapOfMap(['rules3'], packageRelated: true),
         allOf(
           containsPair('rule-id1', <String, Object>{}),
           containsPair('rule-id2', {'severity': 'info'}),
           containsPair('rule-id3', <String, Object>{}),
         ),
       );
 
-      expect(options.readMapOfMap(['dart_code_metrics', 'rules4']), isEmpty);
+      expect(options.readMapOfMap(['rules4'], packageRelated: true), isEmpty);
 
       expect(
-        options.readMapOfMap(['dart_code_metrics', 'rules5']),
+        options.readMapOfMap(['rules5'], packageRelated: true),
         allOf(
           containsPair('rule-id2', <String, Object>{}),
           containsPair('rule-id3', <String, Object>{}),

website/docs/getting-started/configuration.md

@@ -8,6 +8,8 @@ To configure the package add a `dart_code_metrics` entry to `analysis_options.ya
 
 ```yaml title="analysis_options.yaml"
 dart_code_metrics:
+  extends:
+    - ... # configures the list of preset configurations
   metrics:
     - ... # configures the list of reported metrics
   metrics-exclude:
@@ -42,6 +44,18 @@ dart_code_metrics:
     - long-parameter-list
 ```
 
+## Extending an existing configuration preset
+
+To extend an existing preset add a reference to the `.yaml` file with the preset in the `extends` entry. For example:
+
+```yaml title="analysis_options.yaml"
+dart_code_metrics:
+  extends:
+    - package:dart_code_metrics/presets/all.yaml
+```
+
+All predefined preset [can be found here](https://github.com/dart-code-checker/dart-code-metrics/tree/master/lib/presets).
+
 ## Configuring a metrics entry {#configuring-a-metrics-entry}
 
 To enable a metric add its id to the `metrics` entry in the `analysis_options.yaml`. All metrics can take a threshold value. If no value was provided, the default value will be used.