@awesomeeng/awesome-config - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

.eslintrc.js

@@ -0,0 +0,0 @@ "use strict";

docs/API.md

@@ -5,4 +5,59 @@ <a name="AwesomeConfig"></a>
 **Kind**: global namespace  
-**Summary**: The AwesomeConfig Object.

The AwesomeConfig Object returned whenever you
`require("@awesomeeng/awesome-config")` or
`require("@awesomeeng/awesome-config")("namespace")`.

Once required, config can be referenced in one of two ways:

 1. To reference config management functions, you first call config
 as a function: `config().xyz`

 2. To reference config values, which we will see below, you reference
 config as an object: `config.xyz`

To use AwesomeConfig begin by calling `config().init()`.

```
let config = require("@awesomeeng/awesome-config");
config().init();
```

Once initialized you can add configuration details to the config object.

```
let config = require("@awesomeeng/awesome-config");
config().init();
config().add(...);
```

You can add config in a variety of ways:

- **config().add(object)** - You may add a plain JavaScript object as
  configuration and it will be merged with the configuration.

- **config().add(string)** - You may add a string as configuration data
  and it will be run through the configuration parser and the
  resulting data will be merged with the configuration.

- **config().add(filename)** - You may add a fully resolved filename and
  the content of the file will be read in, run through the
  configuration parser, and the resulting data will be merged
  with the configuration.

- **config().add(directory)** - You may add a fully resolved directory and
  the directory will be examined for .config files. If any are
  found, each file will be read ine, run through the configuration
  parser, and the resulting data will be merged with the
  configuration.

After all your configuration has been added, you can start config with
`config().start()`. Once config has been started, you cannot add any more
confguration properties to it, so make sure everything is added before
starting.

Please see (AwesomeConfig's documentation)[https://github.com/awesomeeng/AwesomeConfig]
for more details.  
+**Summary**: The AwesomeConfig Object.
 
+The AwesomeConfig Object returned whenever you
+`require("@awesomeeng/awesome-config")` or
+`require("@awesomeeng/awesome-config")("namespace")`.
+
+Once required, config can be referenced in one of two ways:
+
+ 1. To reference config management functions, you first call config
+ as a function: `config().xyz`
+
+ 2. To reference config values, which we will see below, you reference
+ config as an object: `config.xyz`
+
+To use AwesomeConfig begin by calling `config().init()`.
+
+```
+let config = require("@awesomeeng/awesome-config");
+config().init();
+```
+
+Once initialized you can add configuration details to the config object.
+
+```
+let config = require("@awesomeeng/awesome-config");
+config().init();
+config().add(...);
+```
+
+You can add config in a variety of ways:
+
+- **config().add(object)** - You may add a plain JavaScript object as
+  configuration and it will be merged with the configuration.
+
+- **config().add(string)** - You may add a string as configuration data
+  and it will be run through the configuration parser and the
+  resulting data will be merged with the configuration.
+
+- **config().add(filename)** - You may add a fully resolved filename and
+  the content of the file will be read in, run through the
+  configuration parser, and the resulting data will be merged
+  with the configuration.
+
+- **config().add(directory)** - You may add a fully resolved directory and
+  the directory will be examined for .config files. If any are
+  found, each file will be read ine, run through the configuration
+  parser, and the resulting data will be merged with the
+  configuration.
+
+After all your configuration has been added, you can start config with
+`config().start()`. Once config has been started, you cannot add any more
+confguration properties to it, so make sure everything is added before
+starting.
+
+Please see (AwesomeConfig's documentation)[https://github.com/awesomeeng/AwesomeConfig]
+for more details.  
+
 * [AwesomeConfig](#AwesomeConfig) : <code>object</code>
@@ -42,3 +97,4 @@ * [.initialized](#AwesomeConfig.initialized) ⇒ <code>boolean</code>
 ### AwesomeConfig.sources ⇒ <code>Array.&lt;string&gt;</code>
-Returns an Array of String with each string representing the origin of
each configuration that was added via `config().add(...)`.
+Returns an Array of String with each string representing the origin of
+each configuration that was added via `config().add(...)`.
 
@@ -52,4 +108,19 @@ **Kind**: static property of [<code>AwesomeConfig</code>](#AwesomeConfig)
 ### AwesomeConfig.init() ⇒ [<code>AwesomeConfig</code>](#AwesomeConfig)
-Initialize AwesomeConfig for usage. To call this method must be
done by callign your config object as a method and then chaining
the `init` function from that, as shown here:

```
config().init();
```

Calling this method indicates to AwesomeConfig that you are ready
to start adding configuration via `config().add(...)`, but not
yet ready to use it.  In order to start using config, call
`config().start()` to signal that you are ready to start
accessing configuration.

Subsequent calls to `init` will not have any effect, only the
first `config().init()`
+Initialize AwesomeConfig for usage. To call this method must be
+done by callign your config object as a method and then chaining
+the `init` function from that, as shown here:
 
+```
+config().init();
+```
+
+Calling this method indicates to AwesomeConfig that you are ready
+to start adding configuration via `config().add(...)`, but not
+yet ready to use it.  In order to start using config, call
+`config().start()` to signal that you are ready to start
+accessing configuration.
+
+Subsequent calls to `init` will not have any effect, only the
+first `config().init()`
+
 **Kind**: static method of [<code>AwesomeConfig</code>](#AwesomeConfig)  
@@ -62,4 +133,22 @@
 ### AwesomeConfig.start() ⇒ [<code>AwesomeConfig</code>](#AwesomeConfig)
-Signal to AwesomeConfig that all configuration has been added via
`config().add(...)` and you are ready to start accessing configuration.

Start actually performs several function important to understanding config:

First, it takes all added configurations and merges them into a single
unified view.  This takes into account the order in which configuration
was added with later adds overwriting earlier adds.

Also, only configurations whose conditions resolve truthy are merged.

Second, after merging, all variables are resolved and any variable that
does not resolve throws an exception.

Third, after variable resolution, all values are checked for placeholders.
If any placeholders are found, an exception is thrown.

Once all three of these actions are done and so long as no exceptions
were thrown, your configuration is now available for usage.
+Signal to AwesomeConfig that all configuration has been added via
+`config().add(...)` and you are ready to start accessing configuration.
 
+Start actually performs several function important to understanding config:
+
+First, it takes all added configurations and merges them into a single
+unified view.  This takes into account the order in which configuration
+was added with later adds overwriting earlier adds.
+
+Also, only configurations whose conditions resolve truthy are merged.
+
+Second, after merging, all variables are resolved and any variable that
+does not resolve throws an exception.
+
+Third, after variable resolution, all values are checked for placeholders.
+If any placeholders are found, an exception is thrown.
+
+Once all three of these actions are done and so long as no exceptions
+were thrown, your configuration is now available for usage.
+
 **Kind**: static method of [<code>AwesomeConfig</code>](#AwesomeConfig)  
@@ -72,3 +161,5 @@
 ### AwesomeConfig.stop() ⇒ [<code>AwesomeConfig</code>](#AwesomeConfig)
-Takes AwesomeConfig out of started mode an allows for more configurations
to be added via `config().add(...)`. `config().start()` can then be called
again to begin using config.
+Takes AwesomeConfig out of started mode an allows for more configurations
+to be added via `config().add(...)`. `config().start()` can then be called
+again to begin using config.
 
@@ -82,4 +173,27 @@ **Kind**: static method of [<code>AwesomeConfig</code>](#AwesomeConfig)
 ### AwesomeConfig.add(content, defaultConditions) ⇒ [<code>AwesomeConfig</code>](#AwesomeConfig)
-The `config()add()` method has four different usage forms, each unique in thier
own right:

- **config().add(object)** - You may add a plain JavaScript object as
  configuration and it will be merged with the configuration.

- **config().add(string)** - You may add a string as configuration data
  and it will be run through the configuration parser and the
  resulting data will be merged with the configuration.

- **config().add(filename)** - You may add a fully resolved filename and
  the content of the file will be read in, run through the
  configuration parser, and the resulting data will be merged
  with the configuration.

- **config().add(directory)** - You may add a fully resolved directory and
  the directory will be examined for .config files. If any are
  found, each file will be read ine, run through the configuration
  parser, and the resulting data will be merged with the
  configuration.

You may pass an optional string of *conditions* to add that will be
applied to determining if the content is merged or not.  See the
conditions section for a lot more details about how they work.
+The `config()add()` method has four different usage forms, each unique in thier
+own right:
 
+- **config().add(object)** - You may add a plain JavaScript object as
+  configuration and it will be merged with the configuration.
+
+- **config().add(string)** - You may add a string as configuration data
+  and it will be run through the configuration parser and the
+  resulting data will be merged with the configuration.
+
+- **config().add(filename)** - You may add a fully resolved filename and
+  the content of the file will be read in, run through the
+  configuration parser, and the resulting data will be merged
+  with the configuration.
+
+- **config().add(directory)** - You may add a fully resolved directory and
+  the directory will be examined for .config files. If any are
+  found, each file will be read ine, run through the configuration
+  parser, and the resulting data will be merged with the
+  configuration.
+
+You may pass an optional string of *conditions* to add that will be
+applied to determining if the content is merged or not.  See the
+conditions section for a lot more details about how they work.
+
 **Kind**: static method of [<code>AwesomeConfig</code>](#AwesomeConfig)  
@@ -98,3 +212,4 @@
 ### AwesomeConfig.reset() ⇒ [<code>AwesomeConfig</code>](#AwesomeConfig)
-`config().reset()` can be called when AwesomeConfig is initialized but stopped
to remove all prior configuration. It creates a completely clean slate.
+`config().reset()` can be called when AwesomeConfig is initialized but stopped
+to remove all prior configuration. It creates a completely clean slate.
 
@@ -101,0 +216,0 @@ **Kind**: static method of [<code>AwesomeConfig</code>](#AwesomeConfig)

docs/Conditions.md

@@ -0,0 +0,0 @@ # [AwesomeConfig](../README.md) > Condition Expressions

docs/Merging.md

@@ -0,0 +0,0 @@ # [AwesomeConfig](../README.md) > Understanding Merging

docs/VariablesAndPlaceholders.md

@@ -0,0 +0,0 @@ # [AwesomeConfig](../README.md) > Variables and Placeholders

examples/AddDirectory/.eslintrc.js

@@ -0,0 +0,0 @@ "use strict";

examples/AddDirectory/entry.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

examples/AddDirectory/package.json

@@ -0,0 +0,0 @@ {

examples/AddFiles/.eslintrc.js

@@ -0,0 +0,0 @@ "use strict";

examples/AddFiles/entry.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

examples/AddFiles/package.json

@@ -0,0 +0,0 @@ {

examples/Namespaces/.eslintrc.js

@@ -0,0 +0,0 @@ "use strict";

examples/Namespaces/entry.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

examples/Namespaces/module1.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

examples/Namespaces/module2.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

examples/Namespaces/module3.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

examples/Namespaces/package.json

@@ -0,0 +0,0 @@ {

examples/VarsPlaceholdersConditions/.eslintrc.js

@@ -0,0 +0,0 @@ "use strict";

examples/VarsPlaceholdersConditions/entry.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

examples/VarsPlaceholdersConditions/package.json

@@ -0,0 +0,0 @@ {

package.json

 {
   "name": "@awesomeeng/awesome-config",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "author": "the awesome engineering company",
@@ -14,4 +14,4 @@ "license": "MIT",
   "dependencies": {
-    "@awesomeeng/awesome-log": "^2.1.0",
-    "@awesomeeng/awesome-utils": "^1.2.0"
+    "@awesomeeng/awesome-log": "^3.0.2",
+    "@awesomeeng/awesome-utils": "^1.4.7"
   },
@@ -24,4 +24,6 @@ "devDependencies": {
   "scripts": {
+    "lint": "eslint src examples test",
     "docs": "jsdoc2md src/** --separators > docs/API.md",
-	"tests": "mocha test"
+    "test": "mocha test",
+    "tests": "mocha test"
   },
@@ -28,0 +30,0 @@ "description": "AwesomeConfig is a powerful configuration system for building enterprise ready node.js application. It provides a unified transparent configuration object to your application based on configuration files or objects that you define.  It includes support for conditional configuration based on external values like environment variables, hostname, or OS; variables to reference one part of your configuration from another; and lots more.",

README.md

@@ -0,0 +0,0 @@ # AwesomeConfig

RELEASE_NOTES.md

 # AwesomeConfig Release Notes
 
+#### **Version 1.0.2**
+
+ - Updating API docs.
+
+ - Updating external dependency versions.
+
 #### **Version 1.0.1**
@@ -4,0 +10,0 @@

src/AwesomeConfig.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/AbstractCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/AndCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/BooleanCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/FalseCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/GroupCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/NotCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/NumberCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/OrCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/StringCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/conditions/TrueCondition.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/ConfigConditionParser.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/ConfigInstance.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/ConfigParser.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/ConfigResolver.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/ConfigSource.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

src/SpecialStrings.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

test/ConditionsTest.js

@@ -0,0 +0,0 @@

test/ConfigTest.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

test/ConfigTestModule.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

test/ParserTest.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

test/ResolverTest.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

test/SpecialStringsTest.js

@@ -0,0 +0,0 @@ // (c) 2018, The Awesome Engineering Company, https://awesomeneg.com

No alert changes

Worsened metrics

Total package byte prevSize

138934

decreased by-3.13%

Dependency changes

• + Added@awesomeeng/awesome-log@3.2.2(transitive)

• - Removed@awesomeeng/awesome-log@2.1.2(transitive)

• Updated@awesomeeng/awesome-log@^3.0.2

• Updated@awesomeeng/awesome-utils@^1.4.7