5.6.1-beta202201300216.0 • Published 4 years ago

mega-linter-runner v5.6.1-beta202201300216.0

Weekly downloads
561
License
MIT
Repository
github
Last release
4 years ago

MegaLinter Runner

Version Downloads/week Downloads/total GitHub stars

Docker Pulls MegaLinter codecov Secured with Trivy GitHub Sponsors PRs Welcome Tweet

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'

Usage

mega-linter-runner [OPTIONS]

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

OptionDescriptionDefault
-p --pathDirectory containing the files to lintcurrent directory
--flavorSet this parameter to use a MegaLinter flavorall
-d --imageYou can override the used docker image, including if it is on another docker registry
-e --envEnvironment variables for MegaLinter, following format 'ENV_VAR_NAME=VALUE' Warning: Quotes are mandatory
--fixAutomatically apply formatting and fixes in your files
-r --releaseAllows to override MegaLinter version usedv5
-h --helpShow mega-linter-runner help
-v --versionShow mega-linter-runner version
-i --installGenerate MegaLinter configuration files

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 beta -e 'ENABLE=MARKDOWN,YAML' -e 'SHOW_ELAPSED_TIME=true'

Configuration

You can define 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

LanguageLinterConfiguration keyFormat/Fix
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
reviveGO_REVIVE
GROOVYnpm-groovy-lintGROOVY_NPM_GROOVY_LINT:heavy_check_mark:
JAVAcheckstyleJAVA_CHECKSTYLE
JAVASCRIPTeslintJAVASCRIPT_ES:heavy_check_mark:
standardJAVASCRIPT_STANDARD:heavy_check_mark:
prettierJAVASCRIPT_PRETTIER: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
phplintPHP_PHPLINT
POWERSHELLpowershellPOWERSHELL_POWERSHELL
PYTHONpylintPYTHON_PYLINT
blackPYTHON_BLACK:heavy_check_mark:
flake8PYTHON_FLAKE8
isortPYTHON_ISORT:heavy_check_mark:
banditPYTHON_BANDIT
mypyPYTHON_MYPY
RlintrR_LINTR
RAKUrakuRAKU_RAKU
RUBYrubocopRUBY_RUBOCOP:heavy_check_mark:
RUSTclippyRUST_CLIPPY
SALESFORCEsfdx-scanner-apexSALESFORCE_SFDX_SCANNER_APEX
sfdx-scanner-auraSALESFORCE_SFDX_SCANNER_AURA
sfdx-scanner-lwcSALESFORCE_SFDX_SCANNER_LWC
SCALAscalafixSCALA_SCALAFIX
SQLsql-lintSQL_SQL_LINT
sqlfluffSQL_SQLFLUFF
tsqllintSQL_TSQLLINT
SWIFTswiftlintSWIFT_SWIFTLINT:heavy_check_mark:
TSXeslintTSX_ESLINT:heavy_check_mark:
TYPESCRIPTeslintTYPESCRIPT_ES:heavy_check_mark:
standardTYPESCRIPT_STANDARD:heavy_check_mark:
prettierTYPESCRIPT_PRETTIER:heavy_check_mark:
Visual Basic .NET (VBDOTNET)dotnet-formatVBDOTNET_DOTNET_FORMAT:heavy_check_mark:

Formats

FormatLinterConfiguration keyFormat/Fix
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
eslint-plugin-jsoncJSON_ESLINT_PLUGIN_JSONC:heavy_check_mark:
v8rJSON_V8R
prettierJSON_PRETTIER:heavy_check_mark:
LATEXchktexLATEX_CHKTEX
MARKDOWNmarkdownlintMARKDOWN_MARKDOWNLINT:heavy_check_mark:
remark-lintMARKDOWN_REMARK_LINT:heavy_check_mark:
markdown-link-checkMARKDOWN_MARKDOWN_LINK_CHECK
markdown-table-formatterMARKDOWN_MARKDOWN_TABLE_FORMATTER:heavy_check_mark:
PROTOBUFprotolintPROTOBUF_PROTOLINT:heavy_check_mark:
RSTrst-lintRST_RST_LINT
rstcheckRST_RSTCHECK
rstfmtRST_RSTFMT:heavy_check_mark:
XMLxmllintXML_XMLLINT
YAMLprettierYAML_PRETTIER:heavy_check_mark:
yamllintYAML_YAMLLINT
v8rYAML_V8R

Tooling formats

Tooling formatLinterConfiguration keyFormat/Fix
ACTIONactionlintACTION_ACTIONLINT
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:heavy_check_mark:
terraform-fmtTERRAFORM_TERRAFORM_FMT:heavy_check_mark:
checkovTERRAFORM_CHECKOV
kicsTERRAFORM_KICS

Other

Code quality checkerLinterConfiguration keyFormat/Fix
COPYPASTEjscpdCOPYPASTE_JSCPD
CREDENTIALSsecretlintCREDENTIALS_SECRETLINT
GITgit_diffGIT_GIT_DIFF
SPELLmisspellSPELL_MISSPELL:heavy_check_mark:
cspellSPELL_CSPELL
8.2.0

1 year ago

8.4.1

12 months ago

8.4.0

12 months ago

8.4.2

12 months ago

8.3.0

1 year ago

8.1.0

1 year ago

7.8.0

2 years ago

7.13.0

2 years ago

7.12.0

2 years ago

7.7.0

2 years ago

7.11.1

2 years ago

7.11.0

2 years ago

7.6.0

2 years ago

8.0.0

1 year ago

7.10.0

2 years ago

7.9.0

2 years ago

7.4.0

2 years ago

7.5.0

2 years ago

7.0.0

3 years ago

7.3.0

2 years ago

7.2.1

2 years ago

7.2.0

2 years ago

7.1.0

3 years ago

6.21.0

3 years ago

6.22.0

3 years ago

6.22.1

3 years ago

6.22.2

3 years ago

6.19.0

3 years ago

6.20.0

3 years ago

6.20.1

3 years ago

6.16.0

3 years ago

6.14.0

3 years ago

6.18.0

3 years ago

6.12.0

3 years ago

6.17.0

3 years ago

6.15.0

3 years ago

6.13.0

3 years ago

6.6.0

3 years ago

6.8.0

3 years ago

6.10.0

3 years ago

6.7.0

3 years ago

6.7.1

3 years ago

6.9.0

3 years ago

6.9.1

3 years ago

6.11.1

3 years ago

6.11.0

3 years ago

5.16.0

4 years ago

6.2.1

3 years ago

6.2.0

3 years ago

6.4.0

3 years ago

5.14.0

4 years ago

6.0.1

4 years ago

6.0.3

4 years ago

6.0.2

4 years ago

6.0.5

4 years ago

6.0.4

4 years ago

6.5.0

3 years ago

5.15.0

4 years ago

5.17.0

4 years ago

6.1.0

3 years ago

6.3.0

3 years ago

5.13.0

4 years ago

5.12.0

4 years ago

5.10.0

4 years ago

5.9.0

4 years ago

5.11.0

4 years ago

5.8.0

4 years ago

5.4.0

4 years ago

5.6.0

4 years ago

5.3.0

4 years ago

5.5.0

4 years ago

5.7.1

4 years ago

5.7.0

4 years ago

5.1.0

4 years ago

5.2.0

4 years ago

5.0.7

4 years ago

5.0.6

4 years ago

5.0.5

4 years ago

5.0.4

4 years ago

5.0.3

4 years ago

5.0.2

4 years ago

5.0.1

4 years ago

5.0.0

4 years ago

4.47.0

4 years ago

4.46.0

4 years ago

4.45.0

4 years ago

4.41.0

4 years ago

4.39.0

5 years ago

4.37.0

5 years ago

4.36.0

5 years ago

4.35.0

5 years ago

4.32.0

5 years ago

4.34.0

5 years ago

4.30.0

5 years ago

4.28.0

5 years ago

4.27.0

5 years ago

4.26.2

5 years ago

4.26.1

5 years ago

4.26.0

5 years ago

4.24.1

5 years ago

4.24.0

5 years ago

4.23.2

5 years ago

4.23.3

5 years ago

4.23.1

5 years ago

4.23.0

5 years ago

4.22.1

5 years ago

4.22.0

5 years ago

4.21.0

5 years ago

4.20.0

5 years ago

4.19.0

5 years ago

4.18.0

5 years ago

4.17.0

5 years ago

4.16.0

5 years ago

4.15.0

5 years ago

4.14.2

5 years ago

4.14.1

5 years ago

4.14.0

5 years ago

4.13.0

5 years ago

4.12.0

5 years ago

4.11.0

5 years ago

4.10.1

5 years ago

1.0.0

5 years ago