env-auto - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

package.json

 {
   "name": "env-auto",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "convert app.json in to .env",
@@ -19,3 +19,3 @@ "main": "index.js",
   ],
-   "author": {
+  "author": {
     "name": "David Gatti",
@@ -22,0 +22,0 @@ "email": "[e-mail]",

README.md

@@ -11,4 +11,62 @@ # Why this code?
 
-If you find this project useful, don't forget to give it a star :)
+# Example
 
+This is an example app.json file that you might have in your project
+
+```
+{
+	"name": "env-auto",
+	"description": "convert app.json in to .env",
+	"repository": "https://github.com",
+	"keywords": ["node", "npm"],
+	"success_url": "/",
+	"env": {
+		"NODE_ENV": {
+			"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque rhoncus sagittis urna pharetra varius. Maecenas mollis ac felis vitae blandit. Integer eu risus vehicula, pellentesque leo vel, imperdiet diam. Quisque ligula libero, aliquam ut lectus a, eleifend congue justo. Donec porttitor ultricies sem nec euismod. Fusce venenatis iaculis dapibus. Duis fringilla purus non erat lacinia tempus."
+		},
+		"NPM_CONFIG_PRODUCTION": {
+			"description": "In volutpat ex ac metus efficitur tincidunt. Fusce tempus tempus neque, id pharetra tortor vehicula ut. Donec gravida dolor ut purus dictum, sed egestas lectus bibendum. Vestibulum et augue ac arcu dapibus tincidunt. Curabitur a neque pharetra, egestas enim id, auctor mi. Suspendisse blandit facilisis arcu in tempus. Integer ut metus non est aliquam scelerisque. Nunc dolor odio, elementum eu rhoncus nec, tincidunt ac velit. Suspendisse aliquam vestibulum diam non consequat. Phasellus aliquet neque in tellus iaculis iaculis. Pellentesque vitae massa lacus. In id erat et est vestibulum mollis. Vivamus scelerisque placerat urna nec ultrices. Nunc ac dictum tellus.",
+			"value": "true"
+		},
+		"API_KEY": {
+			"description": "Quisque justo odio, pretium a ante ac, mattis pharetra lectus. Cras erat velit, tincidunt sit amet est aliquet, pellentesque commodo massa. Duis ultrices purus dui, nec consectetur odio pellentesque sed. Etiam ipsum ex, euismod accumsan velit vitae, varius commodo arcu. Aliquam malesuada commodo lorem in tempor. Nam ut dui purus. Phasellus ornare maximus magna ac sollicitudin. Sed nec felis nibh. Nullam maximus pharetra dui, quis sodales est pretium nec.",
+			"generator": "secret"
+		}
+	}
+}
+```
+And this will be the output of such file
+
+```
+# Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque rhoncus
+# sagittis urna pharetra varius. Maecenas mollis ac felis vitae blandit.
+# Integer eu risus vehicula, pellentesque leo vel, imperdiet diam. Quisque
+# ligula libero, aliquam ut lectus a, eleifend congue justo. Donec porttitor
+# ultricies sem nec euismod. Fusce venenatis iaculis dapibus. Duis fringilla
+# purus non erat lacinia tempus.
+NODE_ENV=
+
+# In volutpat ex ac metus efficitur tincidunt. Fusce tempus tempus neque, id
+# pharetra tortor vehicula ut. Donec gravida dolor ut purus dictum, sed egestas
+# lectus bibendum. Vestibulum et augue ac arcu dapibus tincidunt. Curabitur a
+# neque pharetra, egestas enim id, auctor mi. Suspendisse blandit facilisis
+# arcu in tempus. Integer ut metus non est aliquam scelerisque. Nunc dolor
+# odio, elementum eu rhoncus nec, tincidunt ac velit. Suspendisse aliquam
+# vestibulum diam non consequat. Phasellus aliquet neque in tellus iaculis
+# iaculis. Pellentesque vitae massa lacus. In id erat et est vestibulum mollis.
+# Vivamus scelerisque placerat urna nec ultrices. Nunc ac dictum tellus.
+NPM_CONFIG_PRODUCTION=
+
+# Quisque justo odio, pretium a ante ac, mattis pharetra lectus. Cras erat
+# velit, tincidunt sit amet est aliquet, pellentesque commodo massa. Duis
+# ultrices purus dui, nec consectetur odio pellentesque sed. Etiam ipsum ex,
+# euismod accumsan velit vitae, varius commodo arcu. Aliquam malesuada commodo
+# lorem in tempor. Nam ut dui purus. Phasellus ornare maximus magna ac
+# sollicitudin. Sed nec felis nibh. Nullam maximus pharetra dui, quis sodales
+# est pretium nec.
+API_KEY=
+```
+
+As you can see the description will be nicely formated, and the variable ready to be used.
+
 ## Installation
@@ -20,2 +78,5 @@
     $ npm install env-auto -g
-```
+```
+# Favor
+
+If you find this project useful, don't forget to give it a star :)

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9987

59.72%

Number of lines in readme file

80

321.05%

No dependency changes