Command Line Interface
To use the package as a command-line tool, run:
$ dcm <command> lib
It will produce a result in one of the supported formats:
- Console Free+
- HTML Pro+
- GitHub Teams+
- Checkstyle Teams+
- Code Climate Teams+
- JSON Teams+
Available commands
The following table shows which commands you can use with the tool:
| Command | Alias | Example of use | Short description |
|---|---|---|---|
| init | i | dcm init lib | General command to set up DCM. |
| run | r | dcm run --analyze lib | Runs multiple passed DCM commands at once. |
| analyze | a | dcm analyze lib | Reports lint rules violations. |
| analyze-widgets | aw | dcm analyze-widgets lib | Collects quality score and usages of Flutter widgets. |
| analyze-structure | as | dcm analyze-structure lib | Shows how files depend on each other and external packages. |
| fix | f | dcm fix lib | Fixes issues produced by dcm analyze command. |
| format | fmt | dcm format lib | Formats *.dart files. |
| calculate-metrics | cm | dcm calculate-metrics lib | Collect code metrics for Dart code. |
| check-exports-completeness | ec | dcm check-exports-completeness lib | Checks that an exported API exports all used types. |
| check-parameters | p | dcm check-parameters lib | Checks various issues with parameters. |
| check-unused-files | uf | dcm check-unused-files lib | Checks unused *.dart files. |
| check-unused-l10n | ul | dcm check-unused-l10n lib | Checks unused localization in *.dart files. |
| check-unused-code | uc | dcm check-unused-code lib | Checks unused code in *.dart files. |
| check-dependencies | d | dcm check-dependencies lib | Checks missing, under-promoted, over-promoted, and unused dependencies. |
For additional help on any of the commands:
$ dcm <command> --help
Global options
Global options:
-h, --help Print this usage information.
--version Reports the version of this tool.
--show-installation-hint Show a hint on how to install this particular DCM version.
Multi-package repositories usage
If you run a command from the root of a multi-package repository (a.k.a. monorepo), it'll pick up analysis_options.yaml files correctly.
Additionally, if you use Melos, you can add custom command to the melos.yaml.
metrics:
run: |
melos exec -c 1 --ignore="*example*" -- \
dcm analyze lib
description: |
Run DCM in all packages.
- Note: you can also rely on your IDEs Dart Analysis / Issues window.
Manually locating the Dart SDK
If for some reason the Dart SDK was not located automatically (and you have it in your PATH), pass the --sdk-path CLI option with the absolute path to the SDK folder when calling any DCM command.
For a locally installed Flutter SDK, the expected folder is named dart-sdk and is typically located at ...flutter/bin/cache/dart-sdk (where flutter is the Flutter SDK folder).
Alternatively, you can run which dart (or an alternative Windows command) and replace /dart with /cache/dart-sdk.
If you are setting the path to the Dart SDK manually, consider reaching out to our support team.
We are interested in supporting as many cases as possible to ultimately reduce the need for manual setup to zero.