Skip to content

dotenv-linter

dotenv-linter documentation

dotenv-linter - GitHub

Configuration in MegaLinter

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
file
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

MegaLinter Flavours

This linter is available in the following flavours

Flavor Description Embedded linters Info
all Default MegaLinter Flavor 97 Docker Image Size (tag) Docker Pulls
ci_light Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML 16 Docker Image Size (tag) Docker Pulls
dart Optimized for DART based projects 42 Docker Image Size (tag) Docker Pulls
documentation MegaLinter for documentation projects 41 Docker Image Size (tag) Docker Pulls
dotnet Optimized for C, C++, C# or VB based projects 49 Docker Image Size (tag) Docker Pulls
go Optimized for GO based projects 43 Docker Image Size (tag) Docker Pulls
java Optimized for JAVA based projects 43 Docker Image Size (tag) Docker Pulls
javascript Optimized for JAVASCRIPT or TYPESCRIPT based projects 50 Docker Image Size (tag) Docker Pulls
php Optimized for PHP based projects 46 Docker Image Size (tag) Docker Pulls
python Optimized for PYTHON based projects 49 Docker Image Size (tag) Docker Pulls
ruby Optimized for RUBY based projects 42 Docker Image Size (tag) Docker Pulls
rust Optimized for RUST based projects 42 Docker Image Size (tag) Docker Pulls
salesforce Optimized for Salesforce based projects 44 Docker Image Size (tag) Docker Pulls
scala Optimized for SCALA based projects 42 Docker Image Size (tag) Docker Pulls
swift Optimized for SWIFT based projects 42 Docker Image Size (tag) Docker Pulls
terraform Optimized for TERRAFORM based projects 47 Docker Image Size (tag) Docker Pulls

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.2.0
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
        --not-check-updates    Doesn't check for updates
    -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