oconf - npm Package Compare versions

Comparing version 2.0.0 to 2.1.0

package.json

@@ -5,3 +5,3 @@ {
   "description": "Configuration",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "repository": {
@@ -22,6 +22,7 @@ "type": "git",
   "bin": {
-    "oconf": "bin/oconf"
+    "oconf": "bin/oconf",
+    "oconf-extract-option": "bin/oconf-extract-option"
   },
   "scripts": {
-    "coverage": "NODE_ENV=development istanbul cover -x --include-all-sources _mocha -- --reporter dot",
+    "coverage": "NODE_ENV=development istanbul cover --include-all-sources _mocha -- --reporter dot",
     "lint": "jshint . && jscs .",
@@ -28,0 +29,0 @@ "test": "mocha",

README.md

@@ -66,2 +66,48 @@ OConf
 
+Binary
+------
+
+To help resolve configuration on the command line oconf exports a CLI
+tool called oconf. In it's simplest form it takes a path to an cjson
+file, and outputs the resolved JSON object.
+
+```
+ $ oconf config.cjson
+{
+  "someConfig": "someValue",
+  "obj": {
+    "foo": "bar"
+  }
+}
+```
+
+Oconf also takes a `--lint` option. It will make oconf not output any
+of the resolved configuration, but only exit with an error in case of
+any formatting errors in the files.
+
+```
+ $ oconf --lint config.cjson
+```
+
+You can supply a path to a value as well:
+
+```
+ $ oconf config.cjson obj.foo
+"bar"
+```
+
+The output from the above is the JSON.stringified format. If you need
+to pass it into another cli program, you'd most likely want it as a
+string literal and not quoted. That can be achieved like this:
+
+```
+ $ oconf --bare config.cjson obj.foo
+bar
+```
+
+If the key is missing oconf will exit with exit code 1. If you need to
+overwrite that behaviour you can pass the `--allowmissing` flag to
+oconf which will make it exit with status code 0 if no value is found
+at the given path.
+
 Tests
@@ -68,0 +114,0 @@ -----

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

25400

5.03%

Number of package files

27

8%

Lines of code

184

6.98%

Number of lines in readme file

122

60.53%

No dependency changes