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

dotenv-linter

Last update: Jan 5, 2023

Related tags

App rust dotenv linter rust-lang check env compare fix hacktoberfest contributor-friendly contributors-welcome dotenv-linter

Overview

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

Dotenv-linter can check / fix / compare .env files for problems that may cause the application to malfunction.

Available checks:

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

What is a .env file?

     💡 A .env file or dotenv file is a simple text file containing all the environment variables of a project.
    Storing configuration in the environment variables is one of the tenets of the Manifesto of Twelve-Factor App.
    The .env file has a simple key-value format, for example: FOO=BAR.
    More information you can find in articles in English and Russian.

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 and Super-Linter) 🔥

Articles about dotenv-linter:

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

👨‍💻 Installation

Pre-compiled binary

# 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

# Or a shorter way
$ curl -sSfL https://git.io/JLbXn | sh -s

# Specify installation directory and version
$ curl -sSfL https://git.io/JLbXn | sh -s -- -b usr/local/bin v2.0.0

# Alpine Linux (using wget)
$ wget -q -O - https://git.io/JLbXn | sh -s

You can find other installation methods here: https://dotenv-linter.github.io/#/installation

🚀 Usage

✅ Check

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

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

Checking .env.test
.env.test:1 LeadingCharacter: Invalid leading character detected

Found 3 problems

🛠 Fix

It can also fix the found warnings with the fix command:

$ dotenv-linter fix
Fixing .env
Original file was backed up to: ".env_1601378896"

.env:2 DuplicatedKey: The BAR key is duplicated
.env:3 LowercaseKey: The foo key should be in uppercase

All warnings are fixed. Total: 2

🤲 Compare

In addition, dotenv-linter can compare .env files with each other and output the difference between them:

$ dotenv-linter compare .env .env.example
Comparing .env
Comparing .env.example
.env is missing keys: BAR
.env.example is missing keys: FOO

Other use cases you can find on the documentation site (https://dotenv-linter.github.io):

🚦 Continuous Integration

dotenv-linter can also be used with CI services such as: GitHub Actions and Circle CI.

🚧 Benchmark

Benchmarking dotenv-linter/dotenv-linter and wemake-services/dotenv-linter has done using the hyperfine utility:

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`dotenv-linter/dotenv-linter .env`	2.7 ± 0.4	2.0	4.3	1.00
`wemake-services/dotenv-linter .env`	162.6 ± 12.1	153.0	201.3	60.83 ± 10.20

Content of .env file used for benchmarking

 SPACED=

KEY = VALUE

SECRET="my value"

SECRET=Already defined

kebab-case-name=1
snake_case_name=2

✌️ Mentorship

Dotenv-linter is not just a linter for .env files — it is also a contributor-friendly open-source project with the purpose of helping others learn Rust using a simple, but useful tool. 😊

In addition to studying Rust, this project has another goal — to promote love for open-source, help you with the first steps in it and give an opportunity to contribute to the open-source project written in Rust. ❤️

We act as a mentor within this project and help developers follow the path of a novice contributor from start to the top. 🤗

🤝 Contributing

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

👍 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

Comments

Autofix
I have implemented automatic correction of the contents of files based on the results of the check. When displaying, all warnings are marked as Fixed or Unfixed. If all warnings are fixed, exit code is 0.

Just one kind of checks is fixable for now (LowercaseKey), but I have create the scaffold for implementing all kinds of checks.

The CLI key for the autofix mode is -f/--fix.

A few comments about the design:

The separate trait Fix was made for fixes (I tried to keep some symmetry with checks), but it is possible to expand the trait Check itself with this functions too.

There are two groups of fixes: some can be implemented by working only with the line that caused warning, for others you need to work with the entire line collection.

The Fix trait allows you to work with both groups of fixes due to default function implementations.

✔ Checklist:

[x] This PR has been added to CHANGELOG.md (at the top of the list);

[x] Tests for the changes have been added (for bug fixes / features);

[x] Docs have been added / updated (for bug fixes / features).
opened by evgeniy-r 34
WIP build: create docker arm64 image
Closes #449

I hope this will work with GH-actions and the ubuntu-latest container. I used this locally to test some kubernetes stuff on different environments (arm64 and amd64 nodes) and it worked.

Docker Buildx is included in Docker Desktop and Docker Linux packages when installed using the DEB or RPM packages.

If you want to know more: https://docs.docker.com/buildx/working-with-buildx/

✔ Checklist:

[x] Commit messages have been written in Conventional Commits format;

[x] This PR has been added to CHANGELOG.md (at the top of the list);

[x] Tests for the changes have been added (for bug fixes / features);

[x] Docs have been added / updated on the dotenv-linter.github.io (for bug fixes / features).

process stale
opened by mstruebing 28
Color output and --no-color option
This commit if included will:

Adds color to warnings,

Adds a --no-color option to switch off colored output,

Adds a test case to cover --no-color option

✔ Checklist:

[x] This PR has been added to CHANGELOG.md (at the top of the list);

[x] Tests for the changes have been added (for bug fixes / features);

[ ] Docs have been added / updated (for bug fixes / features).

wait hacktoberfest-accepted
opened by Nikhil0487 25
Add docs
Used docsify to create the docs.

You can take a look at the docs here where I pushed my fork branch.

✔ Checklist:

[x] This PR has been added to CHANGELOG.md (at the top of the list);
opened by wesleimp 24
Add compare command
A proof of concept how comparing could work. I think this isn't the cleanest implementation and needs some abstraction work in terms of types, and duplicate work between compare and run but I wanted to see if it can work and how it could work.

We didn't already agreed that this feature needed to be added to the tool, but I liked the idea, found some time and had fun playing around with it.

So this could be the starting point of a discussion and further investigation of that topic.

What do you think?

Check this feature:

# creating test data echo HELLO=value >> .env echo HELLO=value >> .env.local echo WORLD=value >> .env # running dotenv-linter --compare .env .env.local # or cargo run -- --compare .env .env.local
feature
opened by mstruebing 23
Release v3.0.0
What should be included in the new release v3.0.0.

Features:

[x] Color output and --no-color option (#307)

[x] Display file names being scanned (#311)

[x] Add compare command (#282)

[x] Make an output on-the-fly (#335)

[x] Add support export prefix (#337)

[x] Add support multi-line values (#339)

Improvements:

[x] Breaking changes: Using subcommands instead of flags (#333)

[x] Fix a bug with QuoteCharacterChecker and values with whitespaces (#343)

[x] Not all problems are found (#345)

Infrastructure:

[x] Add commitlint to follow Conventional Commits (#347)

[x] Add Conventional Commits to PULL_REQUEST_TEMPLATE.md (#347)

Site:

[x] Add action-misspell (https://github.com/dotenv-linter/dotenv-linter.github.io/issues/17)

[x] Change flags to subcommands (https://github.com/dotenv-linter/dotenv-linter.github.io/issues/16)

GitHub Action:

[x] Add action-shellcheck (https://github.com/dotenv-linter/action-dotenv-linter/issues/17)

[x] Add action-misspell (https://github.com/dotenv-linter/action-dotenv-linter/issues/16)

[x] Add --no-color flag (https://github.com/dotenv-linter/action-dotenv-linter/issues/21)

What do you think should be included in the new release?

/cc @dotenv-linter/core
process
opened by mgrachev 20
UnorderedKey fix
PR for https://github.com/dotenv-linter/dotenv-linter/issues/252.

✔ Checklist:

[x] This PR has been added to CHANGELOG.md (at the top of the list);

[x] Tests for the changes have been added (for bug fixes / features);

[x] Docs have been added / updated (for bug fixes / features).
opened by evgeniy-r 19
Provide more short way to install dotenv-linter
Implemented a script for more short way to install dotenv-linter (#112).

The advantage of the solution is its cross-platform. The script is executed with curl/wget and even under Windows (checked on MINGW).

Complexity is the process of automatically declaring an environment variable. In some cases, this is only possible manually at the moment.

This is a working version, I also tested on Alpine Linux.

But I would like to hear any ideas for improving or changing the approach.

Perhaps when we come to a final decision, it makes sense to create a separate repository. Although for installing binaries with a script, it looks suitable in this repo, so far it is not more than 1 file.

✔ Checklist:

[X] This PR has been added to CHANGELOG.md (at the top of the list);

[X] Docs have been added / updated (for bug fixes / features).
opened by DDtKey 19
Use Rc for Warning to reduce memory consumption

Description

The Warning struct has the LineEntry field which clones in every checks, e.g.: DuplicatedKeyChecker.

Use the Rc type for Warning to reduce memory consumption.

Similar issue: https://github.com/dotenv-linter/dotenv-linter/issues/388
improvement

opened by mgrachev 18
Provide dotenv-linter in the Arch User Repository

The Arch User Repository is like a package repository for Arch linux maintained by it's users. I would be happy to set it up there so that any arch user can simply install it with:

<your-aur-helper> -S dotenv-linter (-S is mostly the command to install a package, in case your aur helper does it differently you need to substitute this command.

If that would be desired I would be happy to go :)

opened by mstruebing 18

Shows files that were linted

This PR adds functionality to show the files that were linted as part of a dotenv-linter run. It does so by introducing a new struct Warnings which is basically a wrapper around Vec<Warning> to also include information about the paths related to the warnings.

This PR also fixes tests as a result of the added functionality, and some refactoring.

Below shows the output from running dotenv-linter with different args:

$ cargo run
Checking ".env"
.env:1 LowercaseKey: The hi key should be in uppercase
.env:3 ExtraBlankLine: Extra blank line detected
.env:4 LowercaseKey: The hi3 key should be in uppercase

Checking ".env_2/.env"
.env_2/.env:2 ExtraBlankLine: Extra blank line detected
.env_2/.env:3 LowercaseKey: The hi key should be in uppercase
.env_2/.env:4 DuplicatedKey: The hi key is duplicated
.env_2/.env:4 LowercaseKey: The hi key should be in uppercase

Found 7 problems

$ cargo run -- -q
.env:1 LowercaseKey: The hi key should be in uppercase
.env:3 ExtraBlankLine: Extra blank line detected
.env:4 LowercaseKey: The hi3 key should be in uppercase
.env_2/.env:2 ExtraBlankLine: Extra blank line detected
.env_2/.env:3 LowercaseKey: The hi key should be in uppercase
.env_2/.env:4 DuplicatedKey: The hi key is duplicated
.env_2/.env:4 LowercaseKey: The hi key should be in uppercase

$ cargo run -- -f
Checking ".env"
Original file was backed up to: ".env_1601943961"

.env:1 LowercaseKey: The hi key should be in uppercase
.env:3 ExtraBlankLine: Extra blank line detected
.env:4 LowercaseKey: The hi3 key should be in uppercase

Checking ".env_2/.env"
Original file was backed up to: ".env_2/.env_1601943961"

.env_2/.env:2 ExtraBlankLine: Extra blank line detected
.env_2/.env:3 LowercaseKey: The hi key should be in uppercase
.env_2/.env:4 DuplicatedKey: The hi key is duplicated
.env_2/.env:4 LowercaseKey: The hi key should be in uppercase

All warnings are fixed. Total: 7

$ cargo run -- -f -q
Original file was backed up to: ".env_1601943979"
Original file was backed up to: ".env_2/.env_1601943979"

All warnings are fixed. Total: 7

$ cargo run -- -f --no-backup
Checking ".env"
.env:1 LowercaseKey: The hi key should be in uppercase
.env:3 ExtraBlankLine: Extra blank line detected
.env:4 LowercaseKey: The hi3 key should be in uppercase

Checking ".env_2/.env"
.env_2/.env:2 ExtraBlankLine: Extra blank line detected
.env_2/.env:3 LowercaseKey: The hi key should be in uppercase
.env_2/.env:4 DuplicatedKey: The hi key is duplicated
.env_2/.env:4 LowercaseKey: The hi key should be in uppercase

All warnings are fixed. Total: 7

$ cargo run -- -f -q --no-backup

All warnings are fixed. Total: 7

✔ Checklist:

[x] This PR has been added to CHANGELOG.md (at the top of the list);
[x] Tests for the changes have been added (for bug fixes / features);
[x] Docs have been added / updated (for bug fixes / features).

Closes #268

wait hacktoberfest-accepted

opened by Anthuang 16

The `set-output` command is deprecated and will be disabled soon

Run echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
Warning: The `set-output` command is deprecated and will be disabled soon. Please upgrade to using Environment Files. For more information see: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/

Link: https://github.com/dotenv-linter/dotenv-linter/actions/runs/3771276565/jobs/6411591327

help wanted

opened by mgrachev 0

feat: Support skipping specific checks with an environment variable(#601)
✔ Checklist:

[x] Commit messages have been written in Conventional Commits format;

[x] Tests for the changes have been added (for bug fixes / features);

[ ] Docs have been added / updated on the dotenv-linter.github.io (for bug fixes / features).
opened by YeswanthRajakumar 0
Support skipping specific checks with an environment variable
Clap supports accepting multiple values in a single environment variable:

https://docs.rs/clap/3.1.10/clap/struct.Arg.html#method.env

This could be used to implement something like this:

DOTENV_LINTER_SKIP=QuoteCharacter,UnorderedKey dotenv-linter
help wanted good first issue
opened by mwgamble 4
Confusing behaviour when using --skip
If I pass --skip SpecificCheck, it eats all of the remaining arguments. If I do the traditional Unix thing of specifying flags before arguments, like so:

dotenv-linter --skip QuoteCharacter my/folder/.env

It completely ignores the fact that I passed a custom filename, and only checks for a .env file in the current folder. If such a file exists, it checks it. If no such file exists, it exits with a success status code (0).

If I pass the flag after the list of files to check, everything works as expected:

dotenv-linter my/folder/.env --skip QuoteCharacter

It turns out I can make the first example work by doing this:

dotenv-linter --skip QuoteCharacter -- my/folder/.env

However this is uncommon for a CLI app, and isn't mentioned as a supported behaviour in the documentation. Also I don't see any tests that cover the case of skipping checks while also passing a custom list of files.

I think the ideal solution would be to allow flags to be passed in any order. Skipping multiple checks should require passing --skip multiple times.
help wanted
opened by mwgamble 6
Add environment variable for --not-check-updates

In certain environments, it may not be feasible to control all invocations of dotenv-linter. However the environment can typically still be controlled (and usually more easily even if invocations can be controlled). It would be nice if there was a way to set this with an environment variable.
help wanted good first issue

opened by mwgamble 3
Question: is there a way to filter certain comparisons?

If you have .env and .env.example files, it makes sense to compare both files to have the same keys. If you have .env and .env.local, it is quite normal to not have all keys in the .env.local file, but the keys might still have to be the same (even when sometimes a .env.local file might have completely different keys as well).

Is there a way to tell the compare command about the second situation, to compare a local overwrite file to the keys in the actual .env file?
help wanted question proposal

opened by MetalArend 21

Releases(v3.3.0)

v3.3.0(Dec 24, 2022)
Features

Add check for values that require surrounding quotes (#521)

Fixes

Check that tag is valid semver (#556)

Don't remove quotes for values containing hash-sign (#560)

CI

Fix arm docker build (#609)

Replace actions-rs/toolchain with dtolnay/rust-toolchain (#573)

Add docker arm64 image (#533)

Fix release builds (#531)

Add job to check release builds (#529)

Add dprint and lychee actions + ci optimization (#503)

Add stale action (#483)

Fix release (#465)

Documentation

Add commit standard for the CONTRIBUTION file (#561)

Update readme (#543)

Fix links in CHANGELOG.md (#536)

Miscellaneous Tasks

Use Box::<T>::default() instead of Box::new(T::default()) (#605)

Fix clippy warning (#585)

Generate a changelog and update release process (#544)

Update criterion-compare action (#484)

Update cargo-deny config (#481)

Clippy warnings (#480)

Add dependabot (#472)

Refactor

Move CLI commands to separate functions (#489)

Check ci with all-targets arg (#488)

Usage of fix and compare (#486)

Skip_checks with use default iterator (#482)

Testing

Add tests to verify cli application (#490)

Update dependencies

Bump actions/stale from 6 to 7 (#607)

Bump update-informer from 0.5.0 to 0.6.0 (#603)

Bump wagoid/commitlint-github-action from 5.2.2 to 5.3.0 (#595)

Bump Swatinem/rust-cache from 2.1.0 to 2.2.0 (#588)

Bump lycheeverse/lychee-action from 1.5.3 to 1.5.4 (#587)

Bump lycheeverse/lychee-action from 1.5.2 to 1.5.3 (#586)

Bump Swatinem/rust-cache from 2.0.1 to 2.1.0 (#582)

Bump lycheeverse/lychee-action from 1.5.1 to 1.5.2 (#583)

Bump wagoid/commitlint-github-action from 5.2.0 to 5.2.2 (#581)

Bump boa-dev/criterion-compare-action from 3.2.3 to 3.2.4 (#580)

Bump assert_cmd from 2.0.4 to 2.0.5 (#578)

Bump criterion from 0.3.6 to 0.4.0 (#575)

Bump Swatinem/rust-cache from 2.0.0 to 2.0.1 (#571)

Bump dunce from 1.0.2 to 1.0.3 (#564)

Bump wagoid/commitlint-github-action from 5.0.2 to 5.2.0 (#565)

Bump boa-dev/criterion-compare-action from 3.2.2 to 3.2.3 (#570)

Bump actions/stale from 5 to 6 (#552)

Bump lycheeverse/lychee-action from 1.5.0 to 1.5.1 (#538)

Bump Swatinem/rust-cache from 1.4.0 to 2.0.0 (#534)

Bump dprint/check from 2.0 to 2.1 (#535)

Bump criterion from 0.3.5 to 0.3.6 (#532)

Bump wagoid/commitlint-github-action from 5.0.1 to 5.0.2 (#530)

Bump Swatinem/rust-cache from 1.3.0 to 1.4.0 (#528)

Bump actions/cache from 3.0.2 to 3.0.4 (#522)

Bump boa-dev/criterion-compare-action from 3.2.1 to 3.2.2 (#518)

Bump regex from 1.5.4 to 1.5.6 (#520)

Bump crossbeam-utils from 0.8.5 to 0.8.8 (#519)

Bump wagoid/commitlint-github-action from 4.1.11 to 5.0.1 (#527)

Bump boa-dev/criterion-compare-action from 3.2.0 to 3.2.1 (#509)

Bump clap from 3.1.9 to 3.1.10 (#506)

Bump clap from 3.1.8 to 3.1.9 (#505)

Bump actions/stale from 4 to 5 (#502)

Bump actions/cache from 3.0.1 to 3.0.2 (#501)

Bump codecov/codecov-action from 2.1.0 to 3 (#499)

Bump wagoid/commitlint-github-action from 4.1.10 to 4.1.11 (#500)

Bump clap from 3.1.6 to 3.1.8 (#497)

Bump wagoid/commitlint-github-action from 4.1.9 to 4.1.10 (#495)

Bump actions/cache from 3.0.0 to 3.0.1 (#494)

Update dependency update-informer (#493)

Bump actions/cache from 2 to 3.0.0 (#491)

Update clap (#485)

Bump wagoid/commitlint-github-action from 2 to 4.1.9 (#473)

Bump actions/checkout from 1 to 3 (#474)

Bump codecov/codecov-action from 1 to 2.1.0 (#475)

Bump tempfile from 3.2.0 to 3.3.0 (#478)

Bump assert_cmd from 2.0.2 to 2.0.4 (#479)

Bump update-informer from 0.3.0 to 0.4.0 (#477)

Update dependency update-informer (#470)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-aarch64.tar.gz(802.80 KB)
dotenv-linter-alpine-x86_64.tar.gz(1.71 MB)
dotenv-linter-darwin-arm64.tar.gz(1.07 MB)
dotenv-linter-darwin-x86_64.tar.gz(1.07 MB)
dotenv-linter-linux-aarch64.tar.gz(1.59 MB)
dotenv-linter-linux-x86_64.tar.gz(1.62 MB)
dotenv-linter-win-aarch64.zip(243.05 KB)
dotenv-linter-win-x64.zip(890.63 KB)
v3.2.0(Jan 24, 2022)
🚀 Added

Add check for new version #454 (@mgrachev)

Support of double-quoted multiline values #453 (@DDtKey)

Support of single-quoted multiline values #450 (@DDtKey)

🔧 Changed

Update cargo-deny config #459 (@mgrachev)

Update docker build #456 (@mgrachev)

Update dependencies #455 (@mgrachev)

Use derive (default) instead of impl #452 (@mgrachev)

Get rid of Rc<FileEntry> in LineEntry #448 (@mgrachev)

Replace LineEntry with line number in Warning #447 (@mgrachev)

Tidy up imports #446 (@mgrachev)

Add type alias for Result #445 (@mgrachev)

Change edition to 2021 #444 (@mgrachev)

Display a message on installation error #443 (@mgrachev)

Fix falling on checking multi-line values #462 (@DDtKey)

Detect multi-line values if they contain a = sign #463 (@DDtKey)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(1.70 MB)
dotenv-linter-darwin-arm64.tar.gz(1.11 MB)
dotenv-linter-darwin-x86_64.tar.gz(1.12 MB)
dotenv-linter-linux-aarch64.tar.gz(1.59 MB)
dotenv-linter-linux-x86_64.tar.gz(1.61 MB)
dotenv-linter-win-x64.zip(886.00 KB)
v3.1.1(Aug 25, 2021)
🚀 Added

aarch64 support (mac, linux, win) #436 (@DDtKey)

🔧 Changed

Fix clippy warnings #437 (@mgrachev)

Use enum instead of string for lint's identity #427 (@fabricio7p)

Get rid of the name field in checks and fixes structs #432 (@mgrachev)

Replace filter with unwrap on flatten #434 (@Fcukit)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-aarch64.tar.gz(761.94 KB)
dotenv-linter-alpine-x86_64.tar.gz(766.91 KB)
dotenv-linter-darwin-arm64.tar.gz(344.41 KB)
dotenv-linter-darwin-x86_64.tar.gz(356.69 KB)
dotenv-linter-linux-aarch64.tar.gz(606.31 KB)
dotenv-linter-linux-x86_64.tar.gz(619.68 KB)
dotenv-linter-win-aarch64.zip(211.48 KB)
dotenv-linter-win-x64.zip(222.49 KB)
v3.1.0(Jun 9, 2021)
🚀 Added

Add fixer: Substitution Key #428 (@DDtKey)

Refactor check unit tests #421 (@mc1098)

Add missing integration tests #420 (@gosolivs)

Add checker: Substitution Key #414 (@de-sh)

Print a message if the amount of checks doesn't match the amount of fixes #415 (@marcel-baur)

Print a message "Nothing to compare" #398 (@jakecorrenti)

Add action-hadolint #400 (@iovanom)

Add method to get substitution keys to LineEntry #391 (@zotho)

Added a Fix Benchmark #399 (@a4blue)

Add benchmark for the compare function #395 (@FrancisMurillo)

Print a message when there are no input files for fix subcommand #394 (@mdycz)

Print a message when there are no input files #392 (@jodli)

Add a GitHub Action to compare benchmarks #378 (@mgrachev)

Add benchmark for the check function #376 (@mgrachev)

🔧 Changed

Refactor hard-coded mandatory fixer #413 (@akhtariev)

Don't fix key order for substitution variables #406 (@stygian-coffee)

Allow unordered keys for substitution variables #401 (@Ru5ty0ne)

Replace String with Into<String> in LineEntry::new #404 (@miDeb)

Replace String on Into for all TestDir methods #397 (@ebobrow)

Use Rc internally to reduce memory consumption #393 (@Tom01098)

Use actions-rs/clippy-check to run clippy #375 (@mgrachev)

Remove Result from the return type #374 (@DDtKey)

Add .bak extension to backup files and don't lint backup files #367 (@mstruebing)

Add .env explanation #363 (@henryboisdequin)

Contemplate variables containing $ character #418 (@JuanMarchetto)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(781.96 KB)
dotenv-linter-darwin-x86_64.tar.gz(361.42 KB)
dotenv-linter-linux-x86_64.tar.gz(634.86 KB)
dotenv-linter-win-x64.zip(225.91 KB)
v3.0.0(Jan 11, 2021)
🚀 Added

Add compare-command #282 (@mstruebing)

Add colored output feature and --no-color flag to disable colors #307 (@Nikhil0487)

Display linted files when run #311 (@Anthuang)

Add export prefix support #340 (@skonik)

Add colored output for compare command #356 (@mgrachev)

🔧 Changed

Refactoring to get rid of unnecessary heap allocations and some improvements in API ergonomics #350 (@vbrandl)

Add benchmark to README #351 (@mgrachev)

Fix QuoteCharacterChecker to not raise warning when quote characters are used for values with whitespaces #349 (@sebastiantoh)

Find all problems on the first run for KeyWithoutValue #348 (@vbrandl)

Add commitlint action #347 (@mgrachev)

Add cargo-deny action #346 (@mgrachev)

Remade flags to subcommands #342 (@mgrachev)

Changed behavior of QuoteCharacterChecker for multiline values support #341 (@artem-russkikh)

Make an output on-the-fly #336 (@DDtKey)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(754.73 KB)
dotenv-linter-darwin-x86_64.tar.gz(341.54 KB)
dotenv-linter-linux-x86_64.tar.gz(614.97 KB)
dotenv-linter-win-x64.zip(228.18 KB)
v2.2.1(Oct 24, 2020)
🚀 Added

Add .gitattributes to improve git diff #330 (@DDtKey)

Add action-yamllint #317 (@vk26)

Add default exclude list #324 (@ametalon)

🔧 Changed

Fix bug where symlinks would cycle in recursive mode #328 (@sonro)

Fix linter rechecking files if they were listed more than once #327 (@Aashu23)

Added docker build step to the CI pipeline #322 (@JoeAmedeo)

Change soon deprecated set-env action #320 (@marcodenisi)

Fix docker release #319 (@mgrachev)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(760.93 KB)
dotenv-linter-darwin-x86_64.tar.gz(329.10 KB)
dotenv-linter-linux-x86_64.tar.gz(620.24 KB)
dotenv-linter-win-x64.zip(219.66 KB)
v2.2.0(Oct 12, 2020)
🚀 Added

Add integration test for autofix #309 (@evgeniy-r)

Add action-misspell #304 (@PurpleMyst)

Add action-shellcheck #303 (@amd-9)

Add fixer: UnorderedKeyFixer #261 (@evgeniy-r)

Add backup feature and --no-backup flag for fixers #272 (@baile320)

Add fixer: ExtraBlankLineFixer #260 (@diggymo)

Add fixer: DuplicatedKeyFixer #270 (@utter-step)

Add fixer: LeadingCharacter #259 (@baile320)

Add fixer: IncorrectDelimiter #258 (@gillespiecd)

Add support of comments to disable checks #239 (@mgrachev)

Add autofix for EndingBlankLine #263 (@baile320)

Add test for two keys that only differ in case #269 (@yanakad)

Add autofix for TrailingWhitespace #255 (@gregcline)

Add fixer: KeyWithoutValueFixer #254 (@unexge)

Add fixer: QuoteCharacterFixer #257 (@lensvol)

Add fixer: SpaceCharacterFixer #253 (@DDtKey)

Add total problems to output and --quiet argument #242 (@wesleimp, @mgrachev)

Add autofix feature (for LowercaseKey check) #228 (@evgeniy-r)

Add installation CI test for Windows (via install.sh) #235 (@DDtKey)

🔧 Changed

Update docs #315 (@mgrachev)

Remove CARGO_TERM_COLOR from the shellcheck workflow #313 (@MusiKid)

Add check_output helper function for integration tests #305 (@Anthuang)

Add an additional test for LineEntry.get_value #306 (@vvkpd)

Update args help #299 (@mgrachev)

Move remove_invalid_leading_chars_test to tests module #298 (@mgrachev)

Add command to install latest version via Homebrew #297 (@mgrachev)

Add CARGO_TERM_COLOR env variable to the actions #296 (@skippednote)

Remove code related to "Fixed/Unfixed warnings" #289 (@mgrachev)

Refactoring integration tests #288 (@mgrachev)

Fix a bug with fixers spawning new warnings #287 (@evgeniy-r)

Fix a bug with UnorderedKeyChecker and control comments #283 (@mgrachev)

Change the line grouping for the UnorderedKey checker #281 (@evgeniy-r)

Fix a bug with ExtraBlankLineFixer and control comments #279 (@mgrachev)

Move logic for creating LineEntry for tests to common module #280 (@mgrachev)

Simplify UnorderedKeyChecker #277 (@mgrachev)

Partition fixed/unfixed warnings #275 (@gillespiecd)

Add missing test for IncorrectDelimiterChecker #273 (@mgrachev)

Add *.env to gitignore #271 (@baile320)

Actions uses cache@v2 #262 (@gillespiecd)

Update logic for IncorrectDelimiterCheck #267 (@baile320)

Add tests for default implementation of Fix::fix_warnings #266 (@kilotaras)

Modularize common.rs #264 (@gillespiecd)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(728.97 KB)
dotenv-linter-darwin-x86_64.tar.gz(328.52 KB)
dotenv-linter-linux-x86_64.tar.gz(572.25 KB)
dotenv-linter-win-x64.zip(219.19 KB)
v2.1.0(Jul 13, 2020)
🚀 Added

Add install.sh for provide more short way to install #220 (@DDtKey)

Add flag to enable recursive search for .env files #223 (@DDtKey)

Add docs #226 (@wesleimp)

Add Windows publishing to release workflow #211 (@DDtKey)

Add support canonicalize path for Windows #213 (@DDtKey)

Add build and test steps running on Windows #216 (@mgrachev)

🔧 Changed

Add the field with a checker name to Warning #234 (@evgeniy-r)

Remove FileEntry::get_content_by_path in favor of fs::read_to_string #233 (@mstruebing)

Move show-checks flag to main.rs #227 (@mgrachev)

Fix total_lines in some tests #224 (@DDtKey)

Consider blank lines in UnorderedKey check #221 (@mgrachev)

Optimize integration tests #218 (@mgrachev)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(661.71 KB)
dotenv-linter-darwin-x86_64.tar.gz(290.95 KB)
dotenv-linter-linux-x86_64.tar.gz(547.57 KB)
dotenv-linter-win-x64.zip(208.04 KB)
v2.0.0(Jun 15, 2020)
🚀 Added

Add check: TrailingWhitespace #190 (@pineapplethief)

Add an argument to show available checks #202 (@DDtKey)

Add the ability to skip checks #178 (@mgrachev)

Add check: ExtraBlankLine #180 (@evgeniy-r)

Add check: EndingBlankLine #170 (@evgeniy-r)

Add check: Quote characters #174 (@sourabhmarathe)

Github Actions: Add caching in the CI workflow #163 (@evgeniy-r)

Add GitHub Workflow for AUR publishing #161 (@mstruebing)

🔧 Changed

Enable checks for outside current directory #209 (@tisorlawan)

Refactor EndingBlankLineChecker: change last line check logic (add total_lines to FileEntry) #207 (@DDtKey)

Fix check (for several successive blank lines): ExtraBlankLine #208 (@evgeniy-r)

Replace PathBuf with FileEntry for LineEntry #203 (@mgrachev)

Replace &'static str with &'a str for LeadingCharacterChecker #200 (@rossjones)

Replace &'static str with &'a str for QuoteCharacterChecker #198 (@duncandean)

Replace &'static str with &'a str for EndingBlankLineChecker #197 (@rossjones)

Replace String with &'a str for UnorderedKeyChecker #196 (@k0va1)

Replace String with &'a str for SpaceCharacterChecker #195 (@k0va1)

Replace String with &'a str for LowercaseKeyChecker #194 (@tisorlawan)

Replace &'static str with &'a str for ExtraBlankLineChecker #193 (@vishalsodani)

Replace String with &'a str for DuplicatedKeyChecker #192 (@iamsaquib)

Replace String with &'a str for KeyWithoutValueChecker #177 (@mgrachev)

Fix docker image #160 (@mgrachev)

Replace &'static str with &'a str for IncorrectDelimiterChecker #191 (@DDtKey)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(615.19 KB)
dotenv-linter-darwin-x86_64.tar.gz(289.00 KB)
dotenv-linter-linux-x86_64.tar.gz(506.82 KB)
v1.2.0(Apr 20, 2020)
🔧 Changed

SpaceCharacter: Show check name in the message #149 (@pineapplethief)

LeadingCharacter: Show check name in message #144 (@michaetto)

Rename UnorderedKeys check to singular UnorderedKey #147 (@pineapplethief)

KeyWithoutValue: Show check name in the message #139 (@harshu4)

LowercaseKey: Show check name in the message #131 (@qelphybox)

DuplicatedKey: Show check name in message #138(@SaMuRa1ReM1X)

IncorrectDelimiter: Show check name in the message #146 (@undef1nd)

Replaced kcov with grcov in Github Actions #143 (@pmk21)

Streamline CLI tests and split into smaller files #137 (@sonro)

UnorderedKey: Added check name to the message #140 (@pmk21)

Add test coverage for CLI --exclude arguments #135 (@sonro)

Renamed check SpacesAroundEqual to SpaceCharacter #134 (@SaMuRa1ReM1X)

Rename check DuplicatedKeys to DuplicatedKey #133 (@sonro)

Minimizing Rust Binary Size #132 (@akirill0v)

Remove the unwrap method and use platform native OsString to fetch the information about current directory #115 (@kanapuli)

Use HashSet for DuplicateKeyChecker #113 (@TamasFlorin)

Use reference for the LineEntry as part of the run method for checks #111 (@TamasFlorin)

New CLI API: Ability to check multiple directories #99 (@mgrachev)

Add exit with the code 0 when there are no warnings #105 (@simPod)

Use get method to get result of item in Vec and use ? operator unwrap the result if it's Some #108 (@boybird)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(581.27 KB)
dotenv-linter-darwin-x86_64.tar.gz(270.95 KB)
dotenv-linter-linux-x86_64.tar.gz(495.81 KB)
v1.1.2(Mar 13, 2020)
🔧 Changed

Fix --path CLI parameter not canonizing filepaths from directory path passed as argument and not working as intended as a result #97 (@pineapplethief)

Fix incorrect delimiter check for keys contains numeric #95 (@alter369)

Add LineEntry.is_empty_or_comment method to DRY and simplify Check.run #94 (@pineapplethief)

Refactor Github Actions and reduce Docker Image size #90 (@Macbet)

Use Line.get_key in all checks #89 (@pineapplethief)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(1.01 MB)
dotenv-linter-darwin-x86_64.tar.gz(370.91 KB)
dotenv-linter-linux-x86_64.tar.gz(951.90 KB)
v1.1.1(Feb 18, 2020)
🔧 Changed

Show the full path to the file relative to the current directory #85 (@mgrachev)

Source code(tar.gz)
Source code(zip)
dotenv-linter-alpine-x86_64.tar.gz(1.02 MB)
dotenv-linter-darwin-x86_64.tar.gz(385.65 KB)
dotenv-linter-linux-x86_64.tar.gz(963.28 KB)
v1.1.0(Jan 29, 2020)
🚀 Added

Add check: Unordered keys #72 (@mgrachev)

Add the ability to specify the directory where to run #65 (@Louis-Lesage)

Add check: Duplicated keys #33 (@mstruebing)

Add exit with the code 1 on warnings found #58 (@Louis-Lesage)

Add exclude argument to exclude specific files #49 (@mstruebing)

Add the ability to include files to check #48 (@mgrachev)

Add check: Spaces around equal sign #35 (@artem-russkikh)

Add skipping of commented or empty lines #37 (@mstruebing)

🔧 Changed

Rename leading_space to leading_character and check for allowed chars #63 (@mstruebing)

Remove multiple checks of the same file #62 (@mstruebing)

Add mutability support for checks #52 (@mgrachev)

Source code(tar.gz)
Source code(zip)
dotenv-linter-v1.1.0-alpine-x86_64.tar.gz(1.00 MB)
dotenv-linter-v1.1.0-darwin-x86_64.tar.gz(375.54 KB)
dotenv-linter-v1.1.0-linux-x86_64.tar.gz(949.30 KB)
v1.0.0(Jan 1, 2020)
🚀 Added

Add check: Keys without values #22 (@mstruebing)

Add check: Lowercase keys #21 (@qelphybox)

Add check: Incorrect delimiter #20 (@sonro)

Add Display trait for LineEntry #19 (@mstruebing)

🔧 Changed

Add support for command line arguments #31 (@mgrachev)

Replace field warning with template for all check structs #26 (@mgrachev)

Prepare a template for easy adding new checks #14 (@mgrachev)

Source code(tar.gz)
Source code(zip)
dotenv-linter-v1.0.0-alpine-x86_64.tar.gz(1022.59 KB)
dotenv-linter-v1.0.0-darwin-x86_64.tar.gz(352.48 KB)
dotenv-linter-v1.0.0-linux-x86_64.tar.gz(937.09 KB)

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

Related tags

Overview

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

👨‍💻 Installation

Pre-compiled binary

🚀 Usage

✅ Check

🛠 Fix

🤲 Compare

🚦 Continuous Integration

🚧 Benchmark

✌️ Mentorship

🤝 Contributing

👍 Similar projects

✨ Contributors

♥️ Sponsors

📃 License

Comments

✔ Checklist:

✔ Checklist:

✔ Checklist:

✔ Checklist:

✔ Checklist:

✔ Checklist:

Description

✔ Checklist:

✔ Checklist:

Releases(v3.3.0)

v3.3.0(Dec 24, 2022)

Features

Fixes

CI

Documentation

Miscellaneous Tasks

Refactor

Testing

Update dependencies

v3.2.0(Jan 24, 2022)

🚀 Added

🔧 Changed

v3.1.1(Aug 25, 2021)

🚀 Added

🔧 Changed

v3.1.0(Jun 9, 2021)

🚀 Added

🔧 Changed

v3.0.0(Jan 11, 2021)

🚀 Added

🔧 Changed

v2.2.1(Oct 24, 2020)

🚀 Added

🔧 Changed

v2.2.0(Oct 12, 2020)

🚀 Added

🔧 Changed

v2.1.0(Jul 13, 2020)

🚀 Added

🔧 Changed

v2.0.0(Jun 15, 2020)

🚀 Added

🔧 Changed

v1.2.0(Apr 20, 2020)

🔧 Changed

v1.1.2(Mar 13, 2020)

🔧 Changed

v1.1.1(Feb 18, 2020)

🔧 Changed

v1.1.0(Jan 29, 2020)

🚀 Added

🔧 Changed

v1.0.0(Jan 1, 2020)

🚀 Added

🔧 Changed

Owner

dotenv-linter

ICSx⁵ is an Android app to subscribe to remote or local iCalendar files (like time tables of your school/university or event files of your sports team).

An E-Commerce android App whose frontend is implemented using Kotlin & XML files and backend/database is implemented using My SQL & PHP files

A lightweight super-fast wireless file sharing application built on WiFi Peer-to-Peer technology.

Text to Speech Project for Spring Boot and Kotlin, Auth Server, Python with Fast API (gTTS)

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