✌️dotenv-linter

Linter for .env files. Written in Rust 🦀

👨‍💻 Installation

Binary

```shell script

Linux

$ curl https://github.com/mgrachev/dotenv-linter/releases/download/v1.1.0/dotenv-linter-v1.1.0-linux-x86_64.tar.gz -sSfL | tar -xzf -

Alpine Linux

$ wget https://github.com/mgrachev/dotenv-linter/releases/download/v1.1.0/dotenv-linter-v1.1.0-alpine-x86_64.tar.gz -O - -q | tar -xzf -

macOS

$ curl https://github.com/mgrachev/dotenv-linter/releases/download/v1.1.0/dotenv-linter-v1.1.0-darwin-x86_64.tar.gz -sSfL | tar -xzf - ```

GitHub Action

Use action-dotenv-linter to run dotenv-linter:

```yml

.github/workflows/dotenv_linter.yml

name: reviewdog on: [pullrequest] 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: githubtoken: ${{ secrets.github_token }} ```

Docker

shell script $ docker run --rm -v `pwd`:/app -w /app mgrachev/dotenv-linter

Cargo

shell script $ cargo install dotenv-linter

🚀 Usage

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 --include .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 --exclude .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

✅ Checks

Duplicated Keys

Detects if a key is not unique:

```env ❌Wrong FOO=BAR FOO=BAR

✅Correct FOO=BAR BAR=FOO ```

Incorrect delimiter

Detects if a key does not use an underscore to separate words: ```env ❌Wrong FOO-BAR=FOOBAR

✅Correct FOO_BAR=FOOBAR ```

Keys without values

Detects if a line has a key without a value: ```env ❌Wrong FOO

✅Correct FOO=

✅Correct FOO=BAR ```

Leading character

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

Lowercase key

Detects if a key has lowercase characters:

```env ❌Wrong FOo_BAR=FOOBAR

❌Wrong foo_bar=FOOBAR

✅Correct FOO_BAR=FOOBAR ```

Spaces around equal sign

Detects lines with a whitespace around equal sign character =:

```env ❌Wrong FOO =BAR

❌Wrong FOO= BAR

❌Wrong FOO = BAR

✅Correct FOO=BAR ```

Unordered Keys

Detects if a key is not alphabetically ordered:

```env ❌Wrong FOO=BAR BAR=FOO

✅Correct BAR=FOO FOO=BAR ```

📋 Roadmap

[x] Add more checks:
- [x] Duplicated keys;
- [x] Incorrect delimiter;
- [x] Keys without values;
- [x] Leading character;
- [x] Lowercase keys;
- [x] Spaces around equal sign;
- [x] Unordered keys;
[x] Support reviewdog;
[x] Create a GitHub Action for easily using dotenv-linter.