dotenv-linter
dotenv-linter documentation
- Version in MegaLinter: 3.3.0
- Visit Official Web Site
- See Index of problems detected by dotenv-linter
Configuration in MegaLinter
- 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 autofixes 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_COMMAND_REMOVE_ARGUMENTS | User custom arguments to remove from command line before calling the linter 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- 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 filesEx: [".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_UNSECURED_ENV_VARIABLES | List of env variables explicitly not filtered before calling ENV_DOTENV_LINTER and its pre/post commands | 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 |
ENV_DOTENV_LINTER_CLI_EXECUTABLE | Override CLI executable | ['dotenv-linter'] |
MegaLinter Flavours
This linter is available in the following flavours
Flavor | Description | Embedded linters | Info | |
---|---|---|---|---|
![]() |
all | Default MegaLinter Flavor | 118 | |
c_cpp | Optimized for pure C/C++ projects | 53 | ||
ci_light | Optimized for CI items (Dockerfile, Jenkinsfile, JSON/YAML schemas,XML | 22 | ||
cupcake | MegaLinter for the most commonly used languages | 85 | ||
documentation | MegaLinter for documentation projects | 51 | ||
dotnet | Optimized for C, C++, C# or VB based projects | 63 | ||
dotnetweb | Optimized for C, C++, C# or VB based projects with JS/TS | 72 | ||
go | Optimized for GO based projects | 53 | ||
java | Optimized for JAVA based projects | 55 | ||
javascript | Optimized for JAVASCRIPT or TYPESCRIPT based projects | 60 | ||
php | Optimized for PHP based projects | 54 | ||
python | Optimized for PYTHON based projects | 62 | ||
ruby | Optimized for RUBY based projects | 51 | ||
rust | Optimized for RUST based projects | 51 | ||
salesforce | Optimized for Salesforce based projects | 55 | ||
swift | Optimized for SWIFT based projects | 51 | ||
terraform | Optimized for TERRAFORM based projects | 55 |
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 (
file
CLI lint mode)
Example calls
dotenv-linter myfile.env
dotenv-linter fix myfile.env
Help content
dotenv-linter 3.3.0
Mikhail Grachev <work@mgrachev.com>
Lightning-fast linter for .env files
USAGE:
dotenv-linter [OPTIONS] [input]... [SUBCOMMAND]
ARGS:
<input>... files or paths [default: /]
OPTIONS:
-e, --exclude <FILE_NAME>... Excludes files from check
-h, --help Print 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
-s, --skip <CHECK_NAME>... Skips checks
-v, --version Print version information
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