dotenv-diff 1.1.2 → 1.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,51 @@
|
|
|
1
|
-
# dotenv
|
|
1
|
+
# dotenv-diff
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
Easily compare your `.env` and `.env.example` files in Node.js projects to detect missing, extra, empty, or mismatched environment variables.
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/dotenv-diff)
|
|
8
|
+
[](https://www.npmjs.com/package/dotenv-diff)
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
# npm
|
|
16
|
+
npm install -g dotenv-diff
|
|
17
|
+
|
|
18
|
+
# yarn
|
|
19
|
+
yarn global add dotenv-diff
|
|
20
|
+
|
|
21
|
+
# pnpm
|
|
22
|
+
pnpm add -g dotenv-diff
|
|
23
|
+
```
|
|
24
|
+
## Usage
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
dotenv-diff
|
|
28
|
+
```
|
|
29
|
+
## Compares .env and .env.example in the current working directory and checks for:
|
|
30
|
+
- Missing variables in `.env.example`
|
|
31
|
+
- Extra variables in `.env`
|
|
32
|
+
- Empty variables in `.env`
|
|
33
|
+
- Mismatched values between `.env` and `.env.example`
|
|
34
|
+
|
|
35
|
+
## Optional: Check values too
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
dotenv-diff --check-values
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
When using the `--check-values` option, the tool will also compare the actual values of the variables in `.env` and `.env.example`. It will report any mismatches found and it also compares values if .env.example defines a non-empty expected value.
|
|
42
|
+
|
|
43
|
+
## 🤝 Contributing
|
|
44
|
+
|
|
45
|
+
Contributions are welcome! Feel free to open an issue or a pull request.
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
MIT
|
|
50
|
+
|
|
51
|
+
### Created by [chrilleweb](https://github.com/chrilleweb)
|