Ideas

[mgrachev]

Hi there!

If you have any ideas on how to improve this project or what other checks we should add - welcome 😉

[mstruebing]

A dockerimage would be nice I think

[mgrachev]

A dockerimage would be nice I think

Could you give more information about that? Do you want to run this linter using a Docker image?

[mstruebing]

Yes, an image with an already compiled binary which I can just use without the need to install dotenv-linter or any dependencies (like rust for example).

[qelphybox]

Disabling/enabling comments. It's a good option, i think some users may want to disable some checkers
e.g.

# linter:disable UnorderedKeysChecker
 
MY=val
OWN=val
ORDER=val

[qelphybox]

I think autofix option is awesome, that's what i really love in linters
We have an .env

 LOGGER_LEVEL=info
RAILS_ENV
DB-NAME=testing
DEbUG_hTTP=true
DB_NAME=development

run dotenv-linter --fix

• remove leading spaces
• replace incorrect delimeter to "_"
• set '=' to empty keys
• remove duplicated keys, sets value of the last key
• order keys

We'll get:

DB_NAME=development
DEBUG_HTTP=true
LOGGER_LEVEL=info
RAILS_ENV=

[mgrachev]

Yes, an image with an already compiled binary which I can just use without the need to install dotenv-linter or any dependencies (like rust for example).

Great idea! I've just created an issue to do that #34.

[mgrachev]

Disabling/enabling comments. It's a good option, i think some users may want to disable some checkers
e.g.

# linter:disable UnorderedKeysChecker
 
MY=val
OWN=val
ORDER=val

I think it's a good idea! Could you open an issue and write your vision on how this will work?

[mgrachev]

I think autofix option is awesome, that's what i really love in linters
We have an .env

 LOGGER_LEVEL=info
RAILS_ENV
DB-NAME=testing
DEbUG_hTTP=true
DB_NAME=development

run dotenv-linter --fix

• remove leading spaces
• replace incorrect delimeter to "_"
• set '=' to empty keys
• remove duplicated keys, sets value of the last key
• order keys

We'll get:

DB_NAME=development
DEBUG_HTTP=true
LOGGER_LEVEL=info
RAILS_ENV=

Awesome idea! Thank you! I will think about how to implement it.

[mstruebing]

Maybe it would be a good idea to give the user the ability to lint a specific file, i.e.: dotenv-linter .my-env-file

[artem-russkikh]

I think it would be good to add check for lines trailing spaces, what do you think?

Also it would be good to skip blank lines. Blank lines could be used in env files for separation some blocks of variables. ENV file like this:

FOO=BAR

BAR=FOO

prints out .env:2 The key should be with a value or have an equal sign

And I've created issue for filtering out comments #36

[mgrachev]

Maybe it would be a good idea to give the user the ability to lint a specific file, i.e.: dotenv-linter .my-env-file

You're right! I've already thought about it. I will open an issue to do that a bit later.

[mgrachev]

I think it would be good to add check for lines trailing spaces, what do you think?

Also it would be good to skip blank lines. Blank lines could be used in env files for separation some blocks of variables. ENV file like this:

FOO=BAR

BAR=FOO

prints out .env:2 The key should be with a value or have an equal sign

And I've created issue for filtering out comments #36

Good ideas! Thank you!

[artem-russkikh]

Change exit code to nonzero if some checks are failing – it will be useful for CI

[mgrachev]

Maybe it would be a good idea to give the user the ability to lint a specific file, i.e.: dotenv-linter .my-env-file

Add ability to include files to check - #45
Add ability to exclude files from check - #46

[mgrachev]

Change exit code to nonzero if some checks are failing – it will be useful for CI

Good catch! Thank you! #47

[Neodelf]

I don't know exactly about the pros of this feature, but what do you think about creation .env.example file which gathers all variables from all .env.* (i.e. .env.test) files?
I mean it will help keep all available vars in one place.
In addition, this feature can insert an example of the meaning of each variable by regex-ing values from files.

[mgrachev]

Thank you!
I think it will be useful, but the main task of dotenv-linter is to check .env files.
So, I think this feature should be implemented in a separate tool.

[GaboFDC]

what about allowing to have a config file, where the excluded checks are defned?

[DDtKey]

what about allowing to have a config file, where the excluded checks are defned?

Thanks, I think that's a good idea!
In general, we have already partially begun to move in this direction (#237)

[alshdavid]

It might be out of the scope of this project but it would be great if your utility could also inject the values into the current shell/bash/cmd/etc session.

It's really hard to import environment variables from a dotenv file to a OS in a way that is platform agnostic

Something like:

dotenv-linter --inject ./values.env

[mstruebing]

Hey @alshdavid, thank you for your idea but to be honest I think this is out of scope as you already mentioned.
And to my knowledge a single source values.env should make the environment variables available in the current shell session at least in unixy environments.

[bryantbiggs]

great tool btw, thank you! it would be cool if it had the ability to diff across files to compare say .env.local and .env.dev or even compare all .env* in a directory to know which files might be missing values

[mgrachev]

great tool btw, thank you! it would be cool if it had the ability to diff across files to compare say .env.local and .env.dev or even compare all .env* in a directory to know which files might be missing values

Thank you! We will think about it soon.

[mstruebing]

great tool btw, thank you! it would be cool if it had the ability to diff across files to compare say .env.local and .env.dev or even compare all .env* in a directory to know which files might be missing values

A cool idea, I really like that to be honest.

[ben-eb]

We use https://www.npmjs.com/package/dotenv-safe to make sure that any missing environment variables are flagged at runtime. It might be nice to have an option in this tool to check a .env file against an example env to make sure that there are no missing variables. 🙂

[mgrachev]

We use https://www.npmjs.com/package/dotenv-safe to make sure that any missing environment variables are flagged at runtime. It might be nice to have an option in this tool to check a .env file against an example env to make sure that there are no missing variables. 🙂

Thank you! It seems to me that @mstruebing has already opened a PR with similar functionality #282 🤔

[ben-eb]

@mgrachev Thanks, that's great news! 👍

[mgrachev]

We are happy to announce the release of dotenv-linter - v3.0.0 🥳
Thanks to everyone who contributed to this release 🙏

[eric-burel]

Hey folks, crossposting from "modenv" project: kurtbuilds/modenv#4

Do you think dotenv-linter could have a wider scope than just linting? For instance modenv let's you add variables to file easily via CLI, and I've proposed in the linked issue to extend it to a .env backup system. I am kinda looking for a non-cloud alternative to Doppler.

However, I prefer having one go-to solution than multiple projects, so I could instead try to add this feature to dotenv-linter which sounds more popular. Would you be interested in a PR implementing this backup feature?

This comment is also related, .env injection is a key feature of Doppler: #23 (comment)

[jblotus]

I found out by accident that passing a directory as an the first argument to compare you can compare all .env files

Windows:

dotenv-linter compare %cd% .env.example

Linux

dotenv-linter compare . .env.example

Output:

Comparing .env.dev
Comparing .env.qa
Comparing .env.local
Comparing .env.prod

Hope that helps someone