@push.rocks/qenv 6.0.5 → 6.0.7
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/dist_ts/00_commitinfo_data.d.ts +1 -1
- package/dist_ts/00_commitinfo_data.js +4 -4
- package/dist_ts/qenv.classes.qenv.d.ts +1 -1
- package/dist_ts/qenv.classes.qenv.js +22 -5
- package/npmextra.json +15 -3
- package/package.json +11 -7
- package/readme.hints.md +1 -0
- package/readme.md +109 -36
- package/ts/00_commitinfo_data.ts +3 -3
- package/ts/qenv.classes.qenv.ts +25 -4
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* autocreated commitinfo by @
|
|
2
|
+
* autocreated commitinfo by @push.rocks/commitinfo
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@push.rocks/qenv',
|
|
6
|
-
version: '6.0.
|
|
7
|
-
description: '
|
|
6
|
+
version: '6.0.7',
|
|
7
|
+
description: 'A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.'
|
|
8
8
|
};
|
|
9
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
9
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSxrQkFBa0I7SUFDeEIsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLHVIQUF1SDtDQUNySSxDQUFBIn0=
|
|
@@ -23,7 +23,7 @@ export declare class Qenv {
|
|
|
23
23
|
private tryGetEnvVar;
|
|
24
24
|
private tryGetEnvVarSync;
|
|
25
25
|
private getFromEnvironmentVariable;
|
|
26
|
-
private
|
|
26
|
+
private getFromEnvYamlOrJsonFile;
|
|
27
27
|
private getFromDockerSecret;
|
|
28
28
|
private getFromDockerSecretJson;
|
|
29
29
|
private encodeBase64;
|
|
@@ -16,7 +16,24 @@ export class Qenv {
|
|
|
16
16
|
initializeFilePaths(qenvFileBasePathArg, envFileBasePathArg) {
|
|
17
17
|
this.qenvFilePathAbsolute = plugins.path.join(plugins.path.resolve(qenvFileBasePathArg), 'qenv.yml');
|
|
18
18
|
if (envFileBasePathArg) {
|
|
19
|
-
this.envFilePathAbsolute = plugins.path.join(plugins.path.resolve(envFileBasePathArg), 'env.json');
|
|
19
|
+
const envFileJsonPath = this.envFilePathAbsolute = plugins.path.join(plugins.path.resolve(envFileBasePathArg), 'env.json');
|
|
20
|
+
const envFileYmlPath = this.envFilePathAbsolute = plugins.path.join(plugins.path.resolve(envFileBasePathArg), 'env.yml');
|
|
21
|
+
const envFileYamlPath = this.envFilePathAbsolute = plugins.path.join(plugins.path.resolve(envFileBasePathArg), 'env.yaml');
|
|
22
|
+
const envFileJsonExists = plugins.smartfile.fs.fileExistsSync(envFileJsonPath);
|
|
23
|
+
const envFileYmlExists = plugins.smartfile.fs.fileExistsSync(envFileYmlPath);
|
|
24
|
+
const envFileYamlExists = plugins.smartfile.fs.fileExistsSync(envFileYamlPath);
|
|
25
|
+
if (envFileJsonExists && (envFileYamlExists || envFileYmlExists)) {
|
|
26
|
+
this.logger.log('warn', 'Both env.json and env.yml files exist! Using env.json');
|
|
27
|
+
}
|
|
28
|
+
else if (envFileJsonExists) {
|
|
29
|
+
this.envFilePathAbsolute = envFileJsonPath;
|
|
30
|
+
}
|
|
31
|
+
else if (envFileYmlExists) {
|
|
32
|
+
this.envFilePathAbsolute = envFileYmlPath;
|
|
33
|
+
}
|
|
34
|
+
else if (envFileYamlExists) {
|
|
35
|
+
this.envFilePathAbsolute = envFileYamlPath;
|
|
36
|
+
}
|
|
20
37
|
}
|
|
21
38
|
}
|
|
22
39
|
loadRequiredEnvVars() {
|
|
@@ -95,20 +112,20 @@ export class Qenv {
|
|
|
95
112
|
return await envVarRefArg();
|
|
96
113
|
}
|
|
97
114
|
return (this.getFromEnvironmentVariable(envVarRefArg) ||
|
|
98
|
-
this.
|
|
115
|
+
this.getFromEnvYamlOrJsonFile(envVarRefArg) ||
|
|
99
116
|
this.getFromDockerSecret(envVarRefArg) ||
|
|
100
117
|
this.getFromDockerSecretJson(envVarRefArg));
|
|
101
118
|
}
|
|
102
119
|
tryGetEnvVarSync(envVarName) {
|
|
103
120
|
return (this.getFromEnvironmentVariable(envVarName) ||
|
|
104
|
-
this.
|
|
121
|
+
this.getFromEnvYamlOrJsonFile(envVarName) ||
|
|
105
122
|
this.getFromDockerSecret(envVarName) ||
|
|
106
123
|
this.getFromDockerSecretJson(envVarName));
|
|
107
124
|
}
|
|
108
125
|
getFromEnvironmentVariable(envVarName) {
|
|
109
126
|
return process.env[envVarName];
|
|
110
127
|
}
|
|
111
|
-
|
|
128
|
+
getFromEnvYamlOrJsonFile(envVarName) {
|
|
112
129
|
if (!plugins.smartfile.fs.fileExistsSync(this.envFilePathAbsolute)) {
|
|
113
130
|
return undefined;
|
|
114
131
|
}
|
|
@@ -156,4 +173,4 @@ export class Qenv {
|
|
|
156
173
|
return JSON.parse(decodedString);
|
|
157
174
|
}
|
|
158
175
|
}
|
|
159
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
176
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"qenv.classes.qenv.js","sourceRoot":"","sources":["../ts/qenv.classes.qenv.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,sCAAsC,CAAC;AACtE,OAAO,KAAK,OAAO,MAAM,mBAAmB,CAAC;AAI7C,MAAM,OAAO,IAAI;IAYf,YACE,sBAA8B,OAAO,CAAC,GAAG,EAAE,EAC3C,kBAA2B,EAC3B,gBAAyB,IAAI;QAdxB,oBAAe,GAAa,EAAE,CAAC;QAC/B,qBAAgB,GAAa,EAAE,CAAC;QAChC,mBAAc,GAAa,EAAE,CAAC;QAC9B,mBAAc,GAA2B,EAAE,CAAC;QAC5C,WAAM,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QAYhD,IAAI,CAAC,cAAc,GAAG,IAAI,cAAc,EAAE,CAAC;QAC3C,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAAC;QAClE,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC3B,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC5B,IAAI,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;IAC7C,CAAC;IAEO,mBAAmB,CAAC,mBAA2B,EAAE,kBAA0B;QACjF,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAC3C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,EACzC,UAAU,CACX,CAAC;QACF,IAAI,kBAAkB,EAAE,CAAC;YACvB,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAClE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EACxC,UAAU,CACX,CAAC;YACF,MAAM,cAAc,GAAG,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CACjE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EACxC,SAAS,CACV,CAAC;YACF,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAClE,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,EACxC,UAAU,CACX,CAAC;YACF,MAAM,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;YAC/E,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC;YAC7E,MAAM,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;YAE/E,IAAI,iBAAiB,IAAI,CAAC,iBAAiB,IAAI,gBAAgB,CAAC,EAAE,CAAC;gBACjE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,uDAAuD,CAAC,CAAC;YACnF,CAAC;iBAAM,IAAI,iBAAiB,EAAE,CAAC;gBAC7B,IAAI,CAAC,mBAAmB,GAAG,eAAe,CAAC;YAC7C,CAAC;iBAAM,IAAI,gBAAgB,EAAE,CAAC;gBAC5B,IAAI,CAAC,mBAAmB,GAAG,cAAc,CAAC;YAC5C,CAAC;iBAAM,IAAI,iBAAiB,EAAE,CAAC;gBAC7B,IAAI,CAAC,mBAAmB,GAAG,eAAe,CAAC;YAC7C,CAAC;QACH,CAAC;IACH,CAAC;IAEO,mBAAmB;QACzB,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;YACnE,MAAM,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;YAC9E,IAAI,QAAQ,EAAE,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3D,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,+CAA+C,CAAC,CAAC;YAC3E,CAAC;QACH,CAAC;IACH,CAAC;IAEO,oBAAoB;QAC1B,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,iBAAiB,CAAC,MAAM,CAAC,CAAC;YAC7C,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACnC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,GAAG,KAAK,CAAC;YACtC,CAAC;QACH,CAAC;IACH,CAAC;IAEO,sBAAsB,CAAC,aAAsB;QACnD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,CAC/C,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,MAAM,CAAC,CACpD,CAAC;QAEF,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACnC,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;YAC7D,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;YACxD,IAAI,aAAa,EAAE,CAAC;gBAClB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,kCAAkC,CAAC,CAAC;gBAC7D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAClB,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,0DAA0D,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAC5B,iBAA4C;QAE5C,IAAI,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACrC,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;gBAClD,IAAI,KAAK,EAAE,CAAC;oBACV,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAEM,qBAAqB,CAAC,iBAAoC;QAC/D,OAAO,CAAC,IAAI,CAAC,6EAA6E,CAAC,CAAC;QAE5F,IAAI,KAAK,CAAC,OAAO,CAAC,iBAAiB,CAAC,EAAE,CAAC;YACrC,KAAK,MAAM,UAAU,IAAI,iBAAiB,EAAE,CAAC;gBAC3C,MAAM,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBAChD,IAAI,KAAK,EAAE,CAAC;oBACV,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,yBAAyB,CAAC,iBAAoC;QACzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC;QACjE,IAAI,QAAQ,IAAI,QAAQ,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;YACrD,MAAM,UAAU,GAAG,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;YACtD,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,YAAY,CAAC,YAAwB;QACjD,IAAI,OAAO,YAAY,KAAK,UAAU,EAAE,CAAC;YACvC,OAAO,MAAM,YAAY,EAAE,CAAC;QAC9B,CAAC;QAED,OAAO,CACL,IAAI,CAAC,0BAA0B,CAAC,YAAY,CAAC;YAC7C,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC;YAC3C,IAAI,CAAC,mBAAmB,CAAC,YAAY,CAAC;YACtC,IAAI,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAC3C,CAAC;IACJ,CAAC;IAEO,gBAAgB,CAAC,UAAkB;QACzC,OAAO,CACL,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC;YAC3C,IAAI,CAAC,wBAAwB,CAAC,UAAU,CAAC;YACzC,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC;YACpC,IAAI,CAAC,uBAAuB,CAAC,UAAU,CAAC,CACzC,CAAC;IACJ,CAAC;IAEO,0BAA0B,CAAC,UAAkB;QACnD,OAAO,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IACjC,CAAC;IAEO,wBAAwB,CAAC,UAAkB;QACjD,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,mBAAmB,CAAC,EAAE,CAAC;YACnE,OAAO,SAAS,CAAC;QACnB,CAAC;QACD,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;YAC5E,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;YAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC9B,OAAO,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACpD,CAAC;YACD,OAAO,KAAK,CAAC;QACf,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAEO,mBAAmB,CAAC,UAAkB;QAC5C,MAAM,UAAU,GAAG,gBAAgB,UAAU,EAAE,CAAC;QAChD,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC;YACpD,OAAO,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,uBAAuB,CAAC,UAAkB;QAChD,IAAI,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,WAAW,CAAC,cAAc,CAAC,EAAE,CAAC;YACrD,MAAM,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,gBAAgB,CAAC,cAAc,CAAC,CAAC;YAC/E,KAAK,MAAM,MAAM,IAAI,gBAAgB,EAAE,CAAC;gBACtC,IAAI,MAAM,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;oBACnC,MAAM,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,YAAY,CAAC,gBAAgB,MAAM,EAAE,CAAC,CAAC;oBACjF,MAAM,KAAK,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;oBACvC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;wBAC9B,OAAO,eAAe,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;oBACpD,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,YAAY,CAAC,IAAS;QAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACpD,CAAC;IAEO,YAAY,CAAC,aAAqB;QACxC,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IACnC,CAAC;CACF"}
|
package/npmextra.json
CHANGED
|
@@ -6,12 +6,24 @@
|
|
|
6
6
|
"gitzone": {
|
|
7
7
|
"projectType": "npm",
|
|
8
8
|
"module": {
|
|
9
|
-
"githost": "
|
|
9
|
+
"githost": "code.foss.global",
|
|
10
10
|
"gitscope": "push.rocks",
|
|
11
11
|
"gitrepo": "qenv",
|
|
12
|
-
"description": "
|
|
12
|
+
"description": "A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.",
|
|
13
13
|
"npmPackagename": "@push.rocks/qenv",
|
|
14
|
-
"license": "MIT"
|
|
14
|
+
"license": "MIT",
|
|
15
|
+
"keywords": [
|
|
16
|
+
"environment variables",
|
|
17
|
+
"configuration management",
|
|
18
|
+
"Node.js",
|
|
19
|
+
"TypeScript",
|
|
20
|
+
"Docker secrets",
|
|
21
|
+
"CI/CD",
|
|
22
|
+
"testing"
|
|
23
|
+
]
|
|
15
24
|
}
|
|
25
|
+
},
|
|
26
|
+
"tsdoc": {
|
|
27
|
+
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
16
28
|
}
|
|
17
29
|
}
|
package/package.json
CHANGED
|
@@ -1,26 +1,30 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@push.rocks/qenv",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.0.7",
|
|
4
4
|
"private": false,
|
|
5
|
-
"description": "
|
|
5
|
+
"description": "A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.",
|
|
6
6
|
"main": "dist_ts/index.js",
|
|
7
7
|
"typings": "dist_ts/index.d.ts",
|
|
8
8
|
"type": "module",
|
|
9
9
|
"repository": {
|
|
10
10
|
"type": "git",
|
|
11
|
-
"url": "
|
|
11
|
+
"url": "https://code.foss.global/push.rocks/qenv.git"
|
|
12
12
|
},
|
|
13
13
|
"keywords": [
|
|
14
|
-
"environment",
|
|
15
|
-
"
|
|
16
|
-
"
|
|
14
|
+
"environment variables",
|
|
15
|
+
"configuration management",
|
|
16
|
+
"Node.js",
|
|
17
|
+
"TypeScript",
|
|
18
|
+
"Docker secrets",
|
|
19
|
+
"CI/CD",
|
|
20
|
+
"testing"
|
|
17
21
|
],
|
|
18
22
|
"author": "Lossless GmbH",
|
|
19
23
|
"license": "MIT",
|
|
20
24
|
"bugs": {
|
|
21
25
|
"url": "https://gitlab.com/pushrocks/qenv/issues"
|
|
22
26
|
},
|
|
23
|
-
"homepage": "https://
|
|
27
|
+
"homepage": "https://code.foss.global/push.rocks/qenv",
|
|
24
28
|
"devDependencies": {
|
|
25
29
|
"@git.zone/tsbuild": "^2.1.72",
|
|
26
30
|
"@git.zone/tsrun": "^1.2.44",
|
package/readme.hints.md
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
package/readme.md
CHANGED
|
@@ -1,52 +1,125 @@
|
|
|
1
1
|
# @push.rocks/qenv
|
|
2
2
|
easy promised environments
|
|
3
3
|
|
|
4
|
-
##
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
Status Category | Status Badge
|
|
13
|
-
-- | --
|
|
14
|
-
GitLab Pipelines | [](https://lossless.cloud)
|
|
15
|
-
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
|
16
|
-
npm | [](https://lossless.cloud)
|
|
17
|
-
Snyk | [](https://lossless.cloud)
|
|
18
|
-
TypeScript Support | [](https://lossless.cloud)
|
|
19
|
-
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
20
|
-
Code Style | [](https://lossless.cloud)
|
|
21
|
-
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
|
22
|
-
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
|
23
|
-
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
|
4
|
+
## Install
|
|
5
|
+
To install `@push.rocks/qenv`, you need to have Node.js installed on your system. Once Node.js is installed, you can add `@push.rocks/qenv` to your project by running the following command in your project's root directory:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @push.rocks/qenv --save
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This command will add `@push.rocks/qenv` as a dependency to your project, and you will be ready to use it in your application.
|
|
24
12
|
|
|
25
13
|
## Usage
|
|
14
|
+
`@push.rocks/qenv` provides a convenient way to manage and access environment variables in your Node.js projects, especially when dealing with different environments like development, testing, and production. Its primary use is to load environment-specific variables in an easy and organized manner. Below is an extensive guide on how to use this module effectively in various scenarios, ensuring you can handle environment variables efficiently in your projects.
|
|
15
|
+
|
|
16
|
+
### Getting Started
|
|
17
|
+
First, ensure you have TypeScript configured in your project. `@push.rocks/qenv` is fully typed, providing excellent IntelliSense support when working in editors that support TypeScript, such as Visual Studio Code.
|
|
18
|
+
|
|
19
|
+
#### Importing Qenv
|
|
20
|
+
To get started, import the `Qenv` class from `@push.rocks/qenv`:
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { Qenv } from '@push.rocks/qenv';
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
#### Basic Configuration
|
|
27
|
+
`@push.rocks/qenv` works with two main files: `qenv.yml` for specifying required environment variables, and `env.yml` for specifying values for these variables. These files should be placed in your project directory.
|
|
28
|
+
|
|
29
|
+
##### qenv.yml
|
|
30
|
+
This file specifies the environment variables that are required by your application. An example `qenv.yml` might look like this:
|
|
31
|
+
|
|
32
|
+
```yaml
|
|
33
|
+
required:
|
|
34
|
+
- DB_HOST
|
|
35
|
+
- DB_USER
|
|
36
|
+
- DB_PASS
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
##### env.yml
|
|
40
|
+
This file contains the actual values for the environment variables in a development or testing environment. An example `env.yml` could be:
|
|
41
|
+
|
|
42
|
+
```yaml
|
|
43
|
+
DB_HOST: localhost
|
|
44
|
+
DB_USER: user
|
|
45
|
+
DB_PASS: pass
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
#### Instantiating Qenv
|
|
49
|
+
Create an instance of `Qenv` by providing paths to the directories containing the `qenv.yml` and `env.yml` files, respectively:
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
const myQenv = new Qenv('./path/to/dir/with/qenv', './path/to/dir/with/env');
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
If the `env.yml` file is in the same directory as `qenv.yml`, you can omit the second argument:
|
|
56
|
+
|
|
57
|
+
```typescript
|
|
58
|
+
const myQenv = new Qenv('./path/to/dir/with/both');
|
|
59
|
+
```
|
|
26
60
|
|
|
27
|
-
|
|
61
|
+
#### Accessing Environment Variables
|
|
62
|
+
After instantiating `Qenv`, you can access the loaded environment variables directly from `process.env` in Node.js or through the `myQenv` instance for more complex scenarios like asynchronous variable resolution:
|
|
28
63
|
|
|
29
|
-
|
|
64
|
+
```typescript
|
|
65
|
+
// Accessing directly via process.env
|
|
66
|
+
console.log(process.env.DB_HOST); // 'localhost' in development environment
|
|
30
67
|
|
|
31
|
-
|
|
32
|
-
|
|
68
|
+
// Accessing via Qenv instance for more advanced scenarios
|
|
69
|
+
(async () => {
|
|
70
|
+
const dbHost = await myQenv.getEnvVarOnDemand('DB_HOST');
|
|
71
|
+
console.log(dbHost); // 'localhost'
|
|
72
|
+
})();
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### Advanced Usage
|
|
76
|
+
#### Handling Missing Variables
|
|
77
|
+
By default, `Qenv` will throw an error and exit if any of the required environment variables specified in `qenv.yml` are missing. You can disable this behavior by passing `false` as the third argument to the constructor, which allows your application to handle missing variables gracefully:
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
const myQenv = new Qenv('./path/to/dir/with/qenv', './path/to/dir/with/env', false);
|
|
81
|
+
```
|
|
33
82
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
However when on another machine you can have a env.yml that will be added to the environment by qenv.
|
|
83
|
+
#### Dynamic Environment Variables
|
|
84
|
+
For dynamic or computed environment variables, you can define functions that resolve these variables asynchronously. This is particularly useful for variables that require fetching from an external source:
|
|
37
85
|
|
|
38
|
-
```
|
|
39
|
-
|
|
86
|
+
```typescript
|
|
87
|
+
// Define a function to fetch a variable
|
|
88
|
+
const fetchDbHost = async () => {
|
|
89
|
+
// Logic to fetch DB_HOST from an external service
|
|
90
|
+
return 'dynamic.host';
|
|
91
|
+
};
|
|
40
92
|
|
|
41
|
-
|
|
93
|
+
// Use the function with getEnvVarOnDemand
|
|
94
|
+
(async () => {
|
|
95
|
+
const dbHost = await myQenv.getEnvVarOnDemand(fetchDbHost);
|
|
96
|
+
console.log(dbHost); // 'dynamic.host'
|
|
97
|
+
})();
|
|
42
98
|
```
|
|
43
99
|
|
|
44
|
-
|
|
100
|
+
#### Reading Variables from Docker Secrets or Other Sources
|
|
101
|
+
Internally, `@push.rocks/qenv` supports reading from Docker secrets, providing flexibility for applications deployed in Docker environments. The module attempts to read each required variable from the process environment, a provided `env.yml` file, Docker secrets, or any custom source you integrate.
|
|
102
|
+
|
|
103
|
+
### Conclusion
|
|
104
|
+
`@push.rocks/qenv` simplifies handling environment variables across different environments, making your application's configuration more manageable and secure. By separating variable definitions from their values and providing support for dynamic resolution, `@push.rocks/qenv` offers a robust solution for managing configuration in Node.js projects. Whether you're working in a local development environment, CI/CD pipelines, or production, `@push.rocks/qenv` ensures that you have the correct configuration for the task at hand.
|
|
105
|
+
|
|
106
|
+
Note: Due to the complexity and depth of `@push.rocks/qenv`, this documentation aims to cover general and advanced usage comprehensively. Please refer to the module's official documentation and typed definitions for further details on specific features or configuration options.
|
|
107
|
+
|
|
108
|
+
## License and Legal Information
|
|
109
|
+
|
|
110
|
+
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
|
111
|
+
|
|
112
|
+
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
113
|
+
|
|
114
|
+
### Trademarks
|
|
115
|
+
|
|
116
|
+
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
|
117
|
+
|
|
118
|
+
### Company Information
|
|
45
119
|
|
|
46
|
-
|
|
120
|
+
Task Venture Capital GmbH
|
|
121
|
+
Registered at District court Bremen HRB 35230 HB, Germany
|
|
47
122
|
|
|
48
|
-
For
|
|
123
|
+
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
|
49
124
|
|
|
50
|
-
|
|
51
|
-
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
|
52
|
-
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
125
|
+
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
package/ts/00_commitinfo_data.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* autocreated commitinfo by @
|
|
2
|
+
* autocreated commitinfo by @push.rocks/commitinfo
|
|
3
3
|
*/
|
|
4
4
|
export const commitinfo = {
|
|
5
5
|
name: '@push.rocks/qenv',
|
|
6
|
-
version: '6.0.
|
|
7
|
-
description: '
|
|
6
|
+
version: '6.0.7',
|
|
7
|
+
description: 'A module for easily handling environment variables in Node.js projects with support for .yml and .json configuration.'
|
|
8
8
|
}
|
package/ts/qenv.classes.qenv.ts
CHANGED
|
@@ -33,10 +33,31 @@ export class Qenv {
|
|
|
33
33
|
'qenv.yml'
|
|
34
34
|
);
|
|
35
35
|
if (envFileBasePathArg) {
|
|
36
|
-
this.envFilePathAbsolute = plugins.path.join(
|
|
36
|
+
const envFileJsonPath = this.envFilePathAbsolute = plugins.path.join(
|
|
37
37
|
plugins.path.resolve(envFileBasePathArg),
|
|
38
38
|
'env.json'
|
|
39
39
|
);
|
|
40
|
+
const envFileYmlPath = this.envFilePathAbsolute = plugins.path.join(
|
|
41
|
+
plugins.path.resolve(envFileBasePathArg),
|
|
42
|
+
'env.yml'
|
|
43
|
+
);
|
|
44
|
+
const envFileYamlPath = this.envFilePathAbsolute = plugins.path.join(
|
|
45
|
+
plugins.path.resolve(envFileBasePathArg),
|
|
46
|
+
'env.yaml'
|
|
47
|
+
);
|
|
48
|
+
const envFileJsonExists = plugins.smartfile.fs.fileExistsSync(envFileJsonPath);
|
|
49
|
+
const envFileYmlExists = plugins.smartfile.fs.fileExistsSync(envFileYmlPath);
|
|
50
|
+
const envFileYamlExists = plugins.smartfile.fs.fileExistsSync(envFileYamlPath);
|
|
51
|
+
|
|
52
|
+
if (envFileJsonExists && (envFileYamlExists || envFileYmlExists)) {
|
|
53
|
+
this.logger.log('warn', 'Both env.json and env.yml files exist! Using env.json');
|
|
54
|
+
} else if (envFileJsonExists) {
|
|
55
|
+
this.envFilePathAbsolute = envFileJsonPath;
|
|
56
|
+
} else if (envFileYmlExists) {
|
|
57
|
+
this.envFilePathAbsolute = envFileYmlPath;
|
|
58
|
+
} else if (envFileYamlExists) {
|
|
59
|
+
this.envFilePathAbsolute = envFileYamlPath;
|
|
60
|
+
}
|
|
40
61
|
}
|
|
41
62
|
}
|
|
42
63
|
|
|
@@ -126,7 +147,7 @@ export class Qenv {
|
|
|
126
147
|
|
|
127
148
|
return (
|
|
128
149
|
this.getFromEnvironmentVariable(envVarRefArg) ||
|
|
129
|
-
this.
|
|
150
|
+
this.getFromEnvYamlOrJsonFile(envVarRefArg) ||
|
|
130
151
|
this.getFromDockerSecret(envVarRefArg) ||
|
|
131
152
|
this.getFromDockerSecretJson(envVarRefArg)
|
|
132
153
|
);
|
|
@@ -135,7 +156,7 @@ export class Qenv {
|
|
|
135
156
|
private tryGetEnvVarSync(envVarName: string): string | undefined {
|
|
136
157
|
return (
|
|
137
158
|
this.getFromEnvironmentVariable(envVarName) ||
|
|
138
|
-
this.
|
|
159
|
+
this.getFromEnvYamlOrJsonFile(envVarName) ||
|
|
139
160
|
this.getFromDockerSecret(envVarName) ||
|
|
140
161
|
this.getFromDockerSecretJson(envVarName)
|
|
141
162
|
);
|
|
@@ -145,7 +166,7 @@ export class Qenv {
|
|
|
145
166
|
return process.env[envVarName];
|
|
146
167
|
}
|
|
147
168
|
|
|
148
|
-
private
|
|
169
|
+
private getFromEnvYamlOrJsonFile(envVarName: string): string | undefined {
|
|
149
170
|
if (!plugins.smartfile.fs.fileExistsSync(this.envFilePathAbsolute)) {
|
|
150
171
|
return undefined;
|
|
151
172
|
}
|