dotenv-linter

dotenv-linter documentation

• Version in Mega-Linter: 3.1.1
• Visit Official Web Site
• See Index of problems detected by dotenv-linter

Configuration in Mega-Linter

• Enable dotenv-linter by adding ENV_DOTENV_LINTER in ENABLE_LINTERS variable
• Disable dotenv-linter by adding ENV_DOTENV_LINTER in DISABLE_LINTERS variable

• Enable auto-fixes by adding ENV_DOTENV_LINTER in APPLY_FIXES variable

Variable	Description	Default value
ENV_DOTENV_LINTER_ARGUMENTS	User custom arguments to add in linter CLI call Ex: -s --foo "bar"
ENV_DOTENV_LINTER_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: (src\|lib)	Include every file
ENV_DOTENV_LINTER_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: (test\|examples)	Exclude no file
ENV_DOTENV_LINTER_CLI_LINT_MODE	Override default CLI lint mode - file: Calls the linter for each file - list_of_files: Call the linter with the list of files as argument - project: Call the linter from the root of the project	{linter.cli_lint_mode}
ENV_DOTENV_LINTER_FILE_EXTENSIONS	Allowed file extensions. "*" matches any extension, "" matches empty extension. Empty list excludes all files Ex: [".py", ""]	[".env"]
ENV_DOTENV_LINTER_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: ["Dockerfile(-.+)?", "Jenkinsfile"]	Include every file
ENV_DOTENV_LINTER_PRE_COMMANDS	List of bash commands to run before the linter	None
ENV_DOTENV_LINTER_POST_COMMANDS	List of bash commands to run after the linter	None
ENV_DOTENV_LINTER_DISABLE_ERRORS	Run linter but consider errors as warnings	false
ENV_DOTENV_LINTER_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	0

Mega-Linter Flavours

This linter is available in the following flavours

	Flavor	Description	Embedded linters	Info
	all	Default Mega-Linter Flavor	94
	ci_light	Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML	13
	dart	Optimized for DART based projects	41
	documentation	Mega-Linter for documentation projects	40
	dotnet	Optimized for C, C++, C# or VB based projects	47
	go	Optimized for GO based projects	42
	java	Optimized for JAVA based projects	42
	javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	49
	php	Optimized for PHP based projects	44
	python	Optimized for PYTHON based projects	49
	ruby	Optimized for RUBY based projects	41
	rust	Optimized for RUST based projects	41
	salesforce	Optimized for Salesforce based projects	43
	scala	Optimized for SCALA based projects	41
	swift	Optimized for SWIFT based projects	41
	terraform	Optimized for TERRAFORM based projects	45

Behind the scenes

How are identified applicable files

• File extensions: .env

How the linting is performed

• dotenv-linter is called one time by identified file

Example calls

dotenv-linter myfile.env

dotenv-linter fix myfile.env

Help content

dotenv-linter 3.1.1
Mikhail Grachev <work@mgrachev.com>
Lightning-fast linter for .env files

USAGE:
    dotenv-linter [FLAGS] [OPTIONS] <input>... [SUBCOMMAND]

FLAGS:
    -h, --help         Prints help information
        --no-color     Turns off the colored output
    -q, --quiet        Doesn't display additional information
    -r, --recursive    Recursively searches and checks .env files
    -v, --version      Prints version information

OPTIONS:
    -e, --exclude <FILE_NAME>...    Excludes files from check
    -s, --skip <CHECK_NAME>...      Skips checks

ARGS:
    <input>...    files or paths [default: /]

SUBCOMMANDS:
    compare    Compares if files have the same keys [aliases: c]
    fix        Automatically fixes warnings [aliases: f]
    list       Shows list of available checks [aliases: l]

Installation on mega-linter Docker image

• Dockerfile commands :

RUN wget -q -O - https://raw.githubusercontent.com/dotenv-linter/dotenv-linter/master/install.sh | sh -s

Example success log

Results of dotenv-linter linter (version 2.2.1)
See documentation on https://megalinter.github.io/descriptors/env_dotenv_linter/
-----------------------------------------------

[SUCCESS] .automation/test/env/env_good_1.env

Example error log

Results of dotenv-linter linter (version 2.2.1)
See documentation on https://megalinter.github.io/descriptors/env_dotenv_linter/
-----------------------------------------------

[ERROR] .automation/test/env/env_bad_1.env
    .automation/test/env/env_bad_1.env:1 LeadingCharacter: Invalid leading character detected
    .automation/test/env/env_bad_1.env:2 KeyWithoutValue: The MY_ENV key should be with a value or have an equal sign
    .automation/test/env/env_bad_1.env:3 IncorrectDelimiter: The DB-NAME key has incorrect delimiter
    .automation/test/env/env_bad_1.env:3 UnorderedKey: The DB-NAME key should go before the LOGGER_LEVEL key
    .automation/test/env/env_bad_1.env:4 LowercaseKey: The DEbUG_hTTP key should be in uppercase
    .automation/test/env/env_bad_1.env:4 UnorderedKey: The DEbUG_hTTP key should go before the LOGGER_LEVEL key
    .automation/test/env/env_bad_1.env:5 UnorderedKey: The DB_NAME key should go before the DEbUG_hTTP key

    Found 7 problems