Skip to main content

Presets

DCM includes 17 sets of predefined configurations:

  • All: contains all available lint rules for Dart and Flutter.
  • Recommended: contains recommended Dart and Flutter rules (with an emphasis on finding errors).
  • Dart: contains all lint rules applicable to any Dart app.
  • Flutter: contains all lint rules applicable to any Flutter app.
  • Flame: contains lint rules for the Flame package.
  • Provider: contains lint rules for the Provider package.
  • Bloc: contains lint rules for the Bloc package.
  • Riverpod: contains lint rules for the Riverpod package.
  • Equatable: contains lint rules for the Equatable package.
  • Patrol: contains lint rules for the Patrol package.
  • FakeAsync: contains lint rules for the FakeAsync package.
  • GetIt: contains lint rules for the GetIt package.
  • FlutterHooks: contains lint rules for the FlutterHooks package.
  • GetX: contains lint rules for the GetX package.
  • Intl: contains lint rules for the Intl package.
  • Pub: contains lint rules to check for issues in the pubspec.yaml file.
  • Recommended metrics: contains recommended configured metrics.
info

While presets are a great way to keep track of rule list updates, upgrading to a newer version of DCM can introduce new issues if the preset has been updated.

Consider this before choosing a preset.

Built-in presets

To simplify the tool's integration, the "recommended" preset can be enabled without installing the "dart_code_metrics_presets" package.

analysis_options.yaml
dart_code_metrics:
extends:
- recommended

Since this preset comes with the executable, the list of rules included into it depends on the executable version, but is expected to match the latest version of located here.

Enabling a preset

To enable a preset:

  1. Install dart_code_metrics_presets as a dev dependency:

    $ flutter pub add --dev dart_code_metrics_presets
  2. For DCM configuration add the extends entry:

    analysis_options.yaml
    dart_code_metrics:
    extends:
    - package:dart_code_metrics_presets/all.yaml
info

If you are reusing a shared configuration between multiple packages, they should all have dart_code_metrics_presets as dev dependency.

info

If the preset cannot be resolved, a preset-not-found warning will be shown.

Reconfiguring a rule

To reconfigure a rule included into a preset:

analysis_options.yaml
dart_code_metrics:
extends:
- package:dart_code_metrics_presets/all.yaml
rules:
- arguments-ordering:
child-last: true

Disabling a rule

To disable a rule set its configuration to : false:

analysis_options.yaml
dart_code_metrics:
extends:
- package:dart_code_metrics_presets/all.yaml
rules:
- avoid-banned-imports: false

Defining a custom preset

Any other preset can be passed to the extends entry. To create a custom preset create a yaml file with the same structure as for regular DCM configuration.