mega-linter-runner

v9.4.0

Published

3 days ago

Local runner for MegaLinter

MegaLinter Runner

MegaLinter analyzes 37 languages, 15 formats, 16 tooling formats , copy-pastes and spell in your repository sources, generate reports in several formats, and can even apply formatting and auto-fixes with auto-generated commit or PR, to ensure all your projects are clean, whatever IDE/toolbox are used by their developers !

See MegaLinter Online Documentation Web Site

This package allows to run MegaLinter locally before running it in your CD/CI workflow, or simply to locally apply reformatting and fixes without having to install up to date linters for your files

Screenshot

Installation

Pre-requisites

You need to have NodeJS and Docker installed on your computer to run MegaLinter locally with MegaLinter Runner

Global installation

npm install mega-linter-runner -g

Local installation

npm install mega-linter-runner --save-dev

No installation

You can run mega-linter-runner without installation by using npx

Example:

npx mega-linter-runner -r beta -e "'ENABLE=MARKDOWN,YAML'" -e 'SHOW_ELAPSED_TIME=true'

Pre-commit hook

You can run mega-linter-runner as a pre-commit hook

Sample .pre-commit-config.yaml:

repos:
  - repo: https://github.com/oxsecurity/megalinter
    rev: v6.8.0 # Git tag specifying the hook, not mega-linter-runner, version
    hooks:
      - id: megalinter-incremental # Faster, less thorough
        stages:
          - commit
      - id: megalinter-full # Slower, more thorough
        stages:
          - push

See .pre-commit-hooks.yaml for more details.

Usage

mega-linter-runner [OPTIONS] [FILES]

The options are only related to mega-linter-runner. For MegaLinter options, please use a .mega-linter.yml configuration file

| Option | Description | Default | |---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| | -p --path | Directory containing the files to lint | current directory | | -f --flavor | Set this parameter to use a MegaLinter flavor | all | | -d --image | You can override the used docker image, including if it's on another docker registry | | | -e --env | Environment variables for MegaLinter, following format 'ENV_VAR_NAME=VALUE' for a single value or "'ENV_VAR_NAME=VALUE1,VALUE2'" for a list of valuesWarning: Quotes are mandatory | | | --fix | Automatically apply formatting and fixes in your files | | | -r --release | Allows to override MegaLinter version used | v5 | | -h --help | Show mega-linter-runner help | | | -v --version | Show mega-linter-runner version | | | --container-engine | Allows to specify a docker engine (docker or podman) | docker | | --container-name | Specify MegaLinter container name | | | --remove-container | Remove MegaLinter Docker container when done | | | -i --install | Generate MegaLinter local configuration files and CI/CD workflows | | | -i --upgrade | Upgrade your MegaLinter configuration files to use the latest version | | | --custom-flavor-setup | Initialize a new repository to generate a custom flavor | | | --custom-flavor-linters | Comma-separated list of linter keys if using --custom-flavor-setup | |

You can also use npx mega-linter-runner if you do not want to install the package

Examples

# Run with all defaults
mega-linter-runner

# Scan a folder and apply fixes
mega-linter-runner -p myFolder --fix

# Send environment variables
mega-linter-runner -r beta -e "'ENABLE=MARKDOWN,YAML'" -e 'SHOW_ELAPSED_TIME=true'

# Use python flavor beta version, only on some files
mega-linter-runner --flavor python --release beta --filesonly path/to/my/file1.py another/path/to/a/file.js and/another/file.py

# Use Podman as engine
mega-linter-runner --flavor documentation --container-engine podman

Configuration

You can generate a ready-to-use .mega-linter.yml configuration file by running npx mega-linter-runner --install at the root of your repository

Runner Install

Linters

Languages