confme - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

package.json

 {
   "name": "confme",
-  "version": "0.0.6",
-  "description": "Opinionated config library that allows you to have complex config and behaves according to 12-factor app rules ",
+  "version": "0.0.7",
+  "description": "Opinionated config library that allows you to have complex config and behaves according to Twelve Factor App rules",
   "main": "src/confme.js",
@@ -25,4 +25,6 @@ "directories": {
     "json",
-    "twelve factors",
-    "12 factors"
+    "livr",
+    "config validation",
+    "twelve factor app",
+    "12 factor app"
   ],
@@ -29,0 +31,0 @@ "author": "koorchik",

README.md

@@ -9,2 +9,4 @@ ## confme
 
+Read [Motivation section](#Motivation)
+
 ### How does it work?
@@ -77,2 +79,3 @@
 ```
+You can play with it [in livr playground](http://webbylab.github.io/livr-playground/#%7B%22rules%22%3A%22%7B%5Cn%20%20%5C%22listenPort%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%5C%22positive_integer%5C%22%5D%2C%5Cn%20%20%5C%22apiPath%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%5C%22url%5C%22%5D%2C%5Cn%20%20%5C%22staticUrl%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%5C%22url%5C%22%5D%2C%5Cn%20%20%5C%22mainPage%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%5C%22url%5C%22%5D%2C%5Cn%20%20%5C%22mail%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%7B%5C%22nested_object%5C%22%3A%20%7B%5Cn%20%20%20%5C%22from%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%5C%22string%5C%22%5D%2C%5Cn%20%20%20%5C%22transport%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%7B%5C%22one_of%5C%22%3A%20%5B%5C%22SMTP%5C%22%2C%20%5C%22SENDMAIL%5C%22%5D%7D%5D%2C%5Cn%20%20%20%20%5C%22auth%5C%22%3A%20%7B%5C%22nested_object%5C%22%3A%20%7B%5Cn%20%20%20%20%20%20%5C%22user%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%5C%22string%5C%22%5D%2C%5Cn%20%20%20%20%20%20%5C%22pass%5C%22%3A%20%5B%5C%22required%5C%22%2C%20%5C%22string%5C%22%5D%5Cn%20%20%20%20%7D%7D%5Cn%20%20%7D%7D%5D%5Cn%7D%22%2C%22data%22%3A%22%7B%20%5Cn%20%20listenPort%3A%203000%2C%5Cn%20%20apiPath%3A%20'https%3A%2F%2Flocalhost%3A3000%2Fapi%2Fv1'%2C%5Cn%20%20staticUrl%3A%20'https%3A%2F%2Flocalhost%3A3000%2Fstatic'%2C%5Cn%20%20mainPage%3A%20'https%3A%2F%2Flocalhost%3A3000'%2C%5Cn%20%20mail%3A%20%7B%20from%3A%20'MyApp'%2C%5Cn%20%20%20%20%20transport%3A%20'SMTP'%2C%5Cn%20%20%20%20%20auth%3A%20%7B%20%5Cn%20%20%20%20%20%20%20%20user%3A%20'user'%2C%20%5Cn%20%20%20%20%20%20%20%20pass%3A%20'password'%20%5Cn%20%20%20%20%20%20%7D%20%5Cn%20%20%20%7D%20%5Cn%7D%5Cn%22%7D) 
 
@@ -86,1 +89,15 @@ **Full example in [examples folder](./examples).**
 - `PORT='AAA' node app.js`
+
+
+### Motivation
+
+According to [Twelve Factor App](https://12factor.net/config) your config should be passed in envrironment variables. If you are not familiar with ideas of "Twelve Factor App" you definetely should read it.
+
+Having all config variables in env variables is very flexible. You can run your app with docker and without docker. Moreover, you can reuse the same builds across all environments. For example, you can build an image, test it on QA and then run the same image well-tested imaged on production.  
+
+But passing the conf in environment variables is not very convenient. So, there a popular library called [dotenv](dotenv) which allows you to store environment variables in ".env" file. But you should not commit it and you should have a sample in repository (like ".env.sample" which will be copied to ".env" on deployments without docker).
+You can use [dotenv-defaults](https://www.npmjs.com/package/dotenv-defaults) which allows you to have file ".env.defaults" with default values commited to your repository. 
+
+But in real life you have rather complex configs and you do not want to define all of the values in ENV, you want to use your config as a template and build final config based on this template. It is very common approach for ansible users. **confme** allowes to do that.
+
+Moreover, **confme** allowes you to define LIVR schema to validate config. It can be heplful if you have complex configs with a lot of options but I prefer to use validation schema even with small configs.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9984

increased by76.99%

Number of package files

9

increased by12.5%

Number of lines in readme file

101

increased by20.24%

No dependency changes