⚡️Lightning-fast linter for .env files. Written in Rust 🦀

It checks .env files for problems that may cause the application to malfunction:

    ✅ Duplicated Key
    ✅ Ending Blank Line
    ✅ Extra Blank Line
    ✅ Incorrect delimiter
    ✅ Key without value
    ✅ Leading character
    ✅ Lowercase key
    ✅ Quote character
    ✅ Space character
    ✅ Trailing whitespace
    ✅ Unordered Key

The key features:

    ⚡️ Lightning-fast because it is written in Rust 🦀
    💣 Can be used on any project regardless of the programming language 💥
    🚀 Can be integrated with reviewdog and other CI services (including GitHub Actions) 🔥

Articles about dotenv-linter: * In English * In Russian

Dotenv-linter is created & supported by Evrone. What else we develop with Rust.

👨‍💻 Installation

Binary

```shell script

Linux / macOS / Windows (MINGW and etc). Installs it into ./bin/ by default.

$ curl -sSfL https://raw.githubusercontent.com/dotenv-linter/dotenv-linter/master/install.sh | sh -s

Specify installation directory and version.

$ curl -sSfL https://raw.githubusercontent.com/dotenv-linter/dotenv-linter/master/install.sh | sh -s -- -b usr/local/bin v2.0.0

Alpine Linux (wget)

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

Homebrew / Linuxbrew

shell script $ brew install dotenv-linter/tap/dotenv-linter

Arch Linux / AUR

```shell script

use your favourite AUR-helper

$ trizen -S dotenv-linter-bin # for the binary distribution $ trizen -S dotenv-linter-git # for the current master branch ```

Windows / Scoop

```shell script $ scoop bucket add dotenv-linter https://github.com/dotenv-linter/scoop.git $ scoop install dotenv-linter/dotenv-linter ````

Docker

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

Cargo

If you are a Rust programmer, you can install dotenv-linter via cargo:

shell script $ cargo install dotenv-linter

GitHub Action

CircleCI

🚀 Usage

By default, dotenv-linter checks all .env files in the current directory:

shell script $ dotenv-linter .env:2 DuplicatedKey: The FOO key is duplicated .env:3 UnorderedKey: The BAR key should go before the FOO key .env.test:1 LeadingCharacter: Invalid leading character detected

To check another directory, just pass its path as an argument. The same approach works if you need to check any files individually:

shell script $ dotenv-linter dir1 dir2/.my-env-file dir1/.env:1 LeadingCharacter: Invalid leading character detected dir1/.env:3 IncorrectDelimiter: The FOO-BAR key has incorrect delimiter dir2/.my-env-file:1 LowercaseKey: The bar key should be in uppercase

If you need to exclude a file or directory from check, you can use the argument --exclude PATH or its short version -e PATH:

shell script $ dotenv-linter --exclude .env.test .env:2 DuplicatedKey: The FOO key is duplicated .env:3 UnorderedKey: The BAR key should go before the FOO key

If you need a recursive .env file search inside directories, you can use the flag --recursive or its short version -r:

shell script $ dotenv-linter --recursive dir1/.env:2 DuplicatedKey: The FOO key is duplicated dir2/subdir/.env:3 IncorrectDelimiter: The FOO-BAR key has incorrect delimiter

If you need to skip some checks, you can use the argument --skip CHECK_NAME or its short version -s CHECK_NAME:

shell script $ dotenv-linter --skip UnorderedKey EndingBlankLine .env:2 DuplicatedKey: The FOO key is duplicated

If you need to view all available checks, you can use the flag --show-checks:

shell script $ dotenv-linter --show-checks DuplicatedKey EndingBlankLine ExtraBlankLine IncorrectDelimiter KeyWithoutValue LeadingCharacter LowercaseKey QuoteCharacter SpaceCharacter TrailingWhitespace UnorderedKey

✅ Checks

Duplicated Key

Detects if a key is not unique:

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

✅ Correct FOO=BAR BAR=FOO ```

Ending Blank Line

Detects if a file doesn't have a blank line at the end:

env ❌ Wrong FOO=BAR

```env ✅ Correct FOO=BAR

```

Extra Blank Line

Detects if a file contains more than one blank line in a row:

```env ❌ Wrong A=B

FOO=BAR ```

```env ❌ Wrong A=B FOO=BAR

```

```env ✅ Correct A=B

FOO=BAR

```

```env ✅ Correct A=B FOO=BAR

```

Incorrect delimiter

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

✅ Correct FOO_BAR=FOOBAR ```

Key without value

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

Quote character

Detects if a value is wrapped in quotes:

```env ❌ Wrong FOO="BAR"

❌ Wrong FOO='BAR'

✅ Correct FOO=BAR ```

Space character

Detects lines with a whitespace around equal sign character =:

```env ❌ Wrong FOO =BAR

❌ Wrong FOO= BAR

❌ Wrong FOO = BAR

✅ Correct FOO=BAR ```

Trailing whitespace

Detects if a line has a trailing whitespace.

Unordered Key

Detects if a key is not alphabetically ordered:

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

✅ Correct BAR=FOO FOO=BAR ```

You can use blank lines to split lines into groups:

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

✅ Correct FOO=BAR

BAR=FOO ```

🤝 Contributing

If you've ever wanted to contribute to open source, now you have a great opportunity:

• How to set up the project
• How to add a new check

👍 Similar projects

• wemake-services/dotenv-linter (Python)

✨ Contributors

This project exists thanks to all the people who contribute. [Contribute].

♥️ Sponsors

Become a financial contributor and help us sustain our community.

📃 License

MIT