Popularity
5.6
Growing
Activity
8.6
Growing
345
10
39

Description

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

    ✅Duplicated Key     ✅Incorrect delimiter     ✅Key without value     ✅Leading character     ✅Lowercase key     ✅Quote character (Will be available in v2.0.0)     ✅Space character     ✅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:

Programming language: Rust
Tags: Testing     Code Analysis     Code Quality     Linter    
Latest version: v2.0.0

dotenv-linter alternatives and similar packages

Based on the "Testing" category

Do you think we are missing an alternative of dotenv-linter or a related project?

Add another 'Testing' Package

README

⚡️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:

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

👨‍💻 Installation

Binary

```shell script

Linux

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

Alpine Linux

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

macOS

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


### 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 (will be available in [v2.1.0](https://github.com/dotenv-linter/dotenv-linter/issues/217))

```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 -vpwd`:/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

Example: .github/workflows/dotenv_linter.yml

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: dotenv-linter/action-dotenv-linter@v2
        with:
          github_token: ${{ secrets.github_token }}

In the example above, action-dotenv-linter is used to run dotenv-linter.

CircleCI

Example: .circleci/config.yml

version: 2.1
jobs:
  dotenv-linter:
    docker:
      - image: circleci/rust:latest
    steps:
      - checkout
      - run:
          name: Run dotenv-linter
          command: |
            wget https://github.com/dotenv-linter/dotenv-linter/releases/latest/download/dotenv-linter-alpine-x86_64.tar.gz \
            -O - -q | tar -xzf -
            ./dotenv-linter

🚀 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 from check, you can use the argument --exclude FILE_PATH or its short version -e FILE_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 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 argument --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:

❌ Wrong
FOO=BAR
✅ Correct
FOO=BAR

Extra Blank Line

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

❌ Wrong
A=B


FOO=BAR
❌ Wrong
A=B
FOO=BAR


✅ Correct
A=B

FOO=BAR

✅ Correct
A=B
FOO=BAR

Incorrect delimiter

Detects if a key does not use an underscore to separate words:

❌ Wrong
FOO-BAR=FOOBAR

✅ Correct
FOO_BAR=FOOBAR

Key without value

Detects if a line has a key without a value:

❌ 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):

❌ 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:

❌ Wrong
FOo_BAR=FOOBAR

❌ Wrong
foo_bar=FOOBAR

✅ Correct
FOO_BAR=FOOBAR

Quote character

Detects if a value is wrapped in quotes:

❌ Wrong
FOO="BAR"

❌ Wrong
FOO='BAR'

✅ Correct
FOO=BAR

Space character

Detects lines with a whitespace around equal sign character =:

❌ 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:

❌ Wrong
FOO=BAR
BAR=FOO

✅ Correct
BAR=FOO
FOO=BAR

🤝 Contributing

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

👍 Similar projects

✨ Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

♥️ Sponsors

Become a financial contributor and help us sustain our community.

📃 License

MIT


*Note that all licence references and agreements mentioned in the dotenv-linter README section above are relevant to that project's source code only.