@rotty3000/config-node 0.3.5 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/dist/config-node/index.js +46 -11
- package/dist/config-node/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -56,6 +56,10 @@ The following configuration providers are pre-packaged and searched in order of
|
|
|
56
56
|
defaultConfig('my.custom.config', 'some value');
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
+
## Interpolation of placeholders in config values
|
|
60
|
+
|
|
61
|
+
When a value returned from a lookup contains a placeholder of the form `${key}` the `key` will be looked up and its value, if found, will replace the placeholder. A single value may contain multiple placeholders and it is also possible to have nested placeholders. For example; given the two environment variables `VAR_ONE="env var one value"` and `VAR_TWO="ONE"`, a third property `nested.placeholder=${VAR_${VAR_TWO}}` would result in the value `env var one value`.
|
|
62
|
+
|
|
59
63
|
## Structure of JSON configuration
|
|
60
64
|
|
|
61
65
|
The configuration JSON structure expects keys to be at the root, as follows:
|
|
@@ -23,8 +23,11 @@ class ConfigProviderHolder {
|
|
|
23
23
|
this.cache = new Map;
|
|
24
24
|
}
|
|
25
25
|
}
|
|
26
|
+
class KeyProviderPair {
|
|
27
|
+
}
|
|
26
28
|
const configProviderHolders = [];
|
|
27
29
|
const commonCache = new Map();
|
|
30
|
+
const stack = [];
|
|
28
31
|
/**
|
|
29
32
|
* Register one or more configuration providers.
|
|
30
33
|
*
|
|
@@ -61,21 +64,36 @@ exports.defaultConfig = defaultConfig;
|
|
|
61
64
|
function lookupConfig(key) {
|
|
62
65
|
let value;
|
|
63
66
|
for (var holder of configProviderHolders) {
|
|
64
|
-
|
|
65
|
-
if (
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
67
|
+
const pair = { key, provider: holder.provider };
|
|
68
|
+
if (stack.find(p => p.key === pair.key && p.provider === pair.provider)) {
|
|
69
|
+
continue;
|
|
70
|
+
}
|
|
71
|
+
stack.push(pair);
|
|
72
|
+
try {
|
|
73
|
+
value = holder.provider.get(key, holder.cache, commonCache);
|
|
74
|
+
if (value) {
|
|
75
|
+
if (Array.isArray(value)) {
|
|
76
|
+
if (value.length > 0 && typeof value[0] === 'string') {
|
|
77
|
+
value = value;
|
|
78
|
+
}
|
|
79
|
+
else {
|
|
80
|
+
value = [];
|
|
81
|
+
}
|
|
82
|
+
value = value.map(v => _interpolatePlaceholders(v));
|
|
83
|
+
}
|
|
84
|
+
else if (typeof value !== 'string') {
|
|
85
|
+
value = JSON.stringify(value);
|
|
86
|
+
value = _interpolatePlaceholders(value);
|
|
69
87
|
}
|
|
70
88
|
else {
|
|
71
|
-
value =
|
|
89
|
+
value = _interpolatePlaceholders(value);
|
|
72
90
|
}
|
|
91
|
+
util_1.verbose && console.debug(`Provider [${holder.provider.description}] returned:`, value);
|
|
92
|
+
return value;
|
|
73
93
|
}
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
util_1.verbose && console.debug(`Provider [${holder.provider.description}] returned:`, value);
|
|
78
|
-
return value;
|
|
94
|
+
}
|
|
95
|
+
finally {
|
|
96
|
+
stack.pop();
|
|
79
97
|
}
|
|
80
98
|
}
|
|
81
99
|
}
|
|
@@ -89,5 +107,22 @@ function _compareProviders(a, b) {
|
|
|
89
107
|
}
|
|
90
108
|
return 0;
|
|
91
109
|
}
|
|
110
|
+
function _interpolatePlaceholders(v) {
|
|
111
|
+
const regex = /\$\{[^\$]+?\}/;
|
|
112
|
+
let match = regex.exec(v);
|
|
113
|
+
while (match) {
|
|
114
|
+
util_1.verbose && console.debug("Match:", match);
|
|
115
|
+
const key = match[0].slice(2, -1);
|
|
116
|
+
const lookedUpValue = lookupConfig(key);
|
|
117
|
+
if (lookedUpValue) {
|
|
118
|
+
v = v.replace(match[0], lookedUpValue);
|
|
119
|
+
match = regex.exec(v);
|
|
120
|
+
}
|
|
121
|
+
else {
|
|
122
|
+
match = undefined;
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
return v;
|
|
126
|
+
}
|
|
92
127
|
addProvider(_11000_config_node_devtools_1.configNodeDevtools, _10000_cli_1.cli, _9000_cli_application_json_1.cliApplicationJson, _8000_env_application_json_1.envApplicationJson, _7000_individual_env_vars_1.individualEnvVars, _6000_config_trees_1.configTrees, _5000_application_profile_config_1.applicationProfileConfig, _4000_application_profile_1.applicationProfile, _3000_application_config_1.applicationConfig, _2000_application_1.application, _1000_application_packaged_1.applicationPackaged, _0000_programmatic_1.programmatic);
|
|
93
128
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config-node/index.ts"],"names":[],"mappings":";;;AACA,wFAA0E;AAC1E,sDAA0C;AAC1C,sFAAyE;AACzE,sFAAyE;AACzE,oFAAuE;AACvE,sEAA0D;AAC1D,kGAAqF;AACrF,oFAAwE;AACxE,kFAAsE;AACtE,oEAAyD;AACzD,sFAA0E;AAC1E,sEAA2D;AAC3D,iCAA4D;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/config-node/index.ts"],"names":[],"mappings":";;;AACA,wFAA0E;AAC1E,sDAA0C;AAC1C,sFAAyE;AACzE,sFAAyE;AACzE,oFAAuE;AACvE,sEAA0D;AAC1D,kGAAqF;AACrF,oFAAwE;AACxE,kFAAsE;AACtE,oEAAyD;AACzD,sFAA0E;AAC1E,sEAA2D;AAC3D,iCAA4D;AAsJ3B,gGAtJzB,sBAAe,OAsJyB;AAA+C,2FAtJtE,iBAAU,OAsJsE;AApJzG,MAAM,oBAAoB;IAKxB,YAAY,QAAwB;QAClC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAA;QACtC,IAAI,CAAC,KAAK,GAAG,IAAI,GAAgB,CAAC;IACpC,CAAC;CACF;AAED,MAAM,eAAe;CAGpB;AAED,MAAM,qBAAqB,GAA2B,EAAE,CAAC;AACzD,MAAM,WAAW,GAAG,IAAI,GAAG,EAAe,CAAC;AAC3C,MAAM,KAAK,GAAsB,EAAE,CAAC;AAEpC;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAAG,SAA2B;IACjD,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,IAAI,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC9F,qBAAqB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;AAChD,CAAC;AAuHO,kCAAW;AArHnB;;GAEG;AACH,SAAS,UAAU;IACjB,qBAAqB,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IAC9E,WAAW,CAAC,KAAK,EAAE,CAAC;AACtB,CAAC;AA+GoB,gCAAU;AA7G/B;;;;;GAKG;AACH,SAAS,aAAa,CAAC,GAAW,EAAE,KAAU;IAC5C,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAC9B,CAAC;AAqGiE,sCAAa;AAnG/E;;;;GAIG;AACH,SAAS,YAAY,CAAC,GAAW;IAC/B,IAAI,KAAU,CAAC;IAEf,KAAK,IAAI,MAAM,IAAI,qBAAqB,EAAE,CAAC;QACzC,MAAM,IAAI,GAAG,EAAC,GAAG,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAC,CAAC;QAE9C,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,QAAQ,KAAK,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxE,SAAS;QACX,CAAC;QAED,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEjB,IAAI,CAAC;YACH,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YAE5D,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;oBACzB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;wBACrD,KAAK,GAAG,KAAiB,CAAC;oBAC5B,CAAC;yBACI,CAAC;wBACJ,KAAK,GAAG,EAAc,CAAC;oBACzB,CAAC;oBAED,KAAK,GAAI,KAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpE,CAAC;qBACI,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACnC,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;oBAE9B,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;gBAC1C,CAAC;qBACI,CAAC;oBACJ,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;gBAC1C,CAAC;gBAED,cAAO,IAAI,OAAO,CAAC,KAAK,CAAC,aAAa,MAAM,CAAC,QAAQ,CAAC,WAAW,aAAa,EAAE,KAAK,CAAC,CAAC;gBAEvF,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;gBACO,CAAC;YACP,KAAK,CAAC,GAAG,EAAE,CAAC;QACd,CAAC;IACH,CAAC;AACH,CAAC;AAkDgF,oCAAY;AAhD7F,SAAS,iBAAiB,CAAC,CAAuB,EAAE,CAAuB;IACzE,IAAI,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC5B,OAAO,CAAC,CAAC;IACX,CAAC;IACD,IAAI,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC5B,OAAO,CAAC,CAAC,CAAC;IACZ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,wBAAwB,CAAC,CAAS;IACzC,MAAM,KAAK,GAAG,eAAe,CAAC;IAE9B,IAAI,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAE1B,OAAO,KAAK,EAAE,CAAC;QACb,cAAO,IAAI,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QAE1C,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAClC,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAW,CAAC;QAElD,IAAI,aAAa,EAAE,CAAC;YAClB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAA;YACtC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACxB,CAAC;aACI,CAAC;YACJ,KAAK,GAAG,SAAS,CAAC;QACpB,CAAC;IACH,CAAC;IAED,OAAO,CAAC,CAAC;AACX,CAAC;AAED,WAAW,CACT,gDAAkB,EAClB,gBAAG,EACH,+CAAkB,EAClB,+CAAkB,EAClB,6CAAiB,EACjB,gCAAW,EACX,2DAAwB,EACxB,8CAAkB,EAClB,4CAAiB,EACjB,+BAAW,EACX,gDAAmB,EACnB,iCAAY,CACb,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rotty3000/config-node",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "A library for obtaining external configuration for your application.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -45,4 +45,4 @@
|
|
|
45
45
|
"url": "https://github.com/rotty3000/config-node/issues"
|
|
46
46
|
},
|
|
47
47
|
"homepage": "https://github.com/rotty3000/config-node#readme"
|
|
48
|
-
}
|
|
48
|
+
}
|