dartanalyzer

dartanalyzer documentation

Version in MegaLinter: 3.6.1
Visit Official Web Site
See How to configure dartanalyzer rules
See How to disable dartanalyzer rules in files
See Index of problems detected by dartanalyzer

Configuration in MegaLinter

Enable dartanalyzer by adding DART_DARTANALYZER in ENABLE_LINTERS variable
Disable dartanalyzer by adding DART_DARTANALYZER in DISABLE_LINTERS variable

Variable	Description	Default value
DART_DARTANALYZER_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
DART_DARTANALYZER_COMMAND_REMOVE_ARGUMENTS	User custom arguments to remove from command line before calling the linter 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 - `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_UNSECURED_ENV_VARIABLES	List of env variables explicitly not filtered before calling DART_DARTANALYZER and its pre/post commands	None
DART_DARTANALYZER_CONFIG_FILE	dartanalyzer configuration file nameUse `LINTER_DEFAULT` to let the linter find it	`analysis_options.yaml`
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`
DART_DARTANALYZER_CLI_EXECUTABLE	Override CLI executable	`['dart']`

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

MegaLinter Flavors

This linter is available in the following flavors

	Flavor	Description	Embedded linters	Info
	all	Default MegaLinter Flavor	125

Behind the scenes

How are identified applicable files

File extensions: .dart

How the linting is performed

dartanalyzer is called one time by identified file (file CLI lint mode)

Example calls

dart analyze --fatal-infos --fatal-warnings myfile.dart

Help content

Analyze Dart code in a directory.

Usage: dart analyze [arguments] [<directory>]
-h, --help                   Print this usage information.
    --fatal-infos            Treat info level issues as fatal.
    --[no-]fatal-warnings    Treat warning level issues as fatal.
                             (defaults to on)

Run "dart help" to see global options.

Installation on mega-linter Docker image

Dockerfile commands :

# Parent descriptor install
ENV LANG=C.UTF-8
RUN ALPINE_GLIBC_BASE_URL="https://github.com/sgerrand/alpine-pkg-glibc/releases/download" && \
    ALPINE_GLIBC_PACKAGE_VERSION="2.34-r0" && \
    ALPINE_GLIBC_BASE_PACKAGE_FILENAME="glibc-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
    ALPINE_GLIBC_BIN_PACKAGE_FILENAME="glibc-bin-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
    ALPINE_GLIBC_I18N_PACKAGE_FILENAME="glibc-i18n-$ALPINE_GLIBC_PACKAGE_VERSION.apk" && \
    apk add --no-cache --virtual=.build-dependencies wget ca-certificates && \
    echo \
        "-----BEGIN PUBLIC KEY-----\
        MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApZ2u1KJKUu/fW4A25y9m\
        y70AGEa/J3Wi5ibNVGNn1gT1r0VfgeWd0pUybS4UmcHdiNzxJPgoWQhV2SSW1JYu\
        tOqKZF5QSN6X937PTUpNBjUvLtTQ1ve1fp39uf/lEXPpFpOPL88LKnDBgbh7wkCp\
        m2KzLVGChf83MS0ShL6G9EQIAUxLm99VpgRjwqTQ/KfzGtpke1wqws4au0Ab4qPY\
        KXvMLSPLUp7cfulWvhmZSegr5AdhNw5KNizPqCJT8ZrGvgHypXyiFvvAH5YRtSsc\
        Zvo9GI2e2MaZyo9/lvb+LbLEJZKEQckqRj4P26gmASrZEPStwc+yqy1ShHLA0j6m\
        1QIDAQAB\
        -----END PUBLIC KEY-----" | sed 's/   */\\n/g' > "/etc/apk/keys/sgerrand.rsa.pub" && \
    wget --quiet --tries=10 --waitretry=10 \
        "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
        "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
        "$ALPINE_GLIBC_BASE_URL/$ALPINE_GLIBC_PACKAGE_VERSION/$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
    mv /etc/nsswitch.conf /etc/nsswitch.conf.bak && \
    apk add --no-cache --force-overwrite \
        "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
        "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
        "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME" && \
    \
    mv /etc/nsswitch.conf.bak /etc/nsswitch.conf && \
    rm "/etc/apk/keys/sgerrand.rsa.pub" && \
    (/usr/glibc-compat/bin/localedef --force --inputfile POSIX --charmap UTF-8 "$LANG" || true) && \
    echo "export LANG=$LANG" > /etc/profile.d/locale.sh && \
    \
    apk del glibc-i18n && \
    \
    rm "/root/.wget-hsts" && \
    apk del .build-dependencies && \
    rm \
        "$ALPINE_GLIBC_BASE_PACKAGE_FILENAME" \
        "$ALPINE_GLIBC_BIN_PACKAGE_FILENAME" \
        "$ALPINE_GLIBC_I18N_PACKAGE_FILENAME"

# Linter install
# renovate: datasource=dart-version depName=dart
ARG DART_VERSION='3.6.1'
RUN wget --tries=5 https://storage.googleapis.com/dart-archive/channels/stable/release/${DART_VERSION}/sdk/dartsdk-linux-x64-release.zip -O - -q | unzip -q - \
    && mkdir -p /usr/lib/dart \
    && mv dart-sdk/* /usr/lib/dart/ \
    && chmod +x /usr/lib/dart/bin/dart \
    && rm -r dart-sdk/

ENV PATH="/usr/lib/dart/bin:${PATH}"