4.0.11

.gitignore

@@ -1,4 +1,20 @@
-node_modules/
+.nogit/
+
+# artifacts
 coverage/
-pages/
 public/
+pages/
+
+# installs
+node_modules/
+
+# caches
+.yarn/
+.cache/
+.rpt2_cache
+
+# builds
+dist/
+dist_*/
+
+# custom

.gitlab-ci.yml

@@ -1,59 +1,127 @@
-image: hosttoday/ht-docker-node:npmts
+# gitzone ci_default
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+
+cache:
+  paths:
+    - .npmci_cache/
+  key: '$CI_BUILD_STAGE'
 
 stages:
-- test
+  - security
-- release
+  - test
-- trigger
+  - release
-- pages
+  - metadata
 
-testLEGACY:
+# ====================
+# security stage
+# ====================
+mirror:
+  stage: security
+  script:
+    - npmci git mirror
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+audit:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high
+  tags:
+    - lossless
+    - docker
+    - notpriv
+
+# ====================
+# test stage
+# ====================
+
+testStable:
   stage: test
   script:
-    - npmci test legacy
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci npm test
+  coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
     - docker
-  allow_failure: true
+    - priv
 
-testLTS:
+testBuild:
   stage: test
   script:
-    - npmci test lts
+    - npmci npm prepare
-  tags:
+    - npmci node install stable
-    - docker
+    - npmci npm install
-    
+    - npmci command npm run build
-testSTABLE:
+  coverage: /\d+.?\d+?\%\s*coverage/
-  stage: test
-  script:
-    - npmci test stable
   tags:
+    - lossless
     - docker
+    - notpriv
 
 release:
   stage: release
   script:
-    - npmci publish
+    - npmci node install stable
+    - npmci npm publish
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
+
+# ====================
+# metadata stage
+# ====================
+codequality:
+  stage: metadata
+  allow_failure: true
+  script:
+    - npmci command npm install -g tslint typescript
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
+  tags:
+    - lossless
+    - docker
+    - priv
 
 trigger:
-  stage: trigger
+  stage: metadata
   script:
     - npmci trigger
   only:
     - tags
   tags:
+    - lossless
     - docker
+    - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmpage
+  stage: metadata
-  stage: pages
   script:
-    - npmci command npmpage --publish gitlab
+    - npmci node install lts
+    - npmci command npm install -g @gitzone/tsdoc
+    - npmci npm prepare
+    - npmci npm install
+    - npmci command tsdoc
+  tags:
+    - lossless
+    - docker
+    - notpriv
   only:
     - tags
   artifacts:
     expire_in: 1 week
     paths:
-    - public
+      - public
+  allow_failure: true

.vscode/launch.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "current file",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "${relativeFile}"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    },
+    {
+      "name": "test.ts",
+      "type": "node",
+      "request": "launch",
+      "args": [
+        "test/test.ts"
+      ],
+      "runtimeArgs": ["-r", "@gitzone/tsrun"],
+      "cwd": "${workspaceRoot}",
+      "protocol": "inspector",
+      "internalConsoleOptions": "openOnSessionStart"
+    }
+  ]
+}

.vscode/settings.json

@@ -0,0 +1,26 @@
+{
+  "json.schemas": [
+    {
+      "fileMatch": ["/npmextra.json"],
+      "schema": {
+        "type": "object",
+        "properties": {
+          "npmci": {
+            "type": "object",
+            "description": "settings for npmci"
+          },
+          "gitzone": {
+            "type": "object",
+            "description": "settings for gitzone",
+            "properties": {
+              "projectType": {
+                "type": "string",
+                "enum": ["website", "element", "service", "npm"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,40 +0,0 @@
-# qenv
-easy promised environments
-
-## Availabililty
-[![npm](https://push.rocks/assets/repo-button-npm.svg)](https://www.npmjs.com/package/qenv)
-[![git](https://push.rocks/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/qenv)
-[![git](https://push.rocks/assets/repo-button-mirror.svg)](https://github.com/pushrocks/qenv)
-[![docs](https://push.rocks/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/qenv/)
-
-## Status for master
-[![build status](https://GitLab.com/pushrocks/qenv/badges/master/build.svg)](https://GitLab.com/pushrocks/qenv/commits/master)
-[![coverage report](https://GitLab.com/pushrocks/qenv/badges/master/coverage.svg)](https://GitLab.com/pushrocks/qenv/commits/master)
-[![npm downloads per month](https://img.shields.io/npm/dm/qenv.svg)](https://www.npmjs.com/package/qenv)
-[![Dependency Status](https://david-dm.org/pushrocks/qenv.svg)](https://david-dm.org/pushrocks/qenv)
-[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/qenv/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/qenv/master/dependencies/npm)
-[![bitHound Code](https://www.bithound.io/github/pushrocks/qenv/badges/code.svg)](https://www.bithound.io/github/pushrocks/qenv)
-[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
-[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](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(");
-
-``` 
-
-[![npm](https://push.rocks/assets/repo-header.svg)](https://push.rocks)

dist/index.d.ts

@@ -1,11 +0,0 @@
-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);
-}

dist/index.js

@@ -1,69 +0,0 @@
-"use strict";
-const plugins = require("./qenv.plugins");
-;
-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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsMENBQXlDO0FBS3hDLENBQUM7QUFFRjtJQUtJLFlBQVksV0FBVyxHQUFHLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxhQUFhLEVBQUMsYUFBYSxHQUFHLElBQUk7UUFKMUUsb0JBQWUsR0FBYSxFQUFFLENBQUE7UUFDOUIscUJBQWdCLEdBQWEsRUFBRSxDQUFBO1FBQy9CLG1CQUFjLEdBQWEsRUFBRSxDQUFBO1FBQzdCLHdCQUFtQixHQUFzQixFQUFFLENBQUE7UUFFdkMsa0JBQWtCLENBQUMsV0FBVyxFQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtRQUNwRCxtQkFBbUIsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFDLGFBQWEsRUFBQyxJQUFJLENBQUMsZ0JBQWdCLEVBQUMsSUFBSSxDQUFDLG1CQUFtQixDQUFDLENBQUE7UUFDdEcsSUFBSSxDQUFDLGNBQWMsR0FBRyxpQkFBaUIsQ0FBQyxJQUFJLENBQUMsZUFBZSxFQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxDQUFBO1FBRW5GLDJCQUEyQjtRQUMzQixFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLE1BQU0sR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQ2pDLE9BQU8sQ0FBQyxJQUFJLENBQUMsd0JBQXdCLENBQUMsQ0FBQTtZQUN0QyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxlQUFlLENBQUMsQ0FBQTtZQUNqQyxPQUFPLENBQUMsS0FBSyxDQUFDLG1EQUFtRCxDQUFDLENBQUE7WUFDbEUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUE7WUFDaEMsRUFBRSxDQUFDLENBQUMsYUFBYSxDQUFDLENBQUMsQ0FBQztnQkFDaEIsT0FBTyxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtnQkFDekIsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQTtZQUNuQixDQUFDO1FBQ0wsQ0FBQztJQUNMLENBQUM7SUFBQSxDQUFDO0NBQ0w7QUF0QkQsb0JBc0JDO0FBQUEsQ0FBQztBQUVGLElBQUksa0JBQWtCLEdBQUcsQ0FBQyxPQUFlLEVBQUUsb0JBQThCO0lBQ3JFLElBQUksWUFBWSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sRUFBQyxVQUFVLENBQUMsQ0FBQTtJQUN4RCxJQUFJLFFBQVEsR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsWUFBWSxDQUFDLENBQUE7SUFDOUQsR0FBRyxDQUFDLENBQUMsSUFBSSxNQUFNLElBQUksUUFBUSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7UUFDL0Isb0JBQW9CLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQTtJQUNwRCxDQUFDO0lBQUEsQ0FBQztBQUNOLENBQUMsQ0FBQTtBQUVELElBQUksbUJBQW1CLEdBQUcsQ0FDdEIsa0JBQTRCLEVBQzVCLGFBQXFCLEVBQ3JCLHFCQUErQixFQUMvQixzQkFBeUM7SUFFekMsYUFBYSxHQUFHLE9BQU8sQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLGFBQWEsRUFBQyxTQUFTLENBQUMsQ0FBQTtJQUMxRCxJQUFJLE1BQU0sQ0FBQTtJQUNWLElBQUksQ0FBQztRQUNELE1BQU0sR0FBRyxPQUFPLENBQUMsU0FBUyxDQUFDLEVBQUUsQ0FBQyxZQUFZLENBQUMsYUFBYSxDQUFDLENBQUE7SUFDN0QsQ0FBQztJQUFDLEtBQUssQ0FBQyxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7UUFDWCxPQUFPLENBQUMsR0FBRyxDQUFDLGdDQUFnQyxHQUFHLGFBQWEsQ0FBQyxDQUFBO1FBQzdELE1BQU0sR0FBRyxFQUFFLENBQUE7SUFDZixDQUFDO0lBQ0QsR0FBRyxDQUFDLENBQUMsSUFBSSxjQUFjLElBQUksa0JBQWtCLENBQUMsQ0FBQSxDQUFDO1FBQzNDLEVBQUUsQ0FBQyxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQzlCLHFCQUFxQixDQUFDLElBQUksQ0FBQyxjQUFjLENBQUMsQ0FBQTtZQUMxQyxzQkFBc0IsQ0FBQyxJQUFJLENBQUM7Z0JBQ3hCLEdBQUcsRUFBRSxjQUFjO2dCQUNuQixLQUFLLEVBQUUsT0FBTyxDQUFDLEdBQUcsQ0FBQyxjQUFjLENBQUM7YUFDckMsQ0FBQyxDQUFBO1FBQ04sQ0FBQztRQUFDLElBQUksQ0FBQyxFQUFFLENBQUMsQ0FBQyxNQUFNLENBQUMsY0FBYyxDQUFDLGNBQWMsQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUMvQyxPQUFPLENBQUMsR0FBRyxDQUFDLGNBQWMsQ0FBQyxHQUFHLE1BQU0sQ0FBQyxjQUFjLENBQUMsQ0FBQTtZQUNwRCxxQkFBcUIsQ0FBQyxJQUFJLENBQUMsY0FBYyxDQUFDLENBQUE7WUFDMUMsc0JBQXNCLENBQUMsSUFBSSxDQUFDO2dCQUN4QixHQUFHLEVBQUUsY0FBYztnQkFDbkIsS0FBSyxFQUFFLE9BQU8sQ0FBQyxHQUFHLENBQUMsY0FBYyxDQUFDO2FBQ3JDLENBQUMsQ0FBQTtRQUNOLENBQUM7SUFDTCxDQUFDO0lBQUEsQ0FBQztBQUNOLENBQUMsQ0FBQTtBQUVELElBQUksaUJBQWlCLEdBQUcsQ0FBQyxvQkFBOEIsRUFBQyxxQkFBK0I7SUFDbkYsTUFBTSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsVUFBVSxDQUFDLG9CQUFvQixFQUFDLHFCQUFxQixDQUFDLENBQUE7QUFDaEYsQ0FBQyxDQUFBIn0=

dist/qenv.plugins.d.ts

@@ -1,4 +0,0 @@
-import 'typings-global';
-export declare let lodash: any;
-export import path = require('path');
-export import smartfile = require('smartfile');

dist/qenv.plugins.js

@@ -1,6 +0,0 @@
-"use strict";
-require("typings-global");
-exports.lodash = require('lodash');
-exports.path = require("path");
-exports.smartfile = require("smartfile");
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicWVudi5wbHVnaW5zLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvcWVudi5wbHVnaW5zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7QUFBQSwwQkFBdUI7QUFDWixRQUFBLE1BQU0sR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDLENBQUE7QUFDckMsK0JBQW9DO0FBQ3BDLHlDQUE4QyJ9

npmextra.json

@@ -0,0 +1,17 @@
+{
+  "npmci": {
+    "npmGlobalTools": [],
+    "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "pushrocks",
+      "gitrepo": "qenv",
+      "description": "easy promised environments",
+      "npmPackagename": "@pushrocks/qenv",
+      "license": "MIT"
+    }
+  }
+}

npmts.json

@@ -1,3 +0,0 @@
-{
-    "mode":"default"
-}

package.json

@@ -1,11 +1,14 @@
 {
-  "name": "qenv",
+  "name": "@pushrocks/qenv",
-  "version": "1.1.3",
+  "version": "4.0.11",
+  "private": false,
   "description": "easy promised environments",
-  "main": "dist/index.js",
+  "main": "dist_ts/index.js",
-  "typings": "dist/index.d.ts",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
-    "test": "(npmts)"
+    "test": "(tstest test/)",
+    "build": "(tsbuild --web)"
   },
   "repository": {
     "type": "git",
@@ -23,13 +26,29 @@
   },
   "homepage": "https://gitlab.com/pushrocks/qenv#README",
   "devDependencies": {
-    "npmts-g": "^6.0.0",
+    "@gitzone/tsbuild": "^2.1.63",
-    "smartchai": "^1.0.1",
+    "@gitzone/tsrun": "^1.2.37",
-    "typings-test": "^1.0.3"
+    "@gitzone/tstest": "^1.0.72",
+    "@pushrocks/tapbundle": "^5.0.4",
+    "@types/node": "^18.6.2",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "lodash": "^4.17.4",
+    "@pushrocks/smartfile": "^10.0.4",
-    "smartfile": "^4.1.3",
+    "@pushrocks/smartlog": "^3.0.1",
-    "typings-global": "^1.0.14"
+    "@pushrocks/smartpath": "^5.0.5"
-  }
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -0,0 +1,54 @@
+# @pushrocks/qenv
+easy promised environments
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/qenv)
+* [gitlab.com (source)](https://gitlab.com/pushrocks/qenv)
+* [github.com (source mirror)](https://github.com/pushrocks/qenv)
+* [docs (typedoc)](https://pushrocks.gitlab.io/qenv/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/qenv/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/qenv/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/qenv)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/qenv)](https://lossless.cloud)
+TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
+node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
+Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
+PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/qenv)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/qenv)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/qenv)](https://lossless.cloud)
+Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
+
+## 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';
+
+const myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env.yml/is(');
+```
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
+For further information read the linked docs at the top of this readme.
+
+> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
+
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/assets/env.json

@@ -0,0 +1,4 @@
+{
+  "key1": "fromJson",
+  "key2" :"fromJson"
+}

test/assets/env.yml

@@ -1,2 +0,0 @@
-key1: fromYml
-key2: fromYml

test/assets/qenv.yml

@@ -1,4 +1,4 @@
-vars:
+required:
   - key1
   - key2
   - key3

test/test.d.ts

@@ -1 +0,0 @@
-import 'typings-test';

test/test.js

@@ -1,26 +0,0 @@
-"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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidGVzdC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbInRlc3QudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLHdCQUFxQjtBQUNyQiw2QkFBNEI7QUFDNUIseUNBQWtDO0FBQ2xDLHlDQUFrQztBQUVsQyxPQUFPLENBQUMsR0FBRyxHQUFHO0lBQ1YsTUFBTSxDQUFDLElBQUksQ0FBQyxJQUFJLENBQUMsU0FBUyxFQUFDLFdBQVcsQ0FBQyxDQUFBO0FBQzNDLENBQUMsQ0FBQTtBQUVELE9BQU8sQ0FBQyxHQUFHLENBQUMsTUFBTSxDQUFDLEdBQUcsVUFBVSxDQUFBO0FBRWhDLElBQUksY0FBb0IsQ0FBQTtBQUN4QixRQUFRLENBQUMsWUFBWSxFQUFDO0lBQ2xCLEVBQUUsQ0FBQywyQkFBMkIsRUFBQztRQUMzQixjQUFjLEdBQUcsSUFBSSxZQUFJLENBQUMsT0FBTyxDQUFDLEdBQUcsRUFBRSxFQUFDLE9BQU8sQ0FBQyxHQUFHLEVBQUUsRUFBQyxLQUFLLENBQUMsQ0FBQTtJQUNoRSxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQywrREFBK0QsRUFBQztRQUMvRCxrQkFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxVQUFVLENBQUMsQ0FBQTtJQUNqRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyw4QkFBOEIsRUFBQztRQUM5QixrQkFBTSxDQUFDLE9BQU8sQ0FBQyxHQUFHLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRSxDQUFDLEtBQUssQ0FBQyxTQUFTLENBQUMsQ0FBQTtJQUNoRCxDQUFDLENBQUMsQ0FBQTtJQUNGLEVBQUUsQ0FBQyxzREFBc0QsRUFBQztRQUN0RCxrQkFBTSxDQUFDLGNBQWMsQ0FBQyxtQkFBbUIsQ0FBQyxDQUFDLENBQUMsQ0FBQyxLQUFLLENBQUMsQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxDQUFBO1FBQ3hFLGtCQUFNLENBQUMsY0FBYyxDQUFDLG1CQUFtQixDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDLENBQUE7SUFDM0UsQ0FBQyxDQUFDLENBQUE7QUFFTixDQUFDLENBQUMsQ0FBQSJ9

test/test.ts

@@ -1,28 +1,38 @@
-import 'typings-test'
+import * as path from 'path';
-import * as path from 'path'
+import { tap, expect } from '@pushrocks/tapbundle';
-import { expect } from 'smartchai'
+import * as qenv from '../ts/index.js';
-import {Qenv} from '../dist/index'
 
-process.cwd = () => {
+import * as smartpath from '@pushrocks/smartpath';
-    return path.join(__dirname,'./assets/')
+
+export {
+  smartpath
 }
 
-process.env['key1'] = 'original'
+const __dirname = smartpath.get.dirnameFromImportMetaUrl(import.meta.url);
 
-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')
-    })
 
-})
+process.env['key1'] = 'original';
+
+let testQenv: qenv.Qenv;
+
+tap.test('should create a new class', async () => {
+  testQenv = new qenv.Qenv(path.join(__dirname, 'assets'), path.join(__dirname, 'assets'), false);
+  expect(testQenv).toBeInstanceOf(qenv.Qenv);
+});
+
+tap.test('key1 should be not be overwritten since it is already present', async () => {
+  expect(testQenv.getEnvVarRequired('key1')).toEqual('original');
+  expect(testQenv.getEnvVarOnDemand('key1')).toEqual('original');
+});
+
+tap.test('key2 should be read from Yml', async () => {
+  expect(testQenv.getEnvVarRequired('key2')).toEqual('fromJson');
+  expect(testQenv.getEnvVarOnDemand('key2')).toEqual('fromJson');
+});
+
+tap.test('keyValueObjectArray should hold all retrieved values', async () => {
+  expect(testQenv.keyValueObject.key1).toEqual('original');
+  expect(testQenv.keyValueObject.key2).toEqual('fromJson');
+});
+
+tap.start();

ts/00_commitinfo_data.ts

@@ -0,0 +1,8 @@
+/**
+ * autocreated commitinfo by @pushrocks/commitinfo
+ */
+export const commitinfo = {
+  name: '@pushrocks/qenv',
+  version: '4.0.11',
+  description: 'easy promised environments'
+}

ts/index.ts

@@ -1,74 +1 @@
-import * as plugins from './qenv.plugins'
+export * from './qenv.classes.qenv.js';
-
-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)
-}

ts/qenv.classes.qenv.ts

@@ -0,0 +1,195 @@
+import * as plugins from './qenv.plugins.js';
+
+/**
+ * class Qenv
+ * allows to make assertions about the environments while being more flexibel in how to meet them
+ */
+export class Qenv {
+  public requiredEnvVars: string[] = [];
+  public availableEnvVars: string[] = [];
+  public missingEnvVars: string[] = [];
+  public keyValueObject: { [key: string]: any } = {};
+  public logger = new plugins.smartlog.ConsoleLog();
+
+  // filePaths
+  public qenvFilePathAbsolute: string;
+  public envFilePathAbsolute: string;
+
+  constructor(qenvFileBasePathArg = process.cwd(), envFileBasePathArg, failOnMissing = true) {
+    // lets make sure paths are absolute
+    this.qenvFilePathAbsolute = plugins.path.join(
+      plugins.path.resolve(qenvFileBasePathArg),
+      'qenv.yml'
+    );
+    this.envFilePathAbsolute = plugins.path.join(
+      plugins.path.resolve(envFileBasePathArg),
+      'env.json'
+    );
+
+    this.getRequiredEnvVars();
+    this.getAvailableEnvVars();
+
+    this.missingEnvVars = this.getMissingEnvVars();
+
+    // 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) {
+        this.logger.log('error', 'Exiting!');
+        process.exit(1);
+      } else {
+        this.logger.log('warn', 'qenv is not set to fail on missing environment variables');
+      }
+    }
+  }
+
+  /**
+   * only gets an environment variable if it is required within a read qenv.yml file
+   * @param envVarName
+   */
+  public getEnvVarRequired(envVarName): string {
+    return this.keyValueObject[envVarName];
+  }
+
+  /**
+   * tries to get any env var even if it is not required
+   * @param wantedEnvVar
+   */
+  public getEnvVarOnDemand(wantedEnvVar: string): string {
+    let envVarFromEnvironmentVariable: string;
+    let envVarFromEnvJsonFile: string;
+    let envVarFromDockerSecret: string;
+    let dockerSecretJson: string;
+
+    // env var check
+    if (process.env[wantedEnvVar]) {
+      this.availableEnvVars.push(wantedEnvVar);
+      envVarFromEnvironmentVariable = process.env[wantedEnvVar];
+    }
+
+    // env file check
+    // lets determine the actual env yml
+    let envJsonFileAsObject;
+    try {
+      envJsonFileAsObject = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
+    } catch (err) {
+      envJsonFileAsObject = {};
+    }
+    if (envJsonFileAsObject.hasOwnProperty(wantedEnvVar)) {
+      envVarFromEnvJsonFile = envJsonFileAsObject[wantedEnvVar];
+    }
+
+    // docker secret check
+    if (
+      plugins.smartfile.fs.isDirectory('/run') &&
+      plugins.smartfile.fs.isDirectory('/run/secrets') &&
+      plugins.smartfile.fs.fileExistsSync(`/run/secrets/${wantedEnvVar}`)
+    ) {
+      envVarFromDockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${wantedEnvVar}`);
+    }
+
+    // docker secret.json
+    if (
+      plugins.smartfile.fs.isDirectory('/run') &&
+      plugins.smartfile.fs.isDirectory('/run/secrets')
+    ) {
+      const availableSecrets = plugins.smartfile.fs.listAllItemsSync('/run/secrets');
+      for (const secret of availableSecrets) {
+        if (secret.includes('secret.json') && !envVarFromDockerSecret) {
+          const secretObject = plugins.smartfile.fs.toObjectSync(`/run/secrets/${secret}`);
+          envVarFromDockerSecret = secretObject[wantedEnvVar];
+        }
+      }
+    }
+
+    // warn if there is more than one candidate
+    const availableCcandidates: any[] = [];
+    [
+      envVarFromEnvironmentVariable,
+      envVarFromEnvJsonFile,
+      envVarFromDockerSecret,
+      dockerSecretJson
+    ].forEach(candidate => {
+      if (candidate) {
+        availableCcandidates.push(candidate);
+      }
+    });
+    if (availableCcandidates.length > 1) {
+      this.logger.log(
+        'warn',
+        `found multiple candidates for ${wantedEnvVar} Choosing in the order of envVar, envFileVar, dockerSecret, dockerSecretJson`
+      );
+      console.log(availableCcandidates);
+    }
+
+    switch (true) {
+      case !!envVarFromEnvironmentVariable:
+        this.logger.log('ok', `found ${wantedEnvVar} as environment variable`);
+        return envVarFromEnvironmentVariable;
+      case !!envVarFromEnvJsonFile:
+        this.logger.log('ok', `found ${wantedEnvVar} as env.json variable`);
+        return envVarFromEnvJsonFile;
+      case !!envVarFromDockerSecret:
+        this.logger.log('ok', `found ${wantedEnvVar} as docker secret`);
+        return envVarFromDockerSecret;
+      case !!dockerSecretJson:
+        this.logger.log('ok', `found ${wantedEnvVar} as docker secret.json`);
+        return dockerSecretJson;
+      default:
+        this.logger.log(
+          'warn',
+          `could not find the wanted environment variable ${wantedEnvVar} anywhere`
+        );
+        return;
+    }
+  }
+
+  /**
+   * gets the required env values
+   */
+  private getRequiredEnvVars = () => {
+    let qenvFile: any = {};
+    if (plugins.smartfile.fs.fileExistsSync(this.qenvFilePathAbsolute)) {
+      qenvFile = plugins.smartfile.fs.toObjectSync(this.qenvFilePathAbsolute);
+    }
+    if (!qenvFile || !qenvFile.required || !Array.isArray(qenvFile.required)) {
+      this.logger.log(
+        'warn',
+        `qenv (promised environment): ./qenv.yml File does not contain a 'required' Array! This might be ok though.`
+      );
+    } else {
+      for (const keyArg of Object.keys(qenvFile.required)) {
+        this.requiredEnvVars.push(qenvFile.required[keyArg]);
+      }
+    }
+  };
+
+  /**
+   * gets the available env vars
+   */
+  private getAvailableEnvVars = () => {
+    for (const requiredEnvVar of this.requiredEnvVars) {
+      const chosenVar = this.getEnvVarOnDemand(requiredEnvVar);
+      if (chosenVar) {
+        this.availableEnvVars.push(requiredEnvVar);
+        this.keyValueObject[requiredEnvVar] = chosenVar;
+      }
+    }
+  };
+
+  /**
+   * gets missing env vars
+   */
+  private getMissingEnvVars = (): string[] => {
+    const missingEnvVars: string[] = [];
+    for (const envVar of this.requiredEnvVars) {
+      if (!this.availableEnvVars.includes(envVar)) {
+        missingEnvVars.push(envVar);
+      }
+    }
+    return missingEnvVars;
+  };
+}

ts/qenv.plugins.ts

@@ -1,4 +1,10 @@
-import 'typings-global'
+// native
-export let lodash = require('lodash')
+import * as path from 'path';
-export import path = require('path')
+
-export import smartfile = require('smartfile')
+export { path };
+
+// @pushrocks scope
+import * as smartfile from '@pushrocks/smartfile';
+import * as smartlog from '@pushrocks/smartlog';
+
+export { smartfile, smartlog };

tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "useDefineForClassFields": false,
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "nodenext",
+    "esModuleInterop": true
+  }
+}

tslint.json

@@ -1,3 +0,0 @@
-{
-    "extends": "tslint-config-standard"
-}