Skip to main content

Analyze

Reports lint rules violations.

To execute the command, run:

$ dcm analyze lib # or dcm a lib
info

You need to configure rules entry in the analysis_options.yaml to have a rules report included into the result.

Full command description:

Usage: dcm analyze [arguments] <directories>
-h, --help                                       Print this usage information.


-r, --reporter=<console>                         Analysis output format.
                                                 [console (default), json, codeclimate, gitlab, checkstyle, github]
-a, --absolute-path                              Show absolute paths in console reporter output.
    --json-path=<path/to/file.json>              Path to the JSON file with the analysis output.


-c, --print-config                               Print resolved config.


    --root-folder=<./>                           Root folder.
                                                 (defaults to the current directory)
    --sdk-path=<directory-path>                  Dart SDK directory path.
                                                 If the project has a `.fvm/flutter_sdk` symlink, it will be used if the SDK is not found. 
    --exclude=<{**/*.g.dart,**/*.freezed.dart}>  File paths in Glob syntax to be exclude.
                                                 (defaults to "{**/*.g.dart,**/*.freezed.dart}")


    --no-congratulate                            Don't show output even when there are no issues.


    --verbose                                    Show verbose logs.


    --ci-key                                     The license key to run on CI server.
    --email                                      The email used to purchase the license.


    --no-analytics                               Disable sending anonymous usage statistics.


    --[no-]fatal-style                           Treat style level issues as fatal.
    --[no-]fatal-performance                     Treat performance level issues as fatal.
    --[no-]fatal-warnings                        Treat warning level issues as fatal.
                                                 (defaults to on)

Output example​

Console​

Use --reporter=console to enable this format.

Console

JSON​

The reporter prints a single JSON object containing meta information and the violations grouped by a file. Use --reporter=json to enable this format.

The root object fields are​

  • formatVersion - an integer representing the format version (will be incremented each time the serialization format changes)
  • timestamp - a creation time of the report in YYYY-MM-DD HH:MM:SS format
  • records - an array of objects
{
  "formatVersion": 2,
  "timestamp": "2021-04-11 14:44:42",
  "records": [
    {
      ...
    },
    {
      ...
    },
    {
      ...
    }
  ]
}

The record object fields are​

  • path - a relative path to the target file
  • issues - an array of issues detected in the target file
{
  "path": "lib/src/metrics/metric_computation_result.dart",
  "issues": [
    ...
  ]
}

The issue object fields are​

  • ruleId - an id of the rule associated with the issue
  • documentation - an url of a page containing documentation associated with the issue
  • codeSpan - a source code span associated with the issue
  • severity - a severity of the issue
  • message - a short message
{
  "ruleId": "long-parameter-list",
  "documentation": "https://git.io/JUGrU",
  "codeSpan": {
    ...
  },
  "severity": "none",
  "message": "Long Parameter List. This function require 5 arguments.",
}

The code span object fields are​

  • start - a start location of an entity
  • end - an end location of an entity
  • text - a source code text of an entity
{
  "start": {
    ...
  },
  "end": {
    ...
  },
  "text": "entity source code"
}

The location object fields are​

  • offset - a zero-based offset of the location in the source
  • line - a zero-based line of the location in the source
  • column - a zero-based column of the location in the source
{
  "offset": 156,
  "line": 7,
  "column": 1
}

GitHub​

Reports about design and static code diagnostics issues in pull requests based on GitHub Actions Workflow commands. Use --reporter=github to enable this format.

  • Install dart/flutter and get packages:

    Flutter example

    jobs:
      your_job_name:
        steps:
          - name: Install Flutter
            uses: subosito/flutter-action@master
            with:
              channel: stable

          - name: Install dependencies
            run: flutter pub get
          ...

    Dart example

    jobs:
      your_job_name:
        steps:
          - name: Install Dart
            uses: dart-lang/setup-dart@v1

          - name: Install dependencies
            run: dart pub get
          ...

  • Run DCM:

    - name: Run DCM
      run: dcm analyze --reporter=github lib

Full Example​

jobs:
  your_job_name:
    steps:
      - name: Install Flutter
        uses: subosito/flutter-action@master
        with:
          channel: stable

      - name: Install dependencies
        run: flutter pub get

      - name: Run DCM
        run: dcm analyze --reporter=github lib

Example of a report in a PR:

Report example

GitLab​

Reports lint issues in merge requests based on Code Quality custom tool. Use --reporter=gitlab to enable this format.

code_quality:
  image: dart
  script:
    - dcm analyze --reporter=gitlab lib > code-quality-report.json
  artifacts:
    reports:
      codequality: code-quality-report.json

Example of a Code Quality widget in a PR:

Code Quality widget

Example of a Code Quality in a PR diff view:

GitLab diff

Checkstyle​

Use --reporter=checkstyle to enable this format.

<?xml version="1.0"?>
<checkstyle version="10.0">
  <file name="lib/src/analyzers/lint_analyzer/lint_analyzer.dart">
    <error line="168" column="3" severity="ignore" message="Long method. This method contains 63 lines with code." source="long-method"/>
  </file>
  <file name="lib/src/analyzers/lint_analyzer/rules/rules_list/avoid_returning_widgets/visit_declaration.dart">
    <error line="3" column="1" severity="ignore" message="Long Parameter List. This function require 6 arguments." source="long-parameter-list"/>
  </file>
  <file name="lib/src/analyzers/lint_analyzer/reporters/utility_selector.dart">
    <error line="27" column="3" severity="ignore" message="Long method. This method contains 53 lines with code." source="long-method"/>
  </file>
  <file name="lib/src/analyzers/lint_analyzer/reporters/reporters_list/html/utility_functions.dart">
    <error line="45" column="1" severity="ignore" message="Long function. This function contains 56 lines with code." source="long-method"/>
  </file>
  <file name="lib/src/analyzers/lint_analyzer/reporters/reporters_list/html/lint_html_reporter.dart">
    <error line="74" column="3" severity="ignore" message="Long method. This method contains 136 lines with code." source="long-method"/>
    <error line="330" column="3" severity="ignore" message="Long method. This method contains 159 lines with code." source="long-method"/>
  </file>
</checkstyle>

Example Bitbucket pipeline configuration​

image: dart

pipelines:
  default:
    - step:
        name: analyze
        script:
          - dcm analyze --reporter=checkstyle lib > checkstyle-result.xml
        after-script:
          - pipe: atlassian/checkstyle-report:0.3.1

Example of a report:

Checkstyle report in Bitbucket