dotenv-json-complex - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

.env.json

 {
-    "test": {
-        "cukinha": "Cuka"
+  "my_app_env": {
+    "nodeEnv": "development",
+    "api": {
+      "prefix": "/api"
+    },
+    "database": {
+      "username": "foo",
+      "password": "bar",
+      "name": "awesome_db_name",
+      "host": "my_db_host"
     }
+  }
 }

package.json

 {
   "name": "dotenv-json-complex",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Load complex enviroment variable via JSON file",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,1 +0,50 @@
-# dotenv-json-complex
+# dotenv-json-complex
+> Load complex enviroment variable via JSON file
+
+## Usage
+```bash
+npm install dotenv-json-complex
+```
+
+Create a `.env.json` file in the root of your project, like example below:
+```json
+{
+    "my_app_env": {
+      "nodeEnv": "development",
+      "api": {
+        "prefix": "/api"
+      },
+      "database": {
+        "username": "foo",
+        "password": "bar",
+        "name": "awesome_db_name",
+        "host": "my_db_host"
+      }
+    }
+}
+```
+
+After that, load your environment variables on the top of your program and parse your complex json:
+```js
+require("dotenv-json-complex")();
+
+const env = JSON.parse(process.env.my_app_env);
+
+// this will print your complex json environment!
+console.log(env)
+```
+
+```json
+{
+  "nodeEnv": "development",
+  "api": {
+    "prefix": "/api"
+  },
+  "database": {
+    "username": "foo",
+    "password": "bar",
+    "name": "awesome_db_name",
+    "host": "my_db_host"
+  }
+}
+```

New alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4739

35.55%

Number of package files

7

16.67%

Lines of code

64

20.75%

Number of lines in readme file

50

4900%

Worsened metrics

Number of low supply chain risk alerts

4

33.33%

No dependency changes