Skip to content

dartanalyzer

dartanalyzer documentation

sdk - GitHub

Configuration in MegaLinter

Variable Description Default value
DART_DARTANALYZER_ARGUMENTS User custom arguments to add in linter CLI call
Ex: -s --foo "bar"
DART_DARTANALYZER_FILTER_REGEX_INCLUDE Custom regex including filter
Ex: (src\|lib)
Include every file
DART_DARTANALYZER_FILTER_REGEX_EXCLUDE Custom regex excluding filter
Ex: (test\|examples)
Exclude no file
DART_DARTANALYZER_CLI_LINT_MODE Override default CLI lint mode
- file: Calls the linter for each file
- list_of_files: Call the linter with the list of files as argument
- project: Call the linter from the root of the project
file
DART_DARTANALYZER_FILE_EXTENSIONS Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files
Ex: [".py", ""]
[".dart"]
DART_DARTANALYZER_FILE_NAMES_REGEX File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files
Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]
Include every file
DART_DARTANALYZER_PRE_COMMANDS List of bash commands to run before the linter None
DART_DARTANALYZER_POST_COMMANDS List of bash commands to run after the linter None
DART_DARTANALYZER_CONFIG_FILE dartanalyzer configuration file name
Use LINTER_DEFAULT to let the linter find it
analysis_options.yml
DART_DARTANALYZER_RULES_PATH Path where to find linter configuration file Workspace folder, then MegaLinter default rules
DART_DARTANALYZER_DISABLE_ERRORS Run linter but consider errors as warnings false
DART_DARTANALYZER_DISABLE_ERRORS_IF_LESS_THAN Maximum number of errors allowed 0

IDE Integration

Use dartanalyzer in your favorite IDE to catch errors before MegaLinter !

IDE Extension Name Install
IDEA dart-jetbrains-plugin
Visual Studio Code dart-code Install in VsCode

MegaLinter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default MegaLinter Flavor 97 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 42 Docker Image Size (tag) Docker Pulls

Behind the scenes

How are identified applicable files

  • File extensions: .dart

How the linting is performed

  • dartanalyzer is called one time by identified file

Example calls

dartanalyzer --fatal-infos --fatal-warnings myfile.dart
dartanalyzer --fatal-infos --fatal-warnings --options analysis_options.yml myfile.dart

Help content

Usage: dartanalyzer [options...] <directory or list of files>

    --dart-sdk                    The path to the Dart SDK.
    --options                     Path to an analysis options file.
    --package-root                The path to a package root directory (deprecated). This option cannot be used with --packages.
    --[no-]declaration-casts      Disable declaration casts in strong mode (https://goo.gl/cTLz40)
                                  This option is now ignored and will be removed in a future release.
    --[no-]implicit-casts         Disable implicit casts in strong mode (https://goo.gl/cTLz40).
    --no-implicit-dynamic         Disable implicit dynamic (https://goo.gl/m0UgXD).
    --packages                    The path to the package resolution configuration file, which supplies a mapping of package names
                                  to paths. This option cannot be used with --package-root.
    --[no-]lints                  Show lint results.
    --format                      Specifies the format in which errors are displayed; the only currently allowed value is 'machine'.
    --version                     Print the analyzer version.
    --enable-experiment           Enable one or more experimental features. If multiple features are being added, they should be comma separated.
    --no-hints                    Do not show hint results.
    --fatal-infos                 Treat infos as fatal.
    --fatal-warnings              Treat non-type warnings as fatal.
-h, --help                        Display this help message. Add --verbose to show hidden options.
-v, --verbose                     Verbose output.
    --default-language-version    The default language version when it is not specified via other ways (internal, tests only).

Run "dartanalyzer -h -v" for verbose help output, including less commonly used options.
For more information, see https://www.dartlang.org/tools/analyzer.

Installation on mega-linter Docker image

  • Dockerfile commands :
ARG DART_VERSION='2.8.4'
ARG GLIBC_VERSION='2.31-r0'
RUN wget --tries=5 -q -O /etc/apk/keys/sgerrand.rsa.pub https://alpine-pkgs.sgerrand.com/sgerrand.rsa.pub \
    && wget --tries=5 -q https://github.com/sgerrand/alpine-pkg-glibc/releases/download/${GLIBC_VERSION}/glibc-${GLIBC_VERSION}.apk \
    && apk add --no-cache glibc-${GLIBC_VERSION}.apk && rm glibc-${GLIBC_VERSION}.apk \
    && wget --tries=5 https://storage.googleapis.com/dart-archive/channels/stable/release/${DART_VERSION}/sdk/dartsdk-linux-x64-release.zip -O - -q | unzip -q - \
    && chmod +x dart-sdk/bin/dart* \
    && mv dart-sdk/bin/* /usr/bin/ && mv dart-sdk/lib/* /usr/lib/ && mv dart-sdk/include/* /usr/include/ \
    && rm -r dart-sdk/

Example success log

Results of dartanalyzer linter (version 0.0.0)
See documentation on https://megalinter.github.io/descriptors/dart_dartanalyzer/
-----------------------------------------------

[SUCCESS] .automation/test/dart/dart_good_1.dart
    Analyzing .automation/test/dart/dart_good_1.dart...
    No issues found!

Example error log

Results of dartanalyzer linter (version 0.0.0)
See documentation on https://megalinter.github.io/descriptors/dart_dartanalyzer/
-----------------------------------------------

[ERROR] .automation/test/dart/dart_bad_1.dart
    Analyzing .automation/test/dart/dart_bad_1.dart...
      lint • Use `;` instead of `{}` for empty constructor bodies. • .automation/test/dart/dart_bad_1.dart:4:25 • empty_constructor_bodies
    1 lint found.