documentation MegaLinter Flavor

Description

MegaLinter for documentation projects

Usage

• GitHub Action: oxsecurity/megalinter/flavors/documentation@v6
• Docker image: oxsecurity/megalinter-documentation:v6
• mega-linter-runner: mega-linter-runner --flavor documentation

Embedded linters

Languages

	Language	Linter	Configuration key	Additional
	BASH	bash-exec	BASH_EXEC
		shellcheck	BASH_SHELLCHECK
		shfmt	BASH_SHFMT
	GROOVY	npm-groovy-lint	GROOVY_NPM_GROOVY_LINT
	KOTLIN	ktlint	KOTLIN_KTLINT
	SQL	sql-lint	SQL_SQL_LINT
		sqlfluff	SQL_SQLFLUFF

Formats

	Format	Linter	Configuration key	Additional
	CSS	stylelint	CSS_STYLELINT
		scss-lint	CSS_SCSS_LINT
	ENV	dotenv-linter	ENV_DOTENV_LINTER
	GRAPHQL	graphql-schema-linter	GRAPHQL_GRAPHQL_SCHEMA_LINTER
	HTML	htmlhint	HTML_HTMLHINT
	JSON	jsonlint	JSON_JSONLINT
		eslint-plugin-jsonc	JSON_ESLINT_PLUGIN_JSONC
		v8r	JSON_V8R
		prettier	JSON_PRETTIER
	MARKDOWN	markdownlint	MARKDOWN_MARKDOWNLINT
		markdown-link-check	MARKDOWN_MARKDOWN_LINK_CHECK
		markdown-table-formatter	MARKDOWN_MARKDOWN_TABLE_FORMATTER
	PROTOBUF	protolint	PROTOBUF_PROTOLINT
	XML	xmllint	XML_XMLLINT
	YAML	prettier	YAML_PRETTIER
		yamllint	YAML_YAMLLINT
		v8r	YAML_V8R

Tooling formats

	Tooling format	Linter	Configuration key	Additional
	ACTION	actionlint	ACTION_ACTIONLINT
	ANSIBLE	ansible-lint	ANSIBLE_ANSIBLE_LINT
	DOCKERFILE	hadolint	DOCKERFILE_HADOLINT
	EDITORCONFIG	editorconfig-checker	EDITORCONFIG_EDITORCONFIG_CHECKER
	KUBERNETES	kubeval	KUBERNETES_KUBEVAL
		kubeconform	KUBERNETES_KUBECONFORM
	OPENAPI	spectral	OPENAPI_SPECTRAL
	SNAKEMAKE	snakemake	SNAKEMAKE_LINT
	TEKTON	tekton-lint	TEKTON_TEKTON_LINT

Other

	Code quality checker	Linter	Configuration key	Additional
	COPYPASTE	jscpd	COPYPASTE_JSCPD
		git_diff	REPOSITORY_GIT_DIFF
		gitleaks	REPOSITORY_GITLEAKS
		goodcheck	REPOSITORY_GOODCHECK
		secretlint	REPOSITORY_SECRETLINT
		semgrep	REPOSITORY_SEMGREP
		trivy	REPOSITORY_TRIVY
	SPELL	misspell	SPELL_MISSPELL
		cspell	SPELL_CSPELL