nero-env 0.1.5 → 0.1.6
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 +14 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
<img src="https://img.shields.io/github/license/alcanivorax/nero-env?color=22c55e" alt="license" />
|
|
7
7
|
</p>
|
|
8
8
|
|
|
9
|
+
<br />
|
|
10
|
+
|
|
9
11
|
<p align="center">
|
|
10
12
|
<img
|
|
11
13
|
src="https://raw.githubusercontent.com/alcanivorax/nero-env/main/assets/nero-env-preview.png"
|
|
@@ -14,21 +16,12 @@
|
|
|
14
16
|
/>
|
|
15
17
|
</p>
|
|
16
18
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
## Overview
|
|
20
|
-
|
|
21
|
-
nero-env compares your active `.env` file with `.env.example` and reports discrepancies. It helps ensure your environment configuration is complete and accurate.
|
|
22
|
-
|
|
23
|
-
**What it checks:**
|
|
19
|
+
## What is nero-env?
|
|
24
20
|
|
|
25
|
-
-
|
|
26
|
-
|
|
27
|
-
- **Unused variables** - present in `.env` but not declared in `.env.example`
|
|
21
|
+
**nero-env** is a CLI tool for validating and comparing `.env` files against `.env.example`.
|
|
22
|
+
It helps catch missing, empty, and unused environment variables early.
|
|
28
23
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
---
|
|
24
|
+
<br />
|
|
32
25
|
|
|
33
26
|
## Installation
|
|
34
27
|
|
|
@@ -38,9 +31,7 @@ Install globally using npm:
|
|
|
38
31
|
npm install -g nero-env
|
|
39
32
|
```
|
|
40
33
|
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
## Usage
|
|
34
|
+
<br/>
|
|
44
35
|
|
|
45
36
|
### Basic Usage
|
|
46
37
|
|
|
@@ -52,6 +43,8 @@ nero-env
|
|
|
52
43
|
|
|
53
44
|
This will check for `.env` and `.env.example` files in the current directory.
|
|
54
45
|
|
|
46
|
+
<br/>
|
|
47
|
+
|
|
55
48
|
### Check a Specific Project
|
|
56
49
|
|
|
57
50
|
Specify a custom path:
|
|
@@ -60,10 +53,12 @@ Specify a custom path:
|
|
|
60
53
|
nero-env --path ./apps/api
|
|
61
54
|
```
|
|
62
55
|
|
|
56
|
+
<br />
|
|
57
|
+
|
|
63
58
|
## What it checks
|
|
64
59
|
|
|
65
|
-
- **Missing** → defined in
|
|
66
|
-
- **Empty** → defined but has no value
|
|
67
|
-
- **Unused** → present in
|
|
60
|
+
- **Missing variables** → defined in `.env.example` but not in `.env`
|
|
61
|
+
- **Empty values** → defined in `.env` but has no value assigned
|
|
62
|
+
- **Unused variables** → present in `.env` but not declared in `.env.example`
|
|
68
63
|
|
|
69
64
|
Output clearly shows which file needs fixing.
|