7.5.0 • Published 6 months ago

mega-linter-runner v7.5.0

Weekly downloads
561
License
MIT
Repository
github
Last release
6 months ago

Mega-Linter Runner

Version Docker Pulls Mega-Linter codecov PRs Welcome

Mega-Linter 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 Mega-Linter Online Documentation Web Site

Mega-Linter client

This package allows to run Mega-Linter 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

Installation

Pre-requisites

You need to have NodeJS and Docker installed on your computer to run Mega-Linter locally with Mega-Linter Runner

Global installation

npm install mega-linter-runner -g

Local installation

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

Usage

mega-linter-runner [OPTIONS]

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

OptionDescription
-p --pathDirectory containing the files to lint (default: current directory)
-e --envEnvironment variables for Mega-Linter, following format 'ENV_VAR_NAME=VALUE' (Warning: Quotes are mandatory)
--fixAutomatically apply formatting and fixes in your files
-r --releaseAllows to override Mega-Linter version used (default: v4 stable)
-h --helpShow mega-linter-runner help
-v --versionShow mega-linter-runner version

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

Examples

mega-linter-runner
mega-linter-runner -p myFolder --fix
mega-linter-runner -r insiders -e 'ENABLE=MARKDOWN,YAML' -e 'SHOW_ELAPSED_TIME=true'

Configuration

Default configuration is ready out of the box

You can define a .mega-linter.yml configuration file at the root of your repository to customize or deactivate the included linters

Linters

Languages

Language / FormatLinterConfiguration keyFix
BASHbash-execBASH_EXEC
shellcheckBASH_SHELLCHECK
shfmtBASH_SHFMT:heavy_check_mark:
CcpplintC_CPPLINT
CLOJUREclj-kondoCLOJURE_CLJ_KONDO
COFFEEcoffeelintCOFFEE_COFFEELINT
C++ (CPP)cpplintCPP_CPPLINT
C# (CSHARP)dotnet-formatCSHARP_DOTNET_FORMAT:heavy_check_mark:
DARTdartanalyzerDART_DARTANALYZER
GOgolangci-lintGO_GOLANGCI_LINT
GROOVYnpm-groovy-lintGROOVY_NPM_GROOVY_LINT:heavy_check_mark:
JAVAcheckstyleJAVA_CHECKSTYLE
JAVASCRIPTeslintJAVASCRIPT_ES:heavy_check_mark:
standardJAVASCRIPT_STANDARD:heavy_check_mark:
JSXeslintJSX_ESLINT:heavy_check_mark:
KOTLINktlintKOTLIN_KTLINT:heavy_check_mark:
LUAluacheckLUA_LUACHECK
PERLperlcriticPERL_PERLCRITIC
PHPphpPHP_BUILTIN
phpcsPHP_PHPCS
phpstanPHP_PHPSTAN
psalmPHP_PSALM
POWERSHELLpowershellPOWERSHELL_POWERSHELL
PYTHONpylintPYTHON_PYLINT
blackPYTHON_BLACK:heavy_check_mark:
flake8PYTHON_FLAKE8
isortPYTHON_ISORT:heavy_check_mark:
RlintrR_LINTR
RAKUrakuRAKU_RAKU
RUBYrubocopRUBY_RUBOCOP:heavy_check_mark:
RUSTclippyRUST_CLIPPY
SCALAscalafixSCALA_SCALAFIX
SQLsql-lintSQL_SQL_LINT
TSXeslintTSX_ESLINT:heavy_check_mark:
TYPESCRIPTeslintTYPESCRIPT_ES:heavy_check_mark:
standardTYPESCRIPT_STANDARD:heavy_check_mark:
Visual Basic .NET (VBDOTNET)dotnet-formatVBDOTNET_DOTNET_FORMAT:heavy_check_mark:

Formats

Language / FormatLinterConfiguration keyFix
CSSstylelintCSS_STYLELINT:heavy_check_mark:
scss-lintCSS_SCSS_LINT
ENVdotenv-linterENV_DOTENV_LINTER:heavy_check_mark:
GRAPHQLgraphql-schema-linterGRAPHQL_GRAPHQL_SCHEMA_LINTER
HTMLhtmlhintHTML_HTMLHINT
JSONjsonlintJSON_JSONLINT
LATEXchktexLATEX_CHKTEX
MARKDOWNmarkdownlintMARKDOWN_MARKDOWNLINT:heavy_check_mark:
markdown-link-checkMARKDOWN_MARKDOWN_LINK_CHECK
PROTOBUFprotolintPROTOBUF_PROTOLINT:heavy_check_mark:
RSTrst-lintRST_RST_LINT
rstcheckRST_RSTCHECK
rstfmtRST_RSTFMT:heavy_check_mark:
XMLxmllintXML_XMLLINT
YAMLyamllintYAML_YAMLLINT

Tooling formats

Language / FormatLinterConfiguration keyFix
ANSIBLEansible-lintANSIBLE_ANSIBLE_LINT
ARMarm-ttkARM_ARM_TTK
CLOUDFORMATIONcfn-lintCLOUDFORMATION_CFN_LINT
DOCKERFILEdockerfilelintDOCKERFILE_DOCKERFILELINT
hadolintDOCKERFILE_HADOLINT
EDITORCONFIGeditorconfig-checkerEDITORCONFIG_EDITORCONFIG_CHECKER
GHERKINgherkin-lintGHERKIN_GHERKIN_LINT
KUBERNETESkubevalKUBERNETES_KUBEVAL
OPENAPIspectralOPENAPI_SPECTRAL
PUPPETpuppet-lintPUPPET_PUPPET_LINT:heavy_check_mark:
SNAKEMAKEsnakemakeSNAKEMAKE_LINT
snakefmtSNAKEMAKE_SNAKEFMT:heavy_check_mark:
TEKTONtekton-lintTEKTON_TEKTON_LINT
TERRAFORMtflintTERRAFORM_TFLINT
terrascanTERRAFORM_TERRASCAN
terragruntTERRAFORM_TERRAGRUNT

Other

Language / FormatLinterConfiguration keyFix
COPYPASTEjscpdCOPYPASTE_JSCPD
SPELLcspellSPELL_CSPELL
7.4.0

7 months ago

7.5.0

6 months ago

7.0.0

11 months ago

7.3.0

9 months ago

7.2.1

9 months ago

7.2.0

9 months ago

7.1.0

11 months ago

6.21.0

1 year ago

6.22.0

1 year ago

6.22.1

1 year ago

6.22.2

1 year ago

6.19.0

1 year ago

6.20.0

1 year ago

6.20.1

1 year ago

6.16.0

1 year ago

6.14.0

1 year ago

6.18.0

1 year ago

6.12.0

2 years ago

6.17.0

1 year ago

6.15.0

1 year ago

6.13.0

2 years ago

6.6.0

2 years ago

6.8.0

2 years ago

6.10.0

2 years ago

6.7.0

2 years ago

6.7.1

2 years ago

6.9.0

2 years ago

6.9.1

2 years ago

6.11.1

2 years ago

6.11.0

2 years ago

5.16.0

2 years ago

6.2.1

2 years ago

6.2.0

2 years ago

6.4.0

2 years ago

5.14.0

2 years ago

6.0.1

2 years ago

6.0.3

2 years ago

6.0.2

2 years ago

6.0.5

2 years ago

6.0.4

2 years ago

6.5.0

2 years ago

5.15.0

2 years ago

5.17.0

2 years ago

6.1.0

2 years ago

6.3.0

2 years ago

5.13.0

2 years ago

5.12.0

2 years ago

5.10.0

2 years ago

5.9.0

2 years ago

5.11.0

2 years ago

5.8.0

2 years ago

5.4.0

2 years ago

5.6.0

2 years ago

5.3.0

2 years ago

5.5.0

2 years ago

5.7.1

2 years ago

5.7.0

2 years ago

5.1.0

2 years ago

5.2.0

2 years ago

5.0.7

2 years ago

5.0.6

2 years ago

5.0.5

2 years ago

5.0.4

2 years ago

5.0.3

2 years ago

5.0.2

2 years ago

5.0.1

2 years ago

5.0.0

2 years ago

4.47.0

2 years ago

4.46.0

3 years ago

4.45.0

3 years ago

4.41.0

3 years ago

4.39.0

3 years ago

4.37.0

3 years ago

4.36.0

3 years ago

4.35.0

3 years ago

4.32.0

3 years ago

4.34.0

3 years ago

4.30.0

3 years ago

4.28.0

3 years ago

4.27.0

3 years ago

4.26.2

3 years ago

4.26.1

3 years ago

4.26.0

3 years ago

4.24.1

3 years ago

4.24.0

3 years ago

4.23.2

3 years ago

4.23.3

3 years ago

4.23.1

3 years ago

4.23.0

3 years ago

4.22.1

3 years ago

4.22.0

3 years ago

4.21.0

3 years ago

4.20.0

3 years ago

4.19.0

3 years ago

4.18.0

3 years ago

4.17.0

3 years ago

4.16.0

3 years ago

4.15.0

3 years ago

4.14.2

3 years ago

4.14.1

3 years ago

4.14.0

3 years ago

4.13.0

3 years ago

4.12.0

3 years ago

4.11.0

3 years ago

4.10.1

3 years ago

1.0.0

3 years ago