Compare commits
24 Commits
Author | SHA1 | Date | |
---|---|---|---|
73c223af6c | |||
ead69f3bb9 | |||
7de17bbefa | |||
4e39970dd7 | |||
2a7c239176 | |||
35e71ccf00 | |||
11a2cf83ee | |||
d7a0541d81 | |||
c03e17d522 | |||
b9d1080829 | |||
a84a257e4b | |||
2fa659a22a | |||
bdc99cc3a6 | |||
2956278369 | |||
c61ef2eeba | |||
41c97c4c05 | |||
8870f9adf2 | |||
dfb400ba5c | |||
38609031d9 | |||
1d4808ed4a | |||
612f8307b8 | |||
de6045842d | |||
575671d8c9 | |||
8b715c52ac |
3
.gitignore
vendored
3
.gitignore
vendored
@ -1,3 +1,4 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
coverage/
|
coverage/
|
||||||
docs/
|
pages/
|
||||||
|
public/
|
||||||
|
@ -3,13 +3,16 @@ image: hosttoday/ht-docker-node:npmts
|
|||||||
stages:
|
stages:
|
||||||
- test
|
- test
|
||||||
- release
|
- release
|
||||||
|
- trigger
|
||||||
|
- pages
|
||||||
|
|
||||||
testLEGACY:
|
testLEGACY:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
- npmci test lts
|
- npmci test legacy
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
allow_failure: true
|
||||||
|
|
||||||
testLTS:
|
testLTS:
|
||||||
stage: test
|
stage: test
|
||||||
@ -33,3 +36,24 @@ release:
|
|||||||
- tags
|
- tags
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
|
|
||||||
|
trigger:
|
||||||
|
stage: trigger
|
||||||
|
script:
|
||||||
|
- npmci trigger
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- docker
|
||||||
|
|
||||||
|
pages:
|
||||||
|
image: hosttoday/ht-docker-node:npmpage
|
||||||
|
stage: pages
|
||||||
|
script:
|
||||||
|
- npmci command npmpage --publish gitlab
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
artifacts:
|
||||||
|
expire_in: 1 week
|
||||||
|
paths:
|
||||||
|
- public
|
||||||
|
40
README.md
Normal file
40
README.md
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
# qenv
|
||||||
|
easy promised environments
|
||||||
|
|
||||||
|
## Availabililty
|
||||||
|
[](https://www.npmjs.com/package/qenv)
|
||||||
|
[](https://GitLab.com/pushrocks/qenv)
|
||||||
|
[](https://github.com/pushrocks/qenv)
|
||||||
|
[](https://pushrocks.gitlab.io/qenv/)
|
||||||
|
|
||||||
|
## Status for master
|
||||||
|
[](https://GitLab.com/pushrocks/qenv/commits/master)
|
||||||
|
[](https://GitLab.com/pushrocks/qenv/commits/master)
|
||||||
|
[](https://www.npmjs.com/package/qenv)
|
||||||
|
[](https://david-dm.org/pushrocks/qenv)
|
||||||
|
[](https://www.bithound.io/github/pushrocks/qenv/master/dependencies/npm)
|
||||||
|
[](https://www.bithound.io/github/pushrocks/qenv)
|
||||||
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
||||||
|
[](http://standardjs.com/)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
Use TypeScript for best in class instellisense.
|
||||||
|
|
||||||
|
qenv works with two files:
|
||||||
|
|
||||||
|
* **qenv.yml** - specifies which ENV vars are required.
|
||||||
|
* **env.yml** - specifies all env vars that are not already set in the current environment.
|
||||||
|
|
||||||
|
Now obviously you can set build specific env vars in many CI environments.
|
||||||
|
So there we do not need an **env.yml** since all ENV vars are in place
|
||||||
|
However when on another machine you can have a env.yml that will be added to the environment by qenv.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
import {Qenv} from "qenv";
|
||||||
|
|
||||||
|
myQenv = new Qenv("path/to/dir/where/qenv.yml/is/","path/to/dir/where/env.yml/is(");
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
[](https://push.rocks)
|
11
dist/index.d.ts
vendored
11
dist/index.d.ts
vendored
@ -0,0 +1,11 @@
|
|||||||
|
export interface IKeyValueObject {
|
||||||
|
key: string;
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
export declare class Qenv {
|
||||||
|
requiredEnvVars: string[];
|
||||||
|
availableEnvVars: string[];
|
||||||
|
missingEnvVars: string[];
|
||||||
|
keyValueObjectArray: IKeyValueObject[];
|
||||||
|
constructor(basePathArg: string, envYmlPathArg: any, failOnMissing?: boolean);
|
||||||
|
}
|
||||||
|
72
dist/index.js
vendored
72
dist/index.js
vendored
@ -1,3 +1,69 @@
|
|||||||
|
"use strict";
|
||||||
|
const plugins = require("./qenv.plugins");
|
||||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IiIsImZpbGUiOiJpbmRleC5qcyIsInNvdXJjZXNDb250ZW50IjpbXX0=
|
;
|
||||||
|
class Qenv {
|
||||||
|
constructor(basePathArg = process.cwd(), envYmlPathArg, failOnMissing = true) {
|
||||||
|
this.requiredEnvVars = [];
|
||||||
|
this.availableEnvVars = [];
|
||||||
|
this.missingEnvVars = [];
|
||||||
|
this.keyValueObjectArray = [];
|
||||||
|
getRequiredEnvVars(basePathArg, this.requiredEnvVars);
|
||||||
|
getAvailableEnvVars(this.requiredEnvVars, envYmlPathArg, this.availableEnvVars, this.keyValueObjectArray);
|
||||||
|
this.missingEnvVars = getMissingEnvVars(this.requiredEnvVars, this.availableEnvVars);
|
||||||
|
// handle missing variables
|
||||||
|
if (this.missingEnvVars.length > 0) {
|
||||||
|
console.info('Required Env Vars are:');
|
||||||
|
console.log(this.requiredEnvVars);
|
||||||
|
console.error('However some Env variables could not be resolved:');
|
||||||
|
console.log(this.missingEnvVars);
|
||||||
|
if (failOnMissing) {
|
||||||
|
console.error('Exiting!');
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
;
|
||||||
|
}
|
||||||
|
exports.Qenv = Qenv;
|
||||||
|
;
|
||||||
|
let getRequiredEnvVars = (pathArg, requiredEnvVarsArray) => {
|
||||||
|
let qenvFilePath = plugins.path.join(pathArg, 'qenv.yml');
|
||||||
|
let qenvFile = plugins.smartfile.fs.toObjectSync(qenvFilePath);
|
||||||
|
for (let keyArg in qenvFile.vars) {
|
||||||
|
requiredEnvVarsArray.push(qenvFile.vars[keyArg]);
|
||||||
|
}
|
||||||
|
;
|
||||||
|
};
|
||||||
|
let getAvailableEnvVars = (requiredEnvVarsArg, envYmlPathArg, availableEnvVarsArray, keyValueObjectArrayArg) => {
|
||||||
|
envYmlPathArg = plugins.path.join(envYmlPathArg, 'env.yml');
|
||||||
|
let envYml;
|
||||||
|
try {
|
||||||
|
envYml = plugins.smartfile.fs.toObjectSync(envYmlPathArg);
|
||||||
|
}
|
||||||
|
catch (err) {
|
||||||
|
console.log("env file couldn't be found at " + envYmlPathArg);
|
||||||
|
envYml = {};
|
||||||
|
}
|
||||||
|
for (let requiredEnvVar of requiredEnvVarsArg) {
|
||||||
|
if (process.env[requiredEnvVar]) {
|
||||||
|
availableEnvVarsArray.push(requiredEnvVar);
|
||||||
|
keyValueObjectArrayArg.push({
|
||||||
|
key: requiredEnvVar,
|
||||||
|
value: process.env[requiredEnvVar]
|
||||||
|
});
|
||||||
|
}
|
||||||
|
else if (envYml.hasOwnProperty(requiredEnvVar)) {
|
||||||
|
process.env[requiredEnvVar] = envYml[requiredEnvVar];
|
||||||
|
availableEnvVarsArray.push(requiredEnvVar);
|
||||||
|
keyValueObjectArrayArg.push({
|
||||||
|
key: requiredEnvVar,
|
||||||
|
value: process.env[requiredEnvVar]
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
;
|
||||||
|
};
|
||||||
|
let getMissingEnvVars = (requiredEnvVarsArray, availableEnvVarsArray) => {
|
||||||
|
return plugins.lodash.difference(requiredEnvVarsArray, availableEnvVarsArray);
|
||||||
|
};
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMENBQXlDO0FBS3hDLENBQUM7QUFFRjtJQUtJLFlBQVksV0FBVyxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxhQUFhLEVBQUMsYUFBYSxHQUFHLElBQUk7UUFKMUUsb0JBQWUsR0FBYSxFQUFFLENBQUE7UUFDOUIscUJBQWdCLEdBQVksRUFBRSxDQUFBO1FBQzlCLG1CQUFjLEdBQVksRUFBRSxDQUFBO1FBQzVCLHdCQUFtQixHQUFxQixFQUFFLENBQUE7UUFFdEMsa0JBQWtCLENBQUMsV0FBVyxFQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtRQUNwRCxtQkFBbUIsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFDLGFBQWEsRUFBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLENBQUE7UUFDdEcsSUFBSSxDQUFDLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFBO1FBRW5GLDJCQUEyQjtRQUMzQixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQSxDQUFDO1lBQ2hDLE9BQU8sQ0FBQyxJQUFJLENBQUMsd0JBQXdCLENBQUMsQ0FBQTtZQUN0QyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtZQUNqQyxPQUFPLENBQUMsS0FBSyxDQUFDLG1EQUFtRCxDQUFDLENBQUE7WUFDbEUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUE7WUFDaEMsRUFBRSxDQUFDLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztnQkFDaEIsT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtnQkFDekIsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQTtZQUNuQixDQUFDO1FBQ0wsQ0FBQztJQUNMLENBQUM7SUFBQSxDQUFDO0NBQ0w7QUF0QkQsb0JBc0JDO0FBQUEsQ0FBQztBQUVGLElBQUksa0JBQWtCLEdBQUcsQ0FBQyxPQUFlLEVBQUUsb0JBQThCO0lBQ3JFLElBQUksWUFBWSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBQyxVQUFVLENBQUMsQ0FBQTtJQUN4RCxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDOUQsR0FBRyxDQUFDLENBQUMsSUFBSSxNQUFNLElBQUksUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDL0Isb0JBQW9CLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQTtJQUNwRCxDQUFDO0lBQUEsQ0FBQztBQUNOLENBQUMsQ0FBQTtBQUlELElBQUksbUJBQW1CLEdBQUcsQ0FBQyxrQkFBNEIsRUFBQyxhQUFxQixFQUFDLHFCQUErQixFQUFDLHNCQUF5QztJQUNuSixhQUFhLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxFQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQzFELElBQUksTUFBTSxDQUFBO0lBQ1YsSUFBSSxDQUFDO1FBQ0QsTUFBTSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxhQUFhLENBQUMsQ0FBQTtJQUM3RCxDQUFDO0lBQUMsS0FBSyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNYLE9BQU8sQ0FBQyxHQUFHLENBQUMsZ0NBQWdDLEdBQUcsYUFBYSxDQUFDLENBQUE7UUFDN0QsTUFBTSxHQUFHLEVBQUUsQ0FBQTtJQUNmLENBQUM7SUFDRCxHQUFHLENBQUMsQ0FBQyxJQUFJLGNBQWMsSUFBSSxrQkFBa0IsQ0FBQyxDQUFBLENBQUM7UUFDM0MsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0IscUJBQXFCLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFBO1lBQzFDLHNCQUFzQixDQUFDLElBQUksQ0FBQztnQkFDeEIsR0FBRyxFQUFFLGNBQWM7Z0JBQ25CLEtBQUssRUFBRSxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQzthQUNyQyxDQUFDLENBQUE7UUFDTixDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQSxDQUFDO1lBQzlDLE9BQU8sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLEdBQUcsTUFBTSxDQUFDLGNBQWMsQ0FBQyxDQUFBO1lBQ3BELHFCQUFxQixDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQTtZQUMxQyxzQkFBc0IsQ0FBQyxJQUFJLENBQUM7Z0JBQ3hCLEdBQUcsRUFBRSxjQUFjO2dCQUNuQixLQUFLLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUM7YUFDckMsQ0FBQyxDQUFBO1FBQ04sQ0FBQztJQUNMLENBQUM7SUFBQSxDQUFDO0FBQ04sQ0FBQyxDQUFBO0FBRUQsSUFBSSxpQkFBaUIsR0FBRyxDQUFDLG9CQUE4QixFQUFDLHFCQUErQjtJQUNuRixNQUFNLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsb0JBQW9CLEVBQUMscUJBQXFCLENBQUMsQ0FBQTtBQUNoRixDQUFDLENBQUEifQ==
|
7
dist/qenv.plugins.d.ts
vendored
7
dist/qenv.plugins.d.ts
vendored
@ -1,3 +1,4 @@
|
|||||||
import "typings-global";
|
import 'typings-global';
|
||||||
export import beautylog = require("beautylog");
|
export declare let lodash: any;
|
||||||
export import smartfile = require("smartfile");
|
export import path = require('path');
|
||||||
|
export import smartfile = require('smartfile');
|
||||||
|
6
dist/qenv.plugins.js
vendored
6
dist/qenv.plugins.js
vendored
@ -1,6 +1,6 @@
|
|||||||
"use strict";
|
"use strict";
|
||||||
require("typings-global");
|
require("typings-global");
|
||||||
exports.beautylog = require("beautylog");
|
exports.lodash = require('lodash');
|
||||||
|
exports.path = require("path");
|
||||||
exports.smartfile = require("smartfile");
|
exports.smartfile = require("smartfile");
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvcWVudi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwQkFBd0I7QUFDYixRQUFBLE1BQU0sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7QUFDdEMsK0JBQXFDO0FBQ3JDLHlDQUE4QyJ9
|
||||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInFlbnYucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ1YsaUJBQVMsV0FBVyxXQUFXLENBQUMsQ0FBQztBQUNqQyxpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDIiwiZmlsZSI6InFlbnYucGx1Z2lucy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInR5cGluZ3MtZ2xvYmFsXCI7XG5leHBvcnQgaW1wb3J0IGJlYXV0eWxvZyA9IHJlcXVpcmUoXCJiZWF1dHlsb2dcIik7XG5leHBvcnQgaW1wb3J0IHNtYXJ0ZmlsZSA9IHJlcXVpcmUoXCJzbWFydGZpbGVcIik7XG4iXX0=
|
|
17
package.json
17
package.json
@ -1,8 +1,9 @@
|
|||||||
{
|
{
|
||||||
"name": "qenv",
|
"name": "qenv",
|
||||||
"version": "1.0.1",
|
"version": "1.1.2",
|
||||||
"description": "smart handling of environment variables",
|
"description": "easy promised environments",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
|
"typings": "dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(npmts)"
|
"test": "(npmts)"
|
||||||
},
|
},
|
||||||
@ -22,14 +23,14 @@
|
|||||||
},
|
},
|
||||||
"homepage": "https://gitlab.com/pushrocks/qenv#README",
|
"homepage": "https://gitlab.com/pushrocks/qenv#README",
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"npmts-g": "^5.2.6",
|
"npmts-g": "^6.0.0",
|
||||||
"should": "^9.0.2",
|
"smartchai": "^1.0.1",
|
||||||
"typings-test": "^1.0.1"
|
"typings-test": "^1.0.3"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"beautylog": "^5.0.12",
|
"lodash": "^4.17.4",
|
||||||
"q": "^1.4.1",
|
"q": "^1.4.1",
|
||||||
"smartfile": "^3.0.10",
|
"smartfile": "^4.1.3",
|
||||||
"typings-global": "^1.0.3"
|
"typings-global": "^1.0.14"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
2
test/assets/env.yml
Normal file
2
test/assets/env.yml
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
key1: fromYml
|
||||||
|
key2: fromYml
|
4
test/assets/qenv.yml
Normal file
4
test/assets/qenv.yml
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
vars:
|
||||||
|
- key1
|
||||||
|
- key2
|
||||||
|
- key3
|
1
test/test.d.ts
vendored
Normal file
1
test/test.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
import 'typings-test';
|
26
test/test.js
Normal file
26
test/test.js
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
"use strict";
|
||||||
|
require("typings-test");
|
||||||
|
const path = require("path");
|
||||||
|
const smartchai_1 = require("smartchai");
|
||||||
|
const index_1 = require("../dist/index");
|
||||||
|
process.cwd = () => {
|
||||||
|
return path.join(__dirname, './assets/');
|
||||||
|
};
|
||||||
|
process.env['key1'] = 'original';
|
||||||
|
let qenvTestObject;
|
||||||
|
describe('Qenv class', function () {
|
||||||
|
it('should create a new class', function () {
|
||||||
|
qenvTestObject = new index_1.Qenv(process.cwd(), process.cwd(), false);
|
||||||
|
});
|
||||||
|
it('key1 should be not be overwritten since it is already present', function () {
|
||||||
|
smartchai_1.expect(process.env.key1).to.equal('original');
|
||||||
|
});
|
||||||
|
it('key2 should be read from Yml', function () {
|
||||||
|
smartchai_1.expect(process.env.key2).to.equal('fromYml');
|
||||||
|
});
|
||||||
|
it('keyValueObjectArray should hold all retrieved values', function () {
|
||||||
|
smartchai_1.expect(qenvTestObject.keyValueObjectArray[0].value).to.equal('original');
|
||||||
|
smartchai_1.expect(qenvTestObject.keyValueObjectArray[1].value).to.equal('fromYml');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQiw2QkFBNEI7QUFDNUIseUNBQWtDO0FBQ2xDLHlDQUFrQztBQUVsQyxPQUFPLENBQUMsR0FBRyxHQUFHO0lBQ1YsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFDLFdBQVcsQ0FBQyxDQUFBO0FBQzNDLENBQUMsQ0FBQTtBQUVELE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsVUFBVSxDQUFBO0FBRWhDLElBQUksY0FBbUIsQ0FBQTtBQUN2QixRQUFRLENBQUMsWUFBWSxFQUFDO0lBQ2xCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixjQUFjLEdBQUcsSUFBSSxZQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxLQUFLLENBQUMsQ0FBQTtJQUNoRSxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQywrREFBK0QsRUFBQztRQUMvRCxrQkFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUNqRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixrQkFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUNoRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxzREFBc0QsRUFBQztRQUN0RCxrQkFBTSxDQUFDLGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQ3hFLGtCQUFNLENBQUMsY0FBYyxDQUFDLG1CQUFtQixDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUE7SUFDM0UsQ0FBQyxDQUFDLENBQUE7QUFFTixDQUFDLENBQUMsQ0FBQSJ9
|
28
test/test.ts
Normal file
28
test/test.ts
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
import 'typings-test'
|
||||||
|
import * as path from 'path'
|
||||||
|
import { expect } from 'smartchai'
|
||||||
|
import {Qenv} from '../dist/index'
|
||||||
|
|
||||||
|
process.cwd = () => {
|
||||||
|
return path.join(__dirname,'./assets/')
|
||||||
|
}
|
||||||
|
|
||||||
|
process.env['key1'] = 'original'
|
||||||
|
|
||||||
|
let qenvTestObject:Qenv
|
||||||
|
describe('Qenv class',function(){
|
||||||
|
it('should create a new class',function(){
|
||||||
|
qenvTestObject = new Qenv(process.cwd(),process.cwd(),false)
|
||||||
|
})
|
||||||
|
it('key1 should be not be overwritten since it is already present',function(){
|
||||||
|
expect(process.env.key1).to.equal('original')
|
||||||
|
})
|
||||||
|
it('key2 should be read from Yml',function(){
|
||||||
|
expect(process.env.key2).to.equal('fromYml')
|
||||||
|
})
|
||||||
|
it('keyValueObjectArray should hold all retrieved values',function(){
|
||||||
|
expect(qenvTestObject.keyValueObjectArray[0].value).to.equal('original')
|
||||||
|
expect(qenvTestObject.keyValueObjectArray[1].value).to.equal('fromYml')
|
||||||
|
})
|
||||||
|
|
||||||
|
})
|
71
ts/index.ts
71
ts/index.ts
@ -0,0 +1,71 @@
|
|||||||
|
import * as plugins from "./qenv.plugins"
|
||||||
|
|
||||||
|
export interface IKeyValueObject {
|
||||||
|
key: string,
|
||||||
|
value: string
|
||||||
|
};
|
||||||
|
|
||||||
|
export class Qenv {
|
||||||
|
requiredEnvVars: string[] = []
|
||||||
|
availableEnvVars:string[] = []
|
||||||
|
missingEnvVars:string[] = []
|
||||||
|
keyValueObjectArray:IKeyValueObject[] = []
|
||||||
|
constructor(basePathArg = process.cwd(),envYmlPathArg,failOnMissing = true){
|
||||||
|
getRequiredEnvVars(basePathArg,this.requiredEnvVars)
|
||||||
|
getAvailableEnvVars(this.requiredEnvVars,envYmlPathArg,this.availableEnvVars,this.keyValueObjectArray)
|
||||||
|
this.missingEnvVars = getMissingEnvVars(this.requiredEnvVars,this.availableEnvVars)
|
||||||
|
|
||||||
|
// handle missing variables
|
||||||
|
if (this.missingEnvVars.length > 0){
|
||||||
|
console.info('Required Env Vars are:')
|
||||||
|
console.log(this.requiredEnvVars)
|
||||||
|
console.error('However some Env variables could not be resolved:')
|
||||||
|
console.log(this.missingEnvVars)
|
||||||
|
if (failOnMissing) {
|
||||||
|
console.error('Exiting!')
|
||||||
|
process.exit(1)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
};
|
||||||
|
|
||||||
|
let getRequiredEnvVars = (pathArg: string, requiredEnvVarsArray: string[]) => {
|
||||||
|
let qenvFilePath = plugins.path.join(pathArg,'qenv.yml')
|
||||||
|
let qenvFile = plugins.smartfile.fs.toObjectSync(qenvFilePath)
|
||||||
|
for (let keyArg in qenvFile.vars) {
|
||||||
|
requiredEnvVarsArray.push(qenvFile.vars[keyArg])
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
let getAvailableEnvVars = (requiredEnvVarsArg: string[],envYmlPathArg: string,availableEnvVarsArray: string[],keyValueObjectArrayArg: IKeyValueObject[]) => {
|
||||||
|
envYmlPathArg = plugins.path.join(envYmlPathArg,'env.yml')
|
||||||
|
let envYml
|
||||||
|
try {
|
||||||
|
envYml = plugins.smartfile.fs.toObjectSync(envYmlPathArg)
|
||||||
|
} catch (err) {
|
||||||
|
console.log("env file couldn't be found at " + envYmlPathArg)
|
||||||
|
envYml = {}
|
||||||
|
}
|
||||||
|
for (let requiredEnvVar of requiredEnvVarsArg){
|
||||||
|
if (process.env[requiredEnvVar]){
|
||||||
|
availableEnvVarsArray.push(requiredEnvVar)
|
||||||
|
keyValueObjectArrayArg.push({
|
||||||
|
key: requiredEnvVar,
|
||||||
|
value: process.env[requiredEnvVar]
|
||||||
|
})
|
||||||
|
} else if (envYml.hasOwnProperty(requiredEnvVar)){
|
||||||
|
process.env[requiredEnvVar] = envYml[requiredEnvVar]
|
||||||
|
availableEnvVarsArray.push(requiredEnvVar)
|
||||||
|
keyValueObjectArrayArg.push({
|
||||||
|
key: requiredEnvVar,
|
||||||
|
value: process.env[requiredEnvVar]
|
||||||
|
})
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
let getMissingEnvVars = (requiredEnvVarsArray: string[],availableEnvVarsArray: string[]) => {
|
||||||
|
return plugins.lodash.difference(requiredEnvVarsArray,availableEnvVarsArray)
|
||||||
|
}
|
||||||
|
@ -1,3 +1,4 @@
|
|||||||
import "typings-global";
|
import 'typings-global';
|
||||||
export import beautylog = require("beautylog");
|
export let lodash = require('lodash');
|
||||||
export import smartfile = require("smartfile");
|
export import path = require('path');
|
||||||
|
export import smartfile = require('smartfile')
|
||||||
|
3
tslint.json
Normal file
3
tslint.json
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
{
|
||||||
|
"extends": "tslint-config-standard"
|
||||||
|
}
|
Reference in New Issue
Block a user