Skip to main content

Excluding Code from Analysis

info

DCM also excludes files listed in the analyzer exclude: option. For example,

analysis_options.yaml
analyzer:
  exclude:
    - 'example/**'
    - 'build/**'
    - '**/*.g.dart'
    - '**/*.freezed.dart'

will also disable DCM analysis for the listed files.

Using Comments​

info

Ignore comments that don't actually ignore any rule diagnostic will be highlighted with "avoid-unused-rule-ignores" issues.

To ignore a specific rule warning, add // ignore comment:

// ignore: no-empty-block
void emptyFunction() {}

End-of-line comments are supported as well. The following communicates the same:

void emptyFunction() {} // ignore: no-empty-block
note

To disable ignores for a particular rule, set ignorable to false:

analysis_options.yaml
dart_code_metrics:
  rules:
    - no-empty-block:
        ignorable: false

To ignore a rule for an entire file, use the ignore_for_file comment. For example,

// ignore_for_file: no-empty-block
...

void emptyFunction() {}

To ignore a rule for pubspec.yaml, use # ignore and # ignore_for_file comments, For example,

name: some_package

dependencies:
  some_dependency: ^1.0.0 # ignore: prefer-pinned-version-syntax

It's the same approach that the dart linter package use.

To ignore all lint rules, use // ignore_for_file: type=lint.

Commands also support ignore via comments. For example, ignore_for_file: unused-code comment will suppress unused code check for an entire file.

info

Although it's not recommended to suppress metrics, they can also be suppressed via // ignore: and // ignore_for_file: comments.

To ignore all metrics for a particular method, use // ignore: metrics.

To ignore all metrics, use // ignore_for_file: type=metrics.

Using Configuration​

Excluding Rules​

To exclude specific files from the rules analysis, configure the exclude option:

analysis_options.yaml
dart_code_metrics:
  rules:
    - no-equal-arguments:
        exclude:
          - test/**

To exclude a file for all rules, configure the global exclude:rules: option:

analysis_options.yaml
dart_code_metrics:
  exclude:
    rules:
      - test/**
      - lib/src/some_file.dart

Excluding Unused Code​

To exclude a file from the unused code analysis, configure the global exclude:unused-code: option:

analysis_options.yaml
dart_code_metrics:
  exclude:
    unused-code:
      - test/**
      - lib/src/some_file.dart

Excluding Unused Files​

To exclude a file from the unused files analysis, configure the global exclude:unused-files: option:

analysis_options.yaml
dart_code_metrics:
  exclude:
    unused-files:
      - test/**
      - lib/src/some_file.dart

Excluding Parameters​

To exclude a file from the parameters analysis, configure the global exclude:parameters: option:

analysis_options.yaml
dart_code_metrics:
  exclude:
    parameters:
      - test/**
      - lib/src/some_file.dart

Excluding Dependencies​

To exclude a file from the dependencies analysis, configure the global exclude:dependencies: option:

analysis_options.yaml
dart_code_metrics:
  exclude:
    dependencies:
      - test/**
      - lib/src/some_file.dart

Excludes for All Commands​

To configure excludes for all commands, set the exclude:all: option:

analysis_options.yaml
dart_code_metrics:
  exclude:
    all:
      - test/**
      - lib/src/some_file.dart
Last updated on