add keyValueObjectArray
This commit is contained in:
		
							
								
								
									
										5
									
								
								dist/index.d.ts
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										5
									
								
								dist/index.d.ts
									
									
									
									
										vendored
									
									
								
							@@ -1,6 +1,11 @@
 | 
			
		||||
export interface keyValueObject {
 | 
			
		||||
    key: string;
 | 
			
		||||
    value: string;
 | 
			
		||||
}
 | 
			
		||||
export declare class Qenv {
 | 
			
		||||
    requiredEnvVars: string[];
 | 
			
		||||
    availableEnvVars: string[];
 | 
			
		||||
    missingEnvVars: string[];
 | 
			
		||||
    keyValueObjectArray: keyValueObject[];
 | 
			
		||||
    constructor(basePathArg: string, envYmlPathArg: any, failOnMissing?: boolean);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										63
									
								
								dist/index.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										63
									
								
								dist/index.js
									
									
									
									
										vendored
									
									
								
							
										
											
												File diff suppressed because one or more lines are too long
											
										
									
								
							
							
								
								
									
										3
									
								
								dist/qenv.plugins.js
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								dist/qenv.plugins.js
									
									
									
									
										vendored
									
									
								
							@@ -4,5 +4,4 @@ exports.beautylog = require("beautylog");
 | 
			
		||||
exports.lodash = require("lodash");
 | 
			
		||||
exports.path = require("path");
 | 
			
		||||
exports.smartfile = require("smartfile");
 | 
			
		||||
 | 
			
		||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInFlbnYucGx1Z2lucy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsUUFBTyxnQkFBZ0IsQ0FBQyxDQUFBO0FBQ1YsaUJBQVMsV0FBVyxXQUFXLENBQUMsQ0FBQztBQUNwQyxjQUFNLEdBQUcsT0FBTyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0FBQ3hCLFlBQUksV0FBVyxNQUFNLENBQUMsQ0FBQztBQUN2QixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDIiwiZmlsZSI6InFlbnYucGx1Z2lucy5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInR5cGluZ3MtZ2xvYmFsXCI7XG5leHBvcnQgaW1wb3J0IGJlYXV0eWxvZyA9IHJlcXVpcmUoXCJiZWF1dHlsb2dcIik7XG5leHBvcnQgbGV0IGxvZGFzaCA9IHJlcXVpcmUoXCJsb2Rhc2hcIik7XG5leHBvcnQgaW1wb3J0IHBhdGggPSByZXF1aXJlKFwicGF0aFwiKTtcbmV4cG9ydCBpbXBvcnQgc21hcnRmaWxlID0gcmVxdWlyZShcInNtYXJ0ZmlsZVwiKTtcbiJdfQ==
 | 
			
		||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvcWVudi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSxRQUFPLGdCQUFnQixDQUFDLENBQUE7QUFDVixpQkFBUyxXQUFXLFdBQVcsQ0FBQyxDQUFDO0FBQ3BDLGNBQU0sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUM7QUFDeEIsWUFBSSxXQUFXLE1BQU0sQ0FBQyxDQUFDO0FBQ3ZCLGlCQUFTLFdBQVcsV0FBVyxDQUFDLENBQUMifQ==
 | 
			
		||||
							
								
								
									
										12
									
								
								package.json
									
									
									
									
									
								
							
							
						
						
									
										12
									
								
								package.json
									
									
									
									
									
								
							@@ -23,15 +23,15 @@
 | 
			
		||||
  },
 | 
			
		||||
  "homepage": "https://gitlab.com/pushrocks/qenv#README",
 | 
			
		||||
  "devDependencies": {
 | 
			
		||||
    "npmts-g": "^5.2.6",
 | 
			
		||||
    "should": "^9.0.2",
 | 
			
		||||
    "npmts-g": "^5.2.8",
 | 
			
		||||
    "should": "^10.0.0",
 | 
			
		||||
    "typings-test": "^1.0.1"
 | 
			
		||||
  },
 | 
			
		||||
  "dependencies": {
 | 
			
		||||
    "beautylog": "^5.0.12",
 | 
			
		||||
    "lodash": "^4.13.1",
 | 
			
		||||
    "beautylog": "^5.0.20",
 | 
			
		||||
    "lodash": "^4.14.1",
 | 
			
		||||
    "q": "^1.4.1",
 | 
			
		||||
    "smartfile": "^3.0.10",
 | 
			
		||||
    "typings-global": "^1.0.3"
 | 
			
		||||
    "smartfile": "^4.0.13",
 | 
			
		||||
    "typings-global": "^1.0.6"
 | 
			
		||||
  }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										15
									
								
								test/test.js
									
									
									
									
									
								
							
							
						
						
									
										15
									
								
								test/test.js
									
									
									
									
									
								
							@@ -1,13 +1,13 @@
 | 
			
		||||
"use strict";
 | 
			
		||||
require("typings-test");
 | 
			
		||||
var path = require("path");
 | 
			
		||||
const path = require("path");
 | 
			
		||||
require("should");
 | 
			
		||||
var index_1 = require("../dist/index");
 | 
			
		||||
process.cwd = function () {
 | 
			
		||||
const index_1 = require("../dist/index");
 | 
			
		||||
process.cwd = () => {
 | 
			
		||||
    return path.join(__dirname, "./assets/");
 | 
			
		||||
};
 | 
			
		||||
process.env["key1"] = "original";
 | 
			
		||||
var qenvTestObject;
 | 
			
		||||
let qenvTestObject;
 | 
			
		||||
describe("Qenv class", function () {
 | 
			
		||||
    it("should create a new class", function () {
 | 
			
		||||
        qenvTestObject = new index_1.Qenv(process.cwd(), process.cwd(), false);
 | 
			
		||||
@@ -18,6 +18,9 @@ describe("Qenv class", function () {
 | 
			
		||||
    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");
 | 
			
		||||
    });
 | 
			
		||||
});
 | 
			
		||||
 | 
			
		||||
//# sourceMappingURL=data:application/json;charset=utf8;base64,eyJ2ZXJzaW9uIjozLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsSUFBWSxJQUFJLFdBQU0sTUFBTSxDQUFDLENBQUE7QUFDN0IsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUNoQixzQkFBbUIsZUFBZSxDQUFDLENBQUE7QUFFbkMsT0FBTyxDQUFDLEdBQUcsR0FBRztJQUNWLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxXQUFXLENBQUMsQ0FBQztBQUM1QyxDQUFDLENBQUE7QUFFRCxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFVBQVUsQ0FBQTtBQUVoQyxJQUFJLGNBQW1CLENBQUM7QUFDeEIsUUFBUSxDQUFDLFlBQVksRUFBQztJQUNsQixFQUFFLENBQUMsMkJBQTJCLEVBQUM7UUFDM0IsY0FBYyxHQUFHLElBQUksWUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUMsS0FBSyxDQUFDLENBQUM7SUFDakUsQ0FBQyxDQUFDLENBQUM7SUFDSCxFQUFFLENBQUMsK0RBQStELEVBQUM7UUFDL0QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM5QyxDQUFDLENBQUMsQ0FBQztJQUNILEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzdDLENBQUMsQ0FBQyxDQUFBO0FBRU4sQ0FBQyxDQUFDLENBQUMiLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBcInR5cGluZ3MtdGVzdFwiO1xuaW1wb3J0ICogYXMgcGF0aCBmcm9tIFwicGF0aFwiO1xuaW1wb3J0IFwic2hvdWxkXCI7XG5pbXBvcnQge1FlbnZ9IGZyb20gXCIuLi9kaXN0L2luZGV4XCI7XG5cbnByb2Nlc3MuY3dkID0gKCkgPT4ge1xuICAgIHJldHVybiBwYXRoLmpvaW4oX19kaXJuYW1lLFwiLi9hc3NldHMvXCIpO1xufVxuXG5wcm9jZXNzLmVudltcImtleTFcIl0gPSBcIm9yaWdpbmFsXCJcblxubGV0IHFlbnZUZXN0T2JqZWN0OlFlbnY7XG5kZXNjcmliZShcIlFlbnYgY2xhc3NcIixmdW5jdGlvbigpe1xuICAgIGl0KFwic2hvdWxkIGNyZWF0ZSBhIG5ldyBjbGFzc1wiLGZ1bmN0aW9uKCl7XG4gICAgICAgIHFlbnZUZXN0T2JqZWN0ID0gbmV3IFFlbnYocHJvY2Vzcy5jd2QoKSxwcm9jZXNzLmN3ZCgpLGZhbHNlKTtcbiAgICB9KTtcbiAgICBpdChcImtleTEgc2hvdWxkIGJlIG5vdCBiZSBvdmVyd3JpdHRlbiBzaW5jZSBpdCBpcyBhbHJlYWR5IHByZXNlbnRcIixmdW5jdGlvbigpe1xuICAgICAgICBwcm9jZXNzLmVudi5rZXkxLnNob3VsZC5lcXVhbChcIm9yaWdpbmFsXCIpO1xuICAgIH0pO1xuICAgIGl0KFwia2V5MiBzaG91bGQgYmUgcmVhZCBmcm9tIFltbFwiLGZ1bmN0aW9uKCl7XG4gICAgICAgIHByb2Nlc3MuZW52LmtleTIuc2hvdWxkLmVxdWFsKFwiZnJvbVltbFwiKTtcbiAgICB9KVxuXG59KTsiXX0=
 | 
			
		||||
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLFFBQU8sY0FBYyxDQUFDLENBQUE7QUFDdEIsTUFBWSxJQUFJLFdBQU0sTUFBTSxDQUFDLENBQUE7QUFDN0IsUUFBTyxRQUFRLENBQUMsQ0FBQTtBQUNoQix3QkFBbUIsZUFBZSxDQUFDLENBQUE7QUFFbkMsT0FBTyxDQUFDLEdBQUcsR0FBRztJQUNWLE1BQU0sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsRUFBQyxXQUFXLENBQUMsQ0FBQztBQUM1QyxDQUFDLENBQUE7QUFFRCxPQUFPLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxHQUFHLFVBQVUsQ0FBQTtBQUVoQyxJQUFJLGNBQW1CLENBQUM7QUFDeEIsUUFBUSxDQUFDLFlBQVksRUFBQztJQUNsQixFQUFFLENBQUMsMkJBQTJCLEVBQUM7UUFDM0IsY0FBYyxHQUFHLElBQUksWUFBSSxDQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxPQUFPLENBQUMsR0FBRyxFQUFFLEVBQUMsS0FBSyxDQUFDLENBQUM7SUFDakUsQ0FBQyxDQUFDLENBQUM7SUFDSCxFQUFFLENBQUMsK0RBQStELEVBQUM7UUFDL0QsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztJQUM5QyxDQUFDLENBQUMsQ0FBQztJQUNILEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLFNBQVMsQ0FBQyxDQUFDO0lBQzdDLENBQUMsQ0FBQyxDQUFDO0lBQ0gsRUFBRSxDQUFDLHNEQUFzRCxFQUFDO1FBQ3RELGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQztRQUNyRSxjQUFjLENBQUMsbUJBQW1CLENBQUMsQ0FBQyxDQUFDLENBQUMsS0FBSyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUM7SUFDeEUsQ0FBQyxDQUFDLENBQUE7QUFFTixDQUFDLENBQUMsQ0FBQyJ9
 | 
			
		||||
@@ -19,6 +19,10 @@ describe("Qenv class",function(){
 | 
			
		||||
    });
 | 
			
		||||
    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");
 | 
			
		||||
    })
 | 
			
		||||
 | 
			
		||||
});
 | 
			
		||||
							
								
								
									
										57
									
								
								ts/index.ts
									
									
									
									
									
								
							
							
						
						
									
										57
									
								
								ts/index.ts
									
									
									
									
									
								
							@@ -1,12 +1,18 @@
 | 
			
		||||
import * as plugins from "./qenv.plugins";
 | 
			
		||||
 | 
			
		||||
export interface keyValueObject {
 | 
			
		||||
    key: string,
 | 
			
		||||
    value: string
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
export class Qenv {
 | 
			
		||||
    requiredEnvVars:string[];
 | 
			
		||||
    availableEnvVars:string[];
 | 
			
		||||
    missingEnvVars:string[];
 | 
			
		||||
    requiredEnvVars:string[] = [];
 | 
			
		||||
    availableEnvVars:string[] = [];
 | 
			
		||||
    missingEnvVars:string[] = [];
 | 
			
		||||
    keyValueObjectArray:keyValueObject[] = [];
 | 
			
		||||
    constructor(basePathArg = process.cwd(),envYmlPathArg,failOnMissing = true){
 | 
			
		||||
        this.requiredEnvVars = getRequiredEnvVars(basePathArg);
 | 
			
		||||
        this.availableEnvVars = getAvailableEnvVars(this.requiredEnvVars,envYmlPathArg);
 | 
			
		||||
        getRequiredEnvVars(basePathArg,this.requiredEnvVars);
 | 
			
		||||
        getAvailableEnvVars(this.requiredEnvVars,envYmlPathArg,this.availableEnvVars,this.keyValueObjectArray);
 | 
			
		||||
        this.missingEnvVars = getMissingEnvVars(this.requiredEnvVars,this.availableEnvVars);
 | 
			
		||||
        
 | 
			
		||||
        //handle missing variables
 | 
			
		||||
@@ -20,42 +26,47 @@ export class Qenv {
 | 
			
		||||
                process.exit(1);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
    };
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
let getRequiredEnvVars = (pathArg:string):string[] => {
 | 
			
		||||
    let result:string[] = [];
 | 
			
		||||
let getRequiredEnvVars = (pathArg:string, requiredEnvVarsArray:string[]) => {
 | 
			
		||||
    let qenvFilePath = plugins.path.join(pathArg,"qenv.yml");
 | 
			
		||||
    let qenvFile = plugins.smartfile.local.toObjectSync(qenvFilePath);
 | 
			
		||||
    let qenvFile = plugins.smartfile.fs.toObjectSync(qenvFilePath);
 | 
			
		||||
    for(let keyArg in qenvFile.vars){
 | 
			
		||||
        result.push(qenvFile.vars[keyArg]);
 | 
			
		||||
    }
 | 
			
		||||
    return result;
 | 
			
		||||
        requiredEnvVarsArray.push(qenvFile.vars[keyArg]);
 | 
			
		||||
    };
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
let getAvailableEnvVars = (requiredEnvVarsArg:string[],envYmlPathArg:string):string[] => {
 | 
			
		||||
    let result = [];
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
let getAvailableEnvVars = (requiredEnvVarsArg:string[],envYmlPathArg:string,availableEnvVarsArray:string[],keyValueObjectArrayArg:keyValueObject[]) => {
 | 
			
		||||
    envYmlPathArg = plugins.path.join(envYmlPathArg,"env.yml")
 | 
			
		||||
    let envYml;
 | 
			
		||||
    try {
 | 
			
		||||
        envYml = plugins.smartfile.local.toObjectSync(envYmlPathArg);
 | 
			
		||||
        envYml = plugins.smartfile.fs.toObjectSync(envYmlPathArg);
 | 
			
		||||
    }
 | 
			
		||||
    catch(err){
 | 
			
		||||
        plugins.beautylog.log("env file couldn't be found at " + envYmlPathArg)
 | 
			
		||||
        envYml = {};
 | 
			
		||||
    }
 | 
			
		||||
    for(let keyArg in requiredEnvVarsArg){
 | 
			
		||||
        let requiredEnvVar:string = requiredEnvVarsArg[keyArg];
 | 
			
		||||
    for(let requiredEnvVar of requiredEnvVarsArg){
 | 
			
		||||
        if(process.env[requiredEnvVar]){
 | 
			
		||||
            result.push(requiredEnvVar);
 | 
			
		||||
            availableEnvVarsArray.push(requiredEnvVar);
 | 
			
		||||
            keyValueObjectArrayArg.push({
 | 
			
		||||
                key: requiredEnvVar,
 | 
			
		||||
                value: process.env[requiredEnvVar]
 | 
			
		||||
            });
 | 
			
		||||
        } else if(envYml.hasOwnProperty(requiredEnvVar)){
 | 
			
		||||
            process.env[requiredEnvVar] = envYml[requiredEnvVar];
 | 
			
		||||
            result.push(requiredEnvVar);
 | 
			
		||||
            availableEnvVarsArray.push(requiredEnvVar);
 | 
			
		||||
            keyValueObjectArrayArg.push({
 | 
			
		||||
                key: requiredEnvVar,
 | 
			
		||||
                value: process.env[requiredEnvVar]
 | 
			
		||||
            });
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
    return result;
 | 
			
		||||
}
 | 
			
		||||
    };
 | 
			
		||||
};
 | 
			
		||||
 | 
			
		||||
let getMissingEnvVars = (requiredEnvVarsArray:string[],availableEnvVarsArray:string[]) => {
 | 
			
		||||
    return plugins.lodash.difference(requiredEnvVarsArray,availableEnvVarsArray);
 | 
			
		||||
}
 | 
			
		||||
};
 | 
			
		||||
		Reference in New Issue
	
	Block a user