Linter for .env files. Written in Rust 🦀
```shell script
$ curl https://github.com/mgrachev/dotenv-linter/releases/download/v1.1.2/dotenv-linter-linux-x86_64.tar.gz -sSfL | tar -xzf -
$ wget https://github.com/mgrachev/dotenv-linter/releases/download/v1.1.2/dotenv-linter-alpine-x86_64.tar.gz -O - -q | tar -xzf -
$ curl https://github.com/mgrachev/dotenv-linter/releases/download/v1.1.2/dotenv-linter-darwin-x86_64.tar.gz -sSfL | tar -xzf - ```
shell script
$ brew install mgrachev/tap/dotenv-linter
```shell script
$ trizen -S dotenv-linter-bin # for the binary distribution $ trizen -S dotenv-linter-git # for the current master branch ```
shell script
$ docker run --rm -v `pwd`:/app -w /app mgrachev/dotenv-linter
If you are a Rust programmer, you can install dotenv-linter via cargo:
shell script
$ cargo install dotenv-linter
Example:
.github/workflows/dotenv_linter.yml
yaml
name: dotenv-linter
on: [pull_request]
jobs:
dotenv-linter:
name: runner / dotenv-linter
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v1
- name: dotenv-linter
uses: mgrachev/action-dotenv-linter@v1
with:
github_token: ${{ secrets.github_token }}
In the example above, action-dotenv-linter is used to run dotenv-linter.
Example:
.circleci/config.yml
yaml
version: 2.1
jobs:
dotenv-linter:
docker:
- image: circleci/rust:latest
steps:
- checkout
- run:
name: Run dotenv-linter
command: |
DOTENV_LINTER_VERSION=v1.1.2
wget https://github.com/mgrachev/dotenv-linter/releases/download/$DOTENV_LINTER_VERSION/dotenv-linter-alpine-x86_64.tar.gz \
-O - -q | tar -xzf -
./dotenv-linter
By default, dotenv-linter checks all files that start and end with .env. For example: .env, test.env, .env.qa:
shell script
$ dotenv-linter
.env:1 Invalid leading character detected
.env:2 The FOO-BAR key has incorrect delimiter
.env:3 The FOo_BAR key should be in uppercase
.env:4 The line has spaces around equal sign
test.env:5 The foo_bar key should be in uppercase
test.env:6 The FOO key should be with a value or have an equal sign
If you want to include a file with a specific name to check,
you can use the argument --include FILE_NAME or its short version -i FILE_NAME:
shell script
$ dotenv-linter -i test.dotenv .my-env-file
.env:1 Invalid leading character detected
test.dotenv:2 The FOO-BAR key has incorrect delimiter
.my-env-file:3 The line has spaces around equal sign
If you want to exclude a file with a specific name from check,
you can use the argument --exclude FILE_NAME or its short version -e FILE_NAME:
shell script
$ dotenv-linter -e .env .env.test
If you want to specify the directory where to run dotenv-linter,
you can use the argument --path DIRECTORY_PATH or its short version -p DIRECTORY_PATH:
shell script
$ dotenv-linter -p /directory/where/to/run
Detects if a key is not unique:
```env ❌Wrong FOO=BAR FOO=BAR
✅Correct FOO=BAR BAR=FOO ```
Detects if a key does not use an underscore to separate words: ```env ❌Wrong FOO-BAR=FOOBAR
✅Correct FOO_BAR=FOOBAR ```
Detects if a line has a key without a value: ```env ❌Wrong FOO
✅Correct FOO=
✅Correct FOO=BAR ```
Detects if a line starts with an unallowed character (characters from A to Z and _ (underscore) are allowed):
```env ❌Wrong FOO=BAR
❌Wrong .FOO=BAR
❌Wrong *FOO=BAR
❌Wrong 1FOO=BAR
✅Correct FOO=BAR
✅Correct _FOO=BAR ```
Detects if a key has lowercase characters:
```env ❌Wrong FOo_BAR=FOOBAR
❌Wrong foo_bar=FOOBAR
✅Correct FOO_BAR=FOOBAR ```
Detects lines with a whitespace around equal sign character =:
```env ❌Wrong FOO =BAR
❌Wrong FOO= BAR
❌Wrong FOO = BAR
✅Correct FOO=BAR ```
Detects if a key is not alphabetically ordered:
```env ❌Wrong FOO=BAR BAR=FOO
✅Correct BAR=FOO FOO=BAR ```
dotenv-linter.If you've ever wanted to contribute to open source, now you have a great opportunity:
This project exists thanks to all the people who contribute. [Contribute].
