dart_code_metrics_presets 2.2.0 copy "dart_code_metrics_presets: ^2.2.0" to clipboard
dart_code_metrics_presets: ^2.2.0 copied to clipboard

Predefined presets for Dart Code Metrics.

Pub Version License package publisher

DCM Presets #

DCM is an advanced linter for Dart and Flutter that helps you analyse and improve your code quality. You can find all available lint rules here.

This repository contains a list of predefined presets for DCM:

  • All: contains all available lint rules for Dart and Flutter.
  • Dart: contains all lint rules applicable to any Dart app.
  • Flutter: contains all lint rules applicable to any Flutter app.
  • Flame: contains all lint rules for the Flame package.
  • Provider: contains all lint rules for the Provider package.
  • Intl: contains all lint rules for the Intl package.
  • Bloc: contains all lint rules for the Bloc package.
  • Equatable: contains all lint rules for the Equatable package.
  • Patrol: contains all lint rules for the Patrol package.
  • Pub: contains all lint rules for linting the pubspec.yaml files.

How to use a preset #

Take these steps to enable a preset:

  1. Install this package as a dev dependency:

    dart pub add --dev dart_code_metrics_presets
    

    or:

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

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

Disabling or reconfiguring a rule from the preset #

To disable a rule, simply set its value to false:

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

To reconfigure a rule, that is included into a preset:

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

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.