MegaLinter

https://megalinter.io/latest/
Admin
MegaLinter is an open-source tool by OX Security designed to verify code consistency across a wide...
Tokens:673,947
Snippets:4,613
Trust Score:7.9
Update:1 week ago
Show doc for...
Tokens:
Raw
### install dockerfile example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of the install object with a dockerfile array, containing Dockerfile instructions.

```json
{
    "dockerfile": [
        "ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk",
        "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""
    ]
}
```

--------------------------------

### install dockerfile example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of the install property using dockerfile instructions to install a linter. It copies the betterleaks binary and verifies the version.

```json
{
    "dockerfile": [
        "FROM ghcr.io/betterleaks/betterleaks:latest AS betterleaks",
        "COPY --from=betterleaks /usr/bin/betterleaks /usr/bin/",
        "RUN betterleaks version"
    ]
}
```

--------------------------------

### install npm example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of the install property using npm packages to install a linter. It lists ESLint and related plugins.

```json
{
    "npm": [
        "eslint",
        "eslint-config-airbnb",
        "eslint-config-prettier",
        "eslint-plugin-jest",
        "eslint-plugin-prettier",
        "babel-eslint"
    ]
}
```

--------------------------------

### install npm example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of the install object with an npm array, specifying npm packages required.

```json
{
    "npm": [
        "sfdx-cli"
    ]
}
```

--------------------------------

### install apk example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of the install object with an apk array, specifying APK packages required.

```json
{
    "apk": [
        "openjdk11"
    ]
}
```

--------------------------------

### Run custom flavor setup command

Source: https://megalinter.io/latest/custom-flavors

Run this command in your repository folder to start the interactive setup for a custom MegaLinter flavor.

```bash
npx mega-linter-runner@beta --custom-flavor-setup

```

--------------------------------

### supported_platforms example with install_override

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of the supported_platforms descriptor option with an install_override for a specific platform (linux/arm64). The override provides custom Dockerfile install instructions for PowerShell.

```json
{
    "install_override": [
        {
            "install": {
                "dockerfile": [
                    "ARG PWSH_VERSION='latest'",
                    "ARG PWSH_DIRECTORY='/opt/microsoft/powershell'",
                    "RUN mkdir -p ${PWSH_DIRECTORY} \\
    && curl --retry 5 --retry-delay 5 -s https://api.github.com/repos/powershell/powershell/releases/${PWSH_VERSION} \\
        | grep browser_download_url \\
        | grep linux-arm64 \\
        | cut -d '\"' -f 4 \\
        | xargs -n 1 wget -O - \\
        | tar -xzC ${PWSH_DIRECTORY} \\
    && ln -sf ${PWSH_DIRECTORY}/pwsh /usr/bin/pwsh
"
                ]
            },
            "platform": "linux/arm64"
        }
    ],
    "platform": [
        "linux/amd64",
        "linux/arm64"
    ]
}
```

--------------------------------

### Set up documentation environment (one-time)

Source: https://megalinter.io/latest/contributing

Install pipx and hatch, then enter the hatch shell to set up the virtual environment for documentation work.

```bash
pip install pipx
pipx install hatch
hatch shell

```

--------------------------------

### PowerShell -WorkingDirectory example: start in home directory

Source: https://megalinter.io/latest/descriptors/powershell_powershell

Example of using -WorkingDirectory to start PowerShell in the user's home directory.

```powershell
pwsh -WorkingDirectory ~
```

--------------------------------

### supported_platforms examples

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Examples of the supported_platforms object. The first shows a simple platform list, the second shows a single platform, and the third shows an install_override for a specific platform.

```json
{
    "platform": [
        "linux/amd64",
        "linux/arm64"
    ]
}
```

```json
{
    "platform": [
        "linux/amd64"
    ]
}
```

```json
{
    "install_override": [
        {
            "install": {
                "dockerfile": [
                    "RUN ML_THIRD_PARTY_DIR=\"/third-party/shellcheck\" \\
    && mkdir -p ${ML_THIRD_PARTY_DIR} \\
    && wget -qO- \"https://github.com/koalaman/shellcheck/releases/download/stable/shellcheck-stable.linux.aarch64.tar.xz\" | tar -xJv --directory ${ML_THIRD_PARTY_DIR} \\
    && mv \"${ML_THIRD_PARTY_DIR}/shellcheck-stable/shellcheck\" /usr/bin/ \\
    && find ${ML_THIRD_PARTY_DIR} -type f -not -name 'LICENSE*' -delete -o -type d -empty -delete \\
    && shellcheck --version
"
                ]
            },
            "platform": "linux/arm64"
        }
    ],
    "platform": [
        "linux/amd64",
        "linux/arm64"
    ]
}
```

--------------------------------

### PowerShell -OutputFormat example: output as XML

Source: https://megalinter.io/latest/descriptors/powershell_powershell

Example of using -OutputFormat XML to get output as serialized CLIXML text.

```powershell
pwsh -o XML -c Get-Date
```

--------------------------------

### Dockerfile instructions list example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of the dockerfile field, an array of strings that will be automatically integrated in the generated Dockerfile.

```json
[
    "FROM ghcr.io/betterleaks/betterleaks:latest AS betterleaks",
    "COPY --from=betterleaks /usr/bin/betterleaks /usr/bin/",
    "RUN betterleaks version"
]
```

--------------------------------

### Build and serve documentation

Source: https://megalinter.io/latest/contributing

Run the docs server with 'hatch run build:serve'. It listens on http://127.0.0.1:8000/ and auto-updates on .md file changes.

```bash
hatch run build:serve

```

--------------------------------

### JAVASCRIPT_ES linter definition example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example JSON object for a linter definition, showing required properties linter_url and examples, plus optional fields like cli_config_extra_args, config_file_name, install, linter_banner_image_url, linter_name, and name. The example uses ESLint with npm packages and example commands.

```json
{
    "cli_config_extra_args": [
        "--no-eslintrc",
        "--no-ignore"
    ],
    "config_file_name": ".eslintrc.yml",
    "examples": [
        "eslint myfile.js",
        "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"
    ],
    "install": {
        "npm": [
            "eslint",
            "eslint-config-airbnb",
            "eslint-config-prettier",
            "eslint-plugin-jest",
            "eslint-plugin-prettier",
            "babel-eslint"
        ]
    },
    "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png",
    "linter_name": "eslint",
    "linter_url": "https://eslint.org",
    "name": "JAVASCRIPT_ES"
}
```

--------------------------------

### Dockerfile instructions packages example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of the dockerfile field, listing Dockerfile instructions that will be automatically integrated into the generated Dockerfile.

```json
[
    "ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk",
    "ENV PATH=\"$JAVA_HOME/bin:${PATH}\""
]
```

--------------------------------

### Dockerfile commands for arm-ttk installation

Source: https://megalinter.io/latest/descriptors/arm_arm_ttk

Dockerfile commands to install PowerShell and arm-ttk in the MegaLinter Docker image. Includes version arguments, download, extraction, and symlink setup.

```dockerfile
# Parent descriptor install
ARG TARGETPLATFORM
# renovate: datasource=github-tags depName=PowerShell/PowerShell
ARG POWERSHELL_VERSION=7.6.5
RUN case ${TARGETPLATFORM} in \
  "linux/amd64")  POWERSHELL_ARCH=musl-x64 ;; \
  "linux/arm64")  POWERSHELL_ARCH=arm64    ;; \
esac \
    && curl -L https://github.com/PowerShell/PowerShell/releases/download/v${POWERSHELL_VERSION}/powershell-${POWERSHELL_VERSION}-linux-${POWERSHELL_ARCH}.tar.gz -o /tmp/powershell.tar.gz \
    && mkdir -p /opt/microsoft/powershell/7 \
    && tar zxf /tmp/powershell.tar.gz -C /opt/microsoft/powershell/7 \
    && chmod +x /opt/microsoft/powershell/7/pwsh \
    && ln -s /opt/microsoft/powershell/7/pwsh /usr/bin/pwsh

# Linter install
# renovate: datasource=github-tags depName=Azure/arm-ttk
ARG ARM_TTK_VERSION=20250401
ARG ARM_TTK_NAME='arm-ttk.zip'
ARG ARM_TTK_DIRECTORY='/opt/microsoft'
ENV ARM_TTK_PSD1="${ARM_TTK_DIRECTORY}/arm-ttk/arm-ttk/arm-ttk.psd1"
RUN curl --retry 5 --retry-delay 5 -sLO "https://github.com/Azure/arm-ttk/releases/download/${ARM_TTK_VERSION}/${ARM_TTK_NAME}" \
    && unzip "${ARM_TTK_NAME}" -d "${ARM_TTK_DIRECTORY}" \
    && rm "${ARM_TTK_NAME}" \
    && ln -sTf "${ARM_TTK_PSD1}" /usr/bin/arm-ttk \
    && chmod a+x /usr/bin/arm-ttk

```

--------------------------------

### Using hatch environments

Source: https://megalinter.io/latest/contributing

Install hatch via pipx, enter the hatch shell, and run commands in specific environments like docs:serve or build:all.

```bash
# Install hatch (if not already installed)
pip install pipx && pipx install hatch

# Enter hatch shell
hatch shell

# Run commands in specific environments
hatch run docs:serve  # Run docs server
hatch run build:all   # Run build commands

```

--------------------------------

### Dockerfile instructions package list example

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example JSON array for the dockerfile descriptor property. Each item is a string representing a Dockerfile instruction that will be automatically integrated in the generated Dockerfile.

```json
[
    "ENV JAVA_HOME=/usr/lib/jvm/java-11-openjdk",
    "ENV PATH=\"$JAVA_HOME/bin:${PATH}\"
]

```

--------------------------------

### Linter configuration array example for JavaScript

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example of a configuration array for JavaScript linters, showing entries for eslint and standard. Each entry includes CLI extra args, config file name, examples, install commands, and linter metadata.

```json
[
    {
        "cli_config_extra_args": [
            "--no-eslintrc",
            "--no-ignore"
        ],
        "config_file_name": ".eslintrc.yml",
        "examples": [
            "eslint myfile.js",
            "eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js"
        ],
        "install": {
            "npm": [
                "eslint",
                "eslint-config-airbnb",
                "eslint-config-prettier",
                "eslint-plugin-jest",
                "eslint-plugin-prettier",
                "@babel/eslint-parser"
            ]
        },
        "linter_banner_image_url": "https://d33wubrfki0l68.cloudfront.net/3b5ac7586466159bb6f237b633bfc4f5a8d5acf8/ee0a1/assets/img/posts/eslint-collective.png",
        "linter_name": "eslint",
        "linter_url": "https://eslint.org",
        "name": "JAVASCRIPT_ES"
    },
    {
        "examples": [
            "standard myfile.js"
        ],
        "install": {
            "npm": [
                "standard"
            ]
        },
        "linter_banner_image_url": "https://github.com/standard/standard/raw/master/sticker.png",
        "linter_name": "standard",
        "linter_url": "https://github.com/standard/standard",
        "name": "JAVASCRIPT_STANDARD"
    }
]
```

--------------------------------

### examples field with golangci-lint commands

Source: https://megalinter.io/latest/json-schemas/descriptor.html

Example array for the examples field, showing CLI commands with and without a configuration file. These commands appear in documentation.

```json
[
    "golangci-lint run myfile.go",
    "golangci-lint run -c .golangci.yml myfile.go"
]
```

--------------------------------

### Dockerfile installation commands for PHPStan

Source: https://megalinter.io/latest/descriptors/php_phpstan

Dockerfile commands to install PHPStan and related packages in the MegaLinter Docker image, including parent descriptor setup and composer global require.

```dockerfile
# Parent descriptor install
RUN update-alternatives --install /usr/bin/php php /usr/bin/php84 110
COPY --link --from=composer/composer:2-bin /composer /usr/bin/composer
ENV COMPOSER_HOME=/usr/local/composer
ENV PATH="/usr/local/composer/vendor/bin:${PATH}"
# Linter install
# renovate: datasource=packagist depName=phpstan/phpstan
ARG PHP_PHPSTAN_PHPSTAN_VERSION=2.2.9
# renovate: datasource=packagist depName=phpstan/extension-installer
ARG PHP_PHPSTAN_EXTENSION_INSTALLER_VERSION=1.4.3
# renovate: datasource=packagist depName=bartlett/sarif-php-converters
ARG PHP_BARTLETT_SARIF_PHP_CONVERTERS_VERSION=1.6.0
RUN GITHUB_AUTH_TOKEN="$(cat /run/secrets/GITHUB_TOKEN)" && export GITHUB_AUTH_TOKEN && composer config --global allow-plugins.phpstan/extension-installer true && composer global require phpstan/phpstan:${PHP_PHPSTAN_PHPSTAN_VERSION} phpstan/extension-installer:${PHP_PHPSTAN_EXTENSION_INSTALLER_VERSION} bartlett/sarif-php-converters:${PHP_BARTLETT_SARIF_PHP_CONVERTERS_VERSION}

```

--------------------------------

### Dockerfile commands for installing dartanalyzer on MegaLinter image

Source: https://megalinter.io/latest/descriptors/dart_dartanalyzer

Dockerfile commands to install glibc and the Dart SDK on the MegaLinter Docker image, including environment setup and PATH configuration.

```dockerfile
# Parent descriptor install
# renovate: datasource=github-tags depName=sgerrand/alpine-pkg-glibc
ARG ALPINE_GLIBC_PACKAGE_VERSION=2.34-r0
ENV LANG=C.UTF-8
RUN ALPINE_GLIBC_BASE_URL="https://github.com/sgerrand/alpine-pkg-glibc/releases/download" && \
    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
ARG TARGETPLATFORM
# renovate: datasource=dart-version depName=dart
ARG DART_VERSION='3.12.2'
RUN case ${TARGETPLATFORM} in \
  "linux/amd64")  DART_ARCH=x64   ;; \
  "linux/arm64")  DART_ARCH=arm64 ;; \
esac \
    && DART_URL="https://storage.googleapis.com/dart-archive/channels/stable/release/${DART_VERSION}/sdk/dartsdk-linux-${DART_ARCH}-release.zip" \
    && for attempt in 1 2 3 4 5; do \
         echo "Downloading Dart SDK (attempt ${attempt}/5)" \
         && wget --tries=5 -T 60 -q -O /tmp/dart-sdk.zip "${DART_URL}" \
         && unzip -tq /tmp/dart-sdk.zip > /dev/null 2>&1 \
         && break; \
         echo "Dart SDK download/verify failed (attempt ${attempt}/5), retrying in 15s" \
         && rm -f /tmp/dart-sdk.zip \
         && sleep 15; \
       done \
    && unzip -q /tmp/dart-sdk.zip -d /tmp \
    && mkdir -p /usr/lib/dart \
    && mv /tmp/dart-sdk/* /usr/lib/dart/ \
    && chmod +x /usr/lib/dart/bin/dart \
    && chmod +x /usr/lib/dart/bin/dartaotruntime \
    && rm -rf /tmp/dart-sdk /tmp/dart-sdk.zip

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

```

--------------------------------

### revive basic usage example

Source: https://megalinter.io/latest/descriptors/go_revive

Shows the basic command to run revive on a single Go file.

```bash
revive myfile.go

```
Tokens:
Raw