Compare commits
5 Commits
Author | SHA1 | Date | |
---|---|---|---|
73c223af6c | |||
ead69f3bb9 | |||
7de17bbefa | |||
4e39970dd7 | |||
2a7c239176 |
3
.gitignore
vendored
3
.gitignore
vendored
@ -1,3 +1,4 @@
|
||||
node_modules/
|
||||
coverage/
|
||||
docs/
|
||||
pages/
|
||||
public/
|
||||
|
@ -3,13 +3,16 @@ image: hosttoday/ht-docker-node:npmts
|
||||
stages:
|
||||
- test
|
||||
- release
|
||||
- trigger
|
||||
- pages
|
||||
|
||||
testLEGACY:
|
||||
stage: test
|
||||
script:
|
||||
- npmci test lts
|
||||
- npmci test legacy
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
testLTS:
|
||||
stage: test
|
||||
@ -32,4 +35,25 @@ release:
|
||||
only:
|
||||
- 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
|
||||
|
27
README.md
27
README.md
@ -1,7 +1,26 @@
|
||||
# qenv
|
||||
provides an easy way for promised environments
|
||||
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.
|
||||
@ -11,9 +30,11 @@ 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.
|
||||
|
||||
```typescript
|
||||
```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)
|
||||
|
4
dist/index.d.ts
vendored
4
dist/index.d.ts
vendored
@ -1,4 +1,4 @@
|
||||
export interface keyValueObject {
|
||||
export interface IKeyValueObject {
|
||||
key: string;
|
||||
value: string;
|
||||
}
|
||||
@ -6,6 +6,6 @@ export declare class Qenv {
|
||||
requiredEnvVars: string[];
|
||||
availableEnvVars: string[];
|
||||
missingEnvVars: string[];
|
||||
keyValueObjectArray: keyValueObject[];
|
||||
keyValueObjectArray: IKeyValueObject[];
|
||||
constructor(basePathArg: string, envYmlPathArg: any, failOnMissing?: boolean);
|
||||
}
|
||||
|
16
dist/index.js
vendored
16
dist/index.js
vendored
@ -10,14 +10,14 @@ class Qenv {
|
||||
getRequiredEnvVars(basePathArg, this.requiredEnvVars);
|
||||
getAvailableEnvVars(this.requiredEnvVars, envYmlPathArg, this.availableEnvVars, this.keyValueObjectArray);
|
||||
this.missingEnvVars = getMissingEnvVars(this.requiredEnvVars, this.availableEnvVars);
|
||||
//handle missing variables
|
||||
// handle missing variables
|
||||
if (this.missingEnvVars.length > 0) {
|
||||
plugins.beautylog.info("Required Env Vars are:");
|
||||
console.info('Required Env Vars are:');
|
||||
console.log(this.requiredEnvVars);
|
||||
plugins.beautylog.error("However some Env variables could not be resolved:");
|
||||
console.error('However some Env variables could not be resolved:');
|
||||
console.log(this.missingEnvVars);
|
||||
if (failOnMissing) {
|
||||
plugins.beautylog.error("Exiting!");
|
||||
console.error('Exiting!');
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
@ -27,7 +27,7 @@ class Qenv {
|
||||
exports.Qenv = Qenv;
|
||||
;
|
||||
let getRequiredEnvVars = (pathArg, requiredEnvVarsArray) => {
|
||||
let qenvFilePath = plugins.path.join(pathArg, "qenv.yml");
|
||||
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]);
|
||||
@ -35,13 +35,13 @@ let getRequiredEnvVars = (pathArg, requiredEnvVarsArray) => {
|
||||
;
|
||||
};
|
||||
let getAvailableEnvVars = (requiredEnvVarsArg, envYmlPathArg, availableEnvVarsArray, keyValueObjectArrayArg) => {
|
||||
envYmlPathArg = plugins.path.join(envYmlPathArg, "env.yml");
|
||||
envYmlPathArg = plugins.path.join(envYmlPathArg, 'env.yml');
|
||||
let envYml;
|
||||
try {
|
||||
envYml = plugins.smartfile.fs.toObjectSync(envYmlPathArg);
|
||||
}
|
||||
catch (err) {
|
||||
plugins.beautylog.log("env file couldn't be found at " + envYmlPathArg);
|
||||
console.log("env file couldn't be found at " + envYmlPathArg);
|
||||
envYml = {};
|
||||
}
|
||||
for (let requiredEnvVar of requiredEnvVarsArg) {
|
||||
@ -66,4 +66,4 @@ let getAvailableEnvVars = (requiredEnvVarsArg, envYmlPathArg, availableEnvVarsAr
|
||||
let getMissingEnvVars = (requiredEnvVarsArray, availableEnvVarsArray) => {
|
||||
return plugins.lodash.difference(requiredEnvVarsArray, availableEnvVarsArray);
|
||||
};
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsTUFBWSxPQUFPLFdBQU0sZ0JBQWdCLENBQUMsQ0FBQTtBQUt6QyxDQUFDO0FBRUY7SUFLSSxZQUFZLFdBQVcsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUMsYUFBYSxFQUFDLGFBQWEsR0FBRyxJQUFJO1FBSjFFLG9CQUFlLEdBQVksRUFBRSxDQUFDO1FBQzlCLHFCQUFnQixHQUFZLEVBQUUsQ0FBQztRQUMvQixtQkFBYyxHQUFZLEVBQUUsQ0FBQztRQUM3Qix3QkFBbUIsR0FBb0IsRUFBRSxDQUFDO1FBRXRDLGtCQUFrQixDQUFDLFdBQVcsRUFBQyxJQUFJLENBQUMsZUFBZSxDQUFDLENBQUM7UUFDckQsbUJBQW1CLENBQUMsSUFBSSxDQUFDLGVBQWUsRUFBQyxhQUFhLEVBQUMsSUFBSSxDQUFDLGdCQUFnQixFQUFDLElBQUksQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDO1FBQ3ZHLElBQUksQ0FBQyxjQUFjLEdBQUcsaUJBQWlCLENBQUMsSUFBSSxDQUFDLGVBQWUsRUFBQyxJQUFJLENBQUMsZ0JBQWdCLENBQUMsQ0FBQztRQUVwRiwwQkFBMEI7UUFDMUIsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxNQUFNLEdBQUcsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUNoQyxPQUFPLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyx3QkFBd0IsQ0FBQyxDQUFBO1lBQ2hELE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLGVBQWUsQ0FBQyxDQUFDO1lBQ2xDLE9BQU8sQ0FBQyxTQUFTLENBQUMsS0FBSyxDQUFDLG1EQUFtRCxDQUFDLENBQUM7WUFDN0UsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDakMsRUFBRSxDQUFBLENBQUMsYUFBYSxDQUFDLENBQUEsQ0FBQztnQkFDZCxPQUFPLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtnQkFDbkMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNwQixDQUFDO1FBQ0wsQ0FBQztJQUNMLENBQUM7O0FBQ0wsQ0FBQztBQXRCWSxZQUFJLE9Bc0JoQixDQUFBO0FBQUEsQ0FBQztBQUVGLElBQUksa0JBQWtCLEdBQUcsQ0FBQyxPQUFjLEVBQUUsb0JBQTZCO0lBQ25FLElBQUksWUFBWSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBQyxVQUFVLENBQUMsQ0FBQztJQUN6RCxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUM7SUFDL0QsR0FBRyxDQUFBLENBQUMsSUFBSSxNQUFNLElBQUksUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFBLENBQUM7UUFDN0Isb0JBQW9CLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztJQUNyRCxDQUFDO0lBQUEsQ0FBQztBQUNOLENBQUMsQ0FBQTtBQUlELElBQUksbUJBQW1CLEdBQUcsQ0FBQyxrQkFBMkIsRUFBQyxhQUFvQixFQUFDLHFCQUE4QixFQUFDLHNCQUF1QztJQUM5SSxhQUFhLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxFQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQzFELElBQUksTUFBTSxDQUFDO0lBQ1gsSUFBSSxDQUFDO1FBQ0QsTUFBTSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxhQUFhLENBQUMsQ0FBQztJQUM5RCxDQUNBO0lBQUEsS0FBSyxDQUFBLENBQUMsR0FBRyxDQUFDLENBQUEsQ0FBQztRQUNQLE9BQU8sQ0FBQyxTQUFTLENBQUMsR0FBRyxDQUFDLGdDQUFnQyxHQUFHLGFBQWEsQ0FBQyxDQUFBO1FBQ3ZFLE1BQU0sR0FBRyxFQUFFLENBQUM7SUFDaEIsQ0FBQztJQUNELEdBQUcsQ0FBQSxDQUFDLElBQUksY0FBYyxJQUFJLGtCQUFrQixDQUFDLENBQUEsQ0FBQztRQUMxQyxFQUFFLENBQUEsQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUEsQ0FBQztZQUM1QixxQkFBcUIsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDM0Msc0JBQXNCLENBQUMsSUFBSSxDQUFDO2dCQUN4QixHQUFHLEVBQUUsY0FBYztnQkFDbkIsS0FBSyxFQUFFLE9BQU8sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDO2FBQ3JDLENBQUMsQ0FBQztRQUNQLENBQUM7UUFBQyxJQUFJLENBQUMsRUFBRSxDQUFBLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0MsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMsR0FBRyxNQUFNLENBQUMsY0FBYyxDQUFDLENBQUM7WUFDckQscUJBQXFCLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFDO1lBQzNDLHNCQUFzQixDQUFDLElBQUksQ0FBQztnQkFDeEIsR0FBRyxFQUFFLGNBQWM7Z0JBQ25CLEtBQUssRUFBRSxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQzthQUNyQyxDQUFDLENBQUM7UUFDUCxDQUFDO0lBQ0wsQ0FBQztJQUFBLENBQUM7QUFDTixDQUFDLENBQUM7QUFFRixJQUFJLGlCQUFpQixHQUFHLENBQUMsb0JBQTZCLEVBQUMscUJBQThCO0lBQ2pGLE1BQU0sQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFVBQVUsQ0FBQyxvQkFBb0IsRUFBQyxxQkFBcUIsQ0FBQyxDQUFDO0FBQ2pGLENBQUMsQ0FBQyJ9
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMENBQXlDO0FBS3hDLENBQUM7QUFFRjtJQUtJLFlBQVksV0FBVyxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxhQUFhLEVBQUMsYUFBYSxHQUFHLElBQUk7UUFKMUUsb0JBQWUsR0FBYSxFQUFFLENBQUE7UUFDOUIscUJBQWdCLEdBQVksRUFBRSxDQUFBO1FBQzlCLG1CQUFjLEdBQVksRUFBRSxDQUFBO1FBQzVCLHdCQUFtQixHQUFxQixFQUFFLENBQUE7UUFFdEMsa0JBQWtCLENBQUMsV0FBVyxFQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtRQUNwRCxtQkFBbUIsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFDLGFBQWEsRUFBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLENBQUE7UUFDdEcsSUFBSSxDQUFDLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFBO1FBRW5GLDJCQUEyQjtRQUMzQixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQSxDQUFDO1lBQ2hDLE9BQU8sQ0FBQyxJQUFJLENBQUMsd0JBQXdCLENBQUMsQ0FBQTtZQUN0QyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtZQUNqQyxPQUFPLENBQUMsS0FBSyxDQUFDLG1EQUFtRCxDQUFDLENBQUE7WUFDbEUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUE7WUFDaEMsRUFBRSxDQUFDLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztnQkFDaEIsT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtnQkFDekIsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQTtZQUNuQixDQUFDO1FBQ0wsQ0FBQztJQUNMLENBQUM7SUFBQSxDQUFDO0NBQ0w7QUF0QkQsb0JBc0JDO0FBQUEsQ0FBQztBQUVGLElBQUksa0JBQWtCLEdBQUcsQ0FBQyxPQUFlLEVBQUUsb0JBQThCO0lBQ3JFLElBQUksWUFBWSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBQyxVQUFVLENBQUMsQ0FBQTtJQUN4RCxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDOUQsR0FBRyxDQUFDLENBQUMsSUFBSSxNQUFNLElBQUksUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDL0Isb0JBQW9CLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQTtJQUNwRCxDQUFDO0lBQUEsQ0FBQztBQUNOLENBQUMsQ0FBQTtBQUlELElBQUksbUJBQW1CLEdBQUcsQ0FBQyxrQkFBNEIsRUFBQyxhQUFxQixFQUFDLHFCQUErQixFQUFDLHNCQUF5QztJQUNuSixhQUFhLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsYUFBYSxFQUFDLFNBQVMsQ0FBQyxDQUFBO0lBQzFELElBQUksTUFBTSxDQUFBO0lBQ1YsSUFBSSxDQUFDO1FBQ0QsTUFBTSxHQUFHLE9BQU8sQ0FBQyxTQUFTLENBQUMsRUFBRSxDQUFDLFlBQVksQ0FBQyxhQUFhLENBQUMsQ0FBQTtJQUM3RCxDQUFDO0lBQUMsS0FBSyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQztRQUNYLE9BQU8sQ0FBQyxHQUFHLENBQUMsZ0NBQWdDLEdBQUcsYUFBYSxDQUFDLENBQUE7UUFDN0QsTUFBTSxHQUFHLEVBQUUsQ0FBQTtJQUNmLENBQUM7SUFDRCxHQUFHLENBQUMsQ0FBQyxJQUFJLGNBQWMsSUFBSSxrQkFBa0IsQ0FBQyxDQUFBLENBQUM7UUFDM0MsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUMsQ0FBQyxDQUFBLENBQUM7WUFDN0IscUJBQXFCLENBQUMsSUFBSSxDQUFDLGNBQWMsQ0FBQyxDQUFBO1lBQzFDLHNCQUFzQixDQUFDLElBQUksQ0FBQztnQkFDeEIsR0FBRyxFQUFFLGNBQWM7Z0JBQ25CLEtBQUssRUFBRSxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQzthQUNyQyxDQUFDLENBQUE7UUFDTixDQUFDO1FBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxjQUFjLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQSxDQUFDO1lBQzlDLE9BQU8sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLEdBQUcsTUFBTSxDQUFDLGNBQWMsQ0FBQyxDQUFBO1lBQ3BELHFCQUFxQixDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQTtZQUMxQyxzQkFBc0IsQ0FBQyxJQUFJLENBQUM7Z0JBQ3hCLEdBQUcsRUFBRSxjQUFjO2dCQUNuQixLQUFLLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUM7YUFDckMsQ0FBQyxDQUFBO1FBQ04sQ0FBQztJQUNMLENBQUM7SUFBQSxDQUFDO0FBQ04sQ0FBQyxDQUFBO0FBRUQsSUFBSSxpQkFBaUIsR0FBRyxDQUFDLG9CQUE4QixFQUFDLHFCQUErQjtJQUNuRixNQUFNLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxVQUFVLENBQUMsb0JBQW9CLEVBQUMscUJBQXFCLENBQUMsQ0FBQTtBQUNoRixDQUFDLENBQUEifQ==
|
7
dist/qenv.plugins.d.ts
vendored
7
dist/qenv.plugins.d.ts
vendored
@ -1,5 +1,4 @@
|
||||
import "typings-global";
|
||||
export import beautylog = require("beautylog");
|
||||
import 'typings-global';
|
||||
export declare let lodash: any;
|
||||
export import path = require("path");
|
||||
export import smartfile = require("smartfile");
|
||||
export import path = require('path');
|
||||
export import smartfile = require('smartfile');
|
||||
|
5
dist/qenv.plugins.js
vendored
5
dist/qenv.plugins.js
vendored
@ -1,7 +1,6 @@
|
||||
"use strict";
|
||||
require("typings-global");
|
||||
exports.beautylog = require("beautylog");
|
||||
exports.lodash = require("lodash");
|
||||
exports.lodash = require('lodash');
|
||||
exports.path = require("path");
|
||||
exports.smartfile = require("smartfile");
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvcWVudi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDVixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ3BDLGNBQU0sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7QUFDeEIsWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDO0FBQ3ZCLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUMifQ==
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvcWVudi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwQkFBd0I7QUFDYixRQUFBLE1BQU0sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7QUFDdEMsK0JBQXFDO0FBQ3JDLHlDQUE4QyJ9
|
17
package.json
17
package.json
@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "qenv",
|
||||
"version": "1.1.0",
|
||||
"description": "promised environments",
|
||||
"version": "1.1.2",
|
||||
"description": "easy promised environments",
|
||||
"main": "dist/index.js",
|
||||
"typings": "dist/index.d.ts",
|
||||
"scripts": {
|
||||
@ -23,15 +23,14 @@
|
||||
},
|
||||
"homepage": "https://gitlab.com/pushrocks/qenv#README",
|
||||
"devDependencies": {
|
||||
"npmts-g": "^5.2.8",
|
||||
"should": "^10.0.0",
|
||||
"typings-test": "^1.0.1"
|
||||
"npmts-g": "^6.0.0",
|
||||
"smartchai": "^1.0.1",
|
||||
"typings-test": "^1.0.3"
|
||||
},
|
||||
"dependencies": {
|
||||
"beautylog": "^5.0.20",
|
||||
"lodash": "^4.14.1",
|
||||
"lodash": "^4.17.4",
|
||||
"q": "^1.4.1",
|
||||
"smartfile": "^4.0.13",
|
||||
"typings-global": "^1.0.6"
|
||||
"smartfile": "^4.1.3",
|
||||
"typings-global": "^1.0.14"
|
||||
}
|
||||
}
|
||||
|
3
test/test.d.ts
vendored
3
test/test.d.ts
vendored
@ -1,2 +1 @@
|
||||
import "typings-test";
|
||||
import "should";
|
||||
import 'typings-test';
|
||||
|
26
test/test.js
26
test/test.js
@ -1,26 +1,26 @@
|
||||
"use strict";
|
||||
require("typings-test");
|
||||
const path = require("path");
|
||||
require("should");
|
||||
const smartchai_1 = require("smartchai");
|
||||
const index_1 = require("../dist/index");
|
||||
process.cwd = () => {
|
||||
return path.join(__dirname, "./assets/");
|
||||
return path.join(__dirname, './assets/');
|
||||
};
|
||||
process.env["key1"] = "original";
|
||||
process.env['key1'] = 'original';
|
||||
let qenvTestObject;
|
||||
describe("Qenv class", function () {
|
||||
it("should create a new class", function () {
|
||||
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 () {
|
||||
process.env.key1.should.equal("original");
|
||||
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 () {
|
||||
process.env.key2.should.equal("fromYml");
|
||||
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 () {
|
||||
qenvTestObject.keyValueObjectArray[0].value.should.equal("original");
|
||||
qenvTestObject.keyValueObjectArray[1].value.should.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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBWSxJQUFJLFdBQU0sTUFBTSxDQUFDLENBQUE7QUFDN0IsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUNoQix3QkFBbUIsZUFBZSxDQUFDLENBQUE7QUFFbkMsT0FBTyxDQUFDLEdBQUcsR0FBRztJQUNWLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxXQUFXLENBQUMsQ0FBQztBQUM1QyxDQUFDLENBQUE7QUFFRCxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFVBQVUsQ0FBQTtBQUVoQyxJQUFJLGNBQW1CLENBQUM7QUFDeEIsUUFBUSxDQUFDLFlBQVksRUFBQztJQUNsQixFQUFFLENBQUMsMkJBQTJCLEVBQUM7UUFDM0IsY0FBYyxHQUFHLElBQUksWUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUMsS0FBSyxDQUFDLENBQUM7SUFDakUsQ0FBQyxDQUFDLENBQUM7SUFDSCxFQUFFLENBQUMsK0RBQStELEVBQUM7UUFDL0QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM5QyxDQUFDLENBQUMsQ0FBQztJQUNILEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzdDLENBQUMsQ0FBQyxDQUFDO0lBQ0gsRUFBRSxDQUFDLHNEQUFzRCxFQUFDO1FBQ3RELGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUNyRSxjQUFjLENBQUMsbUJBQW1CLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDeEUsQ0FBQyxDQUFDLENBQUE7QUFFTixDQUFDLENBQUMsQ0FBQyJ9
|
||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQiw2QkFBNEI7QUFDNUIseUNBQWtDO0FBQ2xDLHlDQUFrQztBQUVsQyxPQUFPLENBQUMsR0FBRyxHQUFHO0lBQ1YsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFDLFdBQVcsQ0FBQyxDQUFBO0FBQzNDLENBQUMsQ0FBQTtBQUVELE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsVUFBVSxDQUFBO0FBRWhDLElBQUksY0FBbUIsQ0FBQTtBQUN2QixRQUFRLENBQUMsWUFBWSxFQUFDO0lBQ2xCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixjQUFjLEdBQUcsSUFBSSxZQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxLQUFLLENBQUMsQ0FBQTtJQUNoRSxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQywrREFBK0QsRUFBQztRQUMvRCxrQkFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUNqRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixrQkFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUNoRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxzREFBc0QsRUFBQztRQUN0RCxrQkFBTSxDQUFDLGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQ3hFLGtCQUFNLENBQUMsY0FBYyxDQUFDLG1CQUFtQixDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUE7SUFDM0UsQ0FBQyxDQUFDLENBQUE7QUFFTixDQUFDLENBQUMsQ0FBQSJ9
|
42
test/test.ts
42
test/test.ts
@ -1,28 +1,28 @@
|
||||
import "typings-test";
|
||||
import * as path from "path";
|
||||
import "should";
|
||||
import {Qenv} from "../dist/index";
|
||||
import 'typings-test'
|
||||
import * as path from 'path'
|
||||
import { expect } from 'smartchai'
|
||||
import {Qenv} from '../dist/index'
|
||||
|
||||
process.cwd = () => {
|
||||
return path.join(__dirname,"./assets/");
|
||||
return path.join(__dirname,'./assets/')
|
||||
}
|
||||
|
||||
process.env["key1"] = "original"
|
||||
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(){
|
||||
process.env.key1.should.equal("original");
|
||||
});
|
||||
it("key2 should be read from Yml",function(){
|
||||
process.env.key2.should.equal("fromYml");
|
||||
});
|
||||
it("keyValueObjectArray should hold all retrieved values",function(){
|
||||
qenvTestObject.keyValueObjectArray[0].value.should.equal("original");
|
||||
qenvTestObject.keyValueObjectArray[1].value.should.equal("fromYml");
|
||||
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')
|
||||
})
|
||||
|
||||
});
|
||||
})
|
85
ts/index.ts
85
ts/index.ts
@ -1,72 +1,71 @@
|
||||
import * as plugins from "./qenv.plugins";
|
||||
import * as plugins from "./qenv.plugins"
|
||||
|
||||
export interface keyValueObject {
|
||||
export interface IKeyValueObject {
|
||||
key: string,
|
||||
value: string
|
||||
};
|
||||
|
||||
export class Qenv {
|
||||
requiredEnvVars:string[] = [];
|
||||
availableEnvVars:string[] = [];
|
||||
missingEnvVars:string[] = [];
|
||||
keyValueObjectArray:keyValueObject[] = [];
|
||||
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
|
||||
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){
|
||||
plugins.beautylog.info("Required Env Vars are:")
|
||||
console.log(this.requiredEnvVars);
|
||||
plugins.beautylog.error("However some Env variables could not be resolved:");
|
||||
console.log(this.missingEnvVars);
|
||||
if(failOnMissing){
|
||||
plugins.beautylog.error("Exiting!")
|
||||
process.exit(1);
|
||||
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 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:keyValueObject[]) => {
|
||||
envYmlPathArg = plugins.path.join(envYmlPathArg,"env.yml")
|
||||
let envYml;
|
||||
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);
|
||||
envYml = plugins.smartfile.fs.toObjectSync(envYmlPathArg)
|
||||
} catch (err) {
|
||||
console.log("env file couldn't be found at " + envYmlPathArg)
|
||||
envYml = {}
|
||||
}
|
||||
catch(err){
|
||||
plugins.beautylog.log("env file couldn't be found at " + envYmlPathArg)
|
||||
envYml = {};
|
||||
}
|
||||
for(let requiredEnvVar of requiredEnvVarsArg){
|
||||
if(process.env[requiredEnvVar]){
|
||||
availableEnvVarsArray.push(requiredEnvVar);
|
||||
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);
|
||||
})
|
||||
} 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);
|
||||
};
|
||||
let getMissingEnvVars = (requiredEnvVarsArray: string[],availableEnvVarsArray: string[]) => {
|
||||
return plugins.lodash.difference(requiredEnvVarsArray,availableEnvVarsArray)
|
||||
}
|
||||
|
@ -1,5 +1,4 @@
|
||||
import "typings-global";
|
||||
export import beautylog = require("beautylog");
|
||||
export let lodash = require("lodash");
|
||||
export import path = require("path");
|
||||
export import smartfile = require("smartfile");
|
||||
import 'typings-global';
|
||||
export let lodash = require('lodash');
|
||||
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