6.0.0

.gitea/workflows/default_nottags.yaml

@@ -0,0 +1,66 @@
+name: Default (not tags)
+
+on:
+  push:
+    tags-ignore:
+      - '**'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm and npmci
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+
+      - name: Run npm prepare
+        run: npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build

.gitea/workflows/default_tags.yaml

@@ -0,0 +1,124 @@
+name: Default (tags)
+
+on:
+  push:
+    tags:
+      - '*'
+
+env:
+  IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
+  NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
+  NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
+  NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
+  NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
+
+jobs:
+  security:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Audit production dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --prod
+        continue-on-error: true
+
+      - name: Audit development dependencies
+        run: |
+          npmci command npm config set registry https://registry.npmjs.org
+          npmci command pnpm audit --audit-level=high --dev
+        continue-on-error: true
+
+  test:
+    if: ${{ always() }}
+    needs: security
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Test stable
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm test
+
+      - name: Test build
+        run: |
+          npmci node install stable
+          npmci npm install
+          npmci npm build
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Release
+        run: |
+          npmci node install stable
+          npmci npm publish
+
+  metadata:
+    needs: test
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
+    runs-on: ubuntu-latest
+    container:
+      image: ${{ env.IMAGE }}
+    continue-on-error: true
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Prepare
+        run: |
+          pnpm install -g pnpm
+          pnpm install -g @shipzone/npmci
+          npmci npm prepare
+
+      - name: Code quality
+        run: |
+          npmci command npm install -g typescript
+          npmci npm install
+
+      - name: Trigger
+        run: npmci trigger
+
+      - name: Build docs and upload artifacts
+        run: |
+          npmci node install stable
+          npmci npm install
+          pnpm install -g @gitzone/tsdoc
+          npmci command tsdoc
+        continue-on-error: true

.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,150 +0,0 @@
-# gitzone standard
-image: hosttoday/ht-docker-node:npmci
-
-cache:
-  paths:
-  - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
-
-stages:
-- security
-- test
-- release
-- metadata
-
-# ====================
-# security stage
-# ====================
-mirror:
-  stage: security
-  script:
-  - npmci git mirror
-  tags:
-  - docker
-  - notpriv
-
-snyk:
-  stage: security
-  script:
-    - npmci npm prepare
-    - npmci command npm install -g snyk
-    - npmci command npm install --ignore-scripts
-    - npmci command snyk test
-  tags:
-  - docker
-  - notpriv
-
-sast:
-  stage: security
-  image: registry.gitlab.com/hosttoday/ht-docker-dbase:npmci
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command npm run build
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SAST_CONFIDENCE_LEVEL="${SAST_CONFIDENCE_LEVEL:-3}"
-        --volume "$PWD:/code"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/sast:$SP_VERSION" /app/bin/run /code
-  artifacts:
-    reports:
-      sast: gl-sast-report.json
-  tags:
-  - docker
-  - priv
-
-# ====================
-# test stage
-# ====================
-
-testLTS:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install stable
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-
-release:
-  stage: release
-  script:
-  - npmci node install stable
-  - npmci npm publish
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-# ====================
-# metadata stage
-# ====================
-codequality:
-  stage: metadata
-  image: docker:stable
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
-  tags:
-  - docker
-  - priv
-
-trigger:
-  stage: metadata
-  script:
-  - npmci trigger
-  only:
-  - tags
-  tags:
-  - docker
-  - notpriv
-
-pages:
-  image: hosttoday/ht-docker-node:npmci
-  stage: metadata
-  script:
-    - npmci command npm install -g typedoc typescript
-    - npmci npm prepare
-    - npmci npm install
-    - npmci command typedoc --module "commonjs" --target "ES2016" --out public/ ts/
-  tags:
-    - docker
-    - notpriv
-  only:
-    - tags
-  artifacts:
-    expire_in: 1 week
-    paths:
-    - public
-  allow_failure: true

.npmignore

@@ -1,4 +0,0 @@
-node_modules/
-coverage/
-docs/
-

.vscode/launch.json

@@ -0,0 +1,11 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "npm test",
+      "name": "Run npm test",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

.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", "wcc"]
+              }
+            }
+          }
+        }
+      }
+    }
+  ]
+}

README.md

@@ -1,46 +0,0 @@
-# qenv
-
-easy promised environments
-
-## Availabililty
-
-[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/qenv)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://GitLab.com/pushrocks/qenv)
-[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/qenv)
-[![docs](https://pushrocks.gitlab.io/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';
-
-const myQenv = new Qenv('path/to/dir/where/qenv.yml/is/', 'path/to/dir/where/env.yml/is(');
-```
-
-> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
-
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)

npmextra.json

@@ -2,5 +2,16 @@
   "npmci": {
     "npmGlobalTools": [],
     "npmAccessLevel": "public"
+  },
+  "gitzone": {
+    "projectType": "npm",
+    "module": {
+      "githost": "gitlab.com",
+      "gitscope": "push.rocks",
+      "gitrepo": "qenv",
+      "description": "easy promised environments",
+      "npmPackagename": "@push.rocks/qenv",
+      "license": "MIT"
+    }
   }
 }

package.json

@@ -1,13 +1,15 @@
 {
-  "name": "@pushrocks/qenv",
-  "version": "3.1.0",
+  "name": "@push.rocks/qenv",
+  "version": "6.0.0",
   "private": false,
   "description": "easy promised environments",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "main": "dist_ts/index.js",
+  "typings": "dist_ts/index.d.ts",
+  "type": "module",
   "scripts": {
     "test": "(tstest test/)",
-    "build": "(tsbuild)"
+    "build": "(tsbuild --web --allowimplicitany)",
+    "buildDocs": "tsdoc"
   },
   "repository": {
     "type": "git",
@@ -25,16 +27,31 @@
   },
   "homepage": "https://gitlab.com/pushrocks/qenv#README",
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsrun": "^1.1.12",
-    "@gitzone/tstest": "^1.0.13",
-    "@pushrocks/tapbundle": "^3.0.5",
-    "@types/node": "^10.5.8",
-    "tslint": "^5.12.0",
-    "tslint-config-prettier": "^1.17.0"
+    "@gitzone/tsbuild": "^2.1.66",
+    "@gitzone/tsrun": "^1.2.44",
+    "@gitzone/tstest": "^1.0.77",
+    "@push.rocks/tapbundle": "^5.0.12",
+    "@types/node": "^20.4.6"
   },
   "dependencies": {
-    "@pushrocks/smartfile": "^6.0.6",
-    "@pushrocks/smartlog": "^2.0.9"
-  }
+    "@configvault.io/interfaces": "^1.0.2",
+    "@push.rocks/smartfile": "^10.0.28",
+    "@push.rocks/smartlog": "^3.0.3",
+    "@push.rocks/smartpath": "^5.0.11"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_*/**/*",
+    "dist_ts/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
+  ]
 }

readme.md

@@ -0,0 +1,52 @@
+# @push.rocks/qenv
+easy promised environments
+
+## Availabililty and Links
+* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/qenv)
+* [gitlab.com (source)](https://gitlab.com/push.rocks/qenv)
+* [github.com (source mirror)](https://github.com/push.rocks/qenv)
+* [docs (typedoc)](https://push.rocks.gitlab.io/qenv/)
+
+## Status for master
+
+Status Category | Status Badge
+-- | --
+GitLab Pipelines | [![pipeline status](https://gitlab.com/push.rocks/qenv/badges/master/pipeline.svg)](https://lossless.cloud)
+GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/push.rocks/qenv/badges/master/coverage.svg)](https://lossless.cloud)
+npm | [![npm downloads per month](https://badgen.net/npm/dy/@push.rocks/qenv)](https://lossless.cloud)
+Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/push.rocks/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/@push.rocks/qenv)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@push.rocks/qenv)](https://lossless.cloud)
+BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@push.rocks/qenv)](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.
+
+## Legal
+> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)

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/test.ts

@@ -1,33 +1,35 @@
 import * as path from 'path';
-import { tap, expect } from '@pushrocks/tapbundle';
-import * as qenv from '../ts/index';
+import { tap, expect } from '@push.rocks/tapbundle';
+import * as qenv from '../ts/index.js';
+
+import * as smartpath from '@push.rocks/smartpath';
+
+export { smartpath };
+
+const testDir = smartpath.get.dirnameFromImportMetaUrl(import.meta.url);
 
 process.env['key1'] = 'original';
 
-let qenvTestObject: qenv.Qenv;
+let testQenv: qenv.Qenv;
 
 tap.test('should create a new class', async () => {
-  qenvTestObject = new qenv.Qenv(
-    path.join(__dirname, 'assets'),
-    path.join(__dirname, 'assets'),
-    false
-  );
-  expect(qenvTestObject).to.be.instanceof(qenv.Qenv);
+  testQenv = new qenv.Qenv(path.join(testDir, 'assets'), path.join(testDir, 'assets'), false);
+  expect(testQenv).toBeInstanceOf(qenv.Qenv);
 });
 
 tap.test('key1 should be not be overwritten since it is already present', async () => {
-  expect(process.env.key1).to.equal('original');
-  expect(qenvTestObject.getEnvVarOnDemand('key1')).to.equal('original');
+  expect(await testQenv.getEnvVarOnDemand('key1')).toEqual('original');
+  expect(await testQenv.getEnvVarOnDemand('key1')).toEqual('original');
 });
 
 tap.test('key2 should be read from Yml', async () => {
-  expect(process.env.key2).to.equal('fromYml');
-  expect(qenvTestObject.getEnvVarOnDemand('key2')).to.equal('fromYml');
+  expect(await testQenv.getEnvVarOnDemand('key2')).toEqual('fromJson');
+  expect(await testQenv.getEnvVarOnDemand('key2')).toEqual('fromJson');
 });
 
 tap.test('keyValueObjectArray should hold all retrieved values', async () => {
-  expect(qenvTestObject.keyValueObjectArray[0].value).to.equal('original');
-  expect(qenvTestObject.keyValueObjectArray[1].value).to.equal('fromYml');
+  expect(await testQenv.keyValueObject.key1).toEqual('original');
+  expect(await 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: '@push.rocks/qenv',
+  version: '6.0.0',
+  description: 'easy promised environments'
+}

ts/index.ts

@@ -1 +1 @@
-export * from './qenv.classes.qenv';
+export * from './qenv.classes.qenv.js';

ts/qenv.classes.qenv.ts

@@ -1,197 +1,144 @@
-import * as plugins from './qenv.plugins';
-plugins.smartlog.defaultLogger.enableConsole();
+import * as plugins from './qenv.plugins.js';
 
-export interface IKeyValueObject {
-  key: string;
-  value: string;
-}
-
-/**
- * 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 keyValueObjectArray: IKeyValueObject[] = [];
-  public logger: plugins.smartlog.Smartlog;
+  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,
-    loggerArg: plugins.smartlog.Smartlog = plugins.smartlog.defaultLogger
+    qenvFileBasePathArg: string = process.cwd(),
+    envFileBasePathArg: string,
+    failOnMissing: boolean = true
   ) {
-    this.logger = loggerArg;
+    this.initializeFilePaths(qenvFileBasePathArg, envFileBasePathArg);
+    this.loadRequiredEnvVars();
+    this.loadAvailableEnvVars();
+    this.checkForMissingEnvVars(failOnMissing);
+  }
 
-    // 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.yml'
-    );
+  private initializeFilePaths(qenvFileBasePathArg: string, envFileBasePathArg: string) {
+    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();
+  private loadRequiredEnvVars() {
+    if (plugins.smartfile.fs.fileExistsSync(this.qenvFilePathAbsolute)) {
+      const qenvFile = plugins.smartfile.fs.toObjectSync(this.qenvFilePathAbsolute);
+      if (qenvFile?.required && Array.isArray(qenvFile.required)) {
+        this.requiredEnvVars.push(...qenvFile.required);
+      } else {
+        this.logger.log('warn', 'qenv.yml does not contain a "required" Array!');
+      }
+    }
+  }
 
-    this.missingEnvVars = this.getMissingEnvVars();
+  private loadAvailableEnvVars() {
+    for (const envVar of this.requiredEnvVars) {
+      const value = this.getEnvVarOnDemand(envVar);
+      if (value) {
+        this.availableEnvVars.push(envVar);
+        this.keyValueObject[envVar] = value;
+      }
+    }
+  }
+
+  private checkForMissingEnvVars(failOnMissing: boolean) {
+    this.missingEnvVars = this.requiredEnvVars.filter((envVar) => !this.availableEnvVars.includes(envVar));
 
-    // 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);
+      console.info('Required Env Vars are:', this.requiredEnvVars);
+      console.error('Missing Env Vars:', this.missingEnvVars);
       if (failOnMissing) {
-        console.error('Exiting!');
+        this.logger.log('error', 'Exiting due to missing env vars!');
         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 {
+  public async getEnvVarOnDemand(envVarName: string): Promise<string | undefined> {
+    return (
+      this.getFromEnvironmentVariable(envVarName) ||
+      this.getFromEnvJsonFile(envVarName) ||
+      this.getFromDockerSecret(envVarName) ||
+      this.getFromDockerSecretJson(envVarName)
+    );
+  }
+
+  public async getEnvVarOnDemandSync(envVarName: string): Promise<string | undefined> {
+    console.warn('requesting env var sync leaves out potentially important async env sources.');
+    return (
+      this.getFromEnvironmentVariable(envVarName) ||
+      this.getFromEnvJsonFile(envVarName) ||
+      this.getFromDockerSecret(envVarName) ||
+      this.getFromDockerSecretJson(envVarName)
+    );
+  }
+
+  public async getEnvVarOnDemandAsObject(envVarName: string): Promise<any> {
+    const rawValue = await this.getEnvVarOnDemand(envVarName);
+    if (rawValue && rawValue.startsWith('base64Object:')) {
+      const base64Part = rawValue.split('base64Object:')[1];
+      return this.decodeBase64(base64Part);
+    }
+    return rawValue;
+  }
+
+  private getFromEnvironmentVariable(envVarName: string): string | undefined {
     return process.env[envVarName];
   }
 
-  /**
-   * tries to get any env var even if it is not required
-   * @param requiredEnvVar
-   */
-  public getEnvVarOnDemand(requiredEnvVar: string): string {
-    // lets determine the actual env yml
-    let envYml;
+  private getFromEnvJsonFile(envVarName: string): string | undefined {
     try {
-      envYml = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
-    } catch (err) {
-      envYml = {};
+      const envJson = plugins.smartfile.fs.toObjectSync(this.envFilePathAbsolute);
+      const value = envJson[envVarName];
+      if (typeof value === 'object') {
+        return 'base64Object:' + this.encodeBase64(value);
+      }
+      return value;
+    } catch (error) {
+      return undefined;
     }
-    let envVar: string;
-    let envFileVar: string;
-    let dockerSecret: string;
-    let dockerSecretJson: string;
-
-    // env var check
-    if (process.env[requiredEnvVar]) {
-      this.availableEnvVars.push(requiredEnvVar);
-      envVar = process.env[requiredEnvVar];
   }
 
-    // env file check
-    if (envYml.hasOwnProperty(requiredEnvVar)) {
-      envFileVar = envYml[requiredEnvVar];
-      this.availableEnvVars.push(requiredEnvVar);
+  private getFromDockerSecret(envVarName: string): string | undefined {
+    const secretPath = `/run/secrets/${envVarName}`;
+    if (plugins.smartfile.fs.fileExistsSync(secretPath)) {
+      return plugins.smartfile.fs.toStringSync(secretPath);
+    }
+    return undefined;
   }
 
-    // docker secret check
-    if (
-      plugins.smartfile.fs.isDirectory('/run') &&
-      plugins.smartfile.fs.isDirectory('/run/secrets') &&
-      plugins.smartfile.fs.fileExistsSync(`/run/secrets/${requiredEnvVar}`)
-    ) {
-      dockerSecret = plugins.smartfile.fs.toStringSync(`/run/secrets/${requiredEnvVar}`);
-    }
-
-    // docker secret.json
-    if (
-      plugins.smartfile.fs.isDirectory('/run') &&
-      plugins.smartfile.fs.isDirectory('/run/secrets')
-    ) {
+  private getFromDockerSecretJson(envVarName: string): string | undefined {
+    if (plugins.smartfile.fs.isDirectory('/run/secrets')) {
       const availableSecrets = plugins.smartfile.fs.listAllItemsSync('/run/secrets');
       for (const secret of availableSecrets) {
-        if (secret.includes('secret.json') && !dockerSecret) {
-          const secretObject = plugins.smartfile.fs.toObjectSync('/run/secrets/secret.json');
-          dockerSecret = secretObject[requiredEnvVar];
+        if (secret.includes('secret.json')) {
+          const secretObject = plugins.smartfile.fs.toObjectSync(`/run/secrets/${secret}`);
+          const value = secretObject[envVarName];
+          if (typeof value === 'object') {
+            return 'base64Object:' + this.encodeBase64(value);
+          }
+          return value;
         }
       }
     }
+    return undefined;
+  }
 
-    // warn if there is more than one candidate
-    let candidatesCounter = 0;
-    [envVar, envFileVar, dockerSecret, dockerSecretJson].forEach(candidate => {
-      if (candidate) {
-        candidatesCounter++;
-      }
-    });
-    if (candidatesCounter > 1) {
-      this.logger.log(
-        'warn',
-        `found multiple candidates for ${requiredEnvVar} Choosing in the order of envVar, envFileVar, dockerSecret, dockerSecretJson`
-      );
+  private encodeBase64(data: any): string {
+    const jsonString = JSON.stringify(data);
+    return Buffer.from(jsonString).toString('base64');
   }
 
-    let chosenVar: string = null;
-    if (envVar) {
-      this.logger.log('ok', `found ${requiredEnvVar} as environment variable`);
-      chosenVar = envVar;
-    } else if (envFileVar) {
-      this.logger.log('ok', `found ${requiredEnvVar} as env.yml variable`);
-      chosenVar = envFileVar;
-    } else if (dockerSecret) {
-      this.logger.log('ok', `found ${requiredEnvVar} as docker secret`);
-      chosenVar = dockerSecret;
-    } else if (dockerSecretJson) {
-      this.logger.log('ok', `found ${requiredEnvVar} as docker secret.json`);
-      chosenVar = dockerSecretJson;
-    }
-    return chosenVar;
-  }
-
-  /**
-   * 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', `env File does not contain a 'required' Array!`);
-    } else {
-      for (const keyArg of Object.keys(qenvFile.required)) {
-        this.requiredEnvVars.push(qenvFile.required[keyArg]);
+  private decodeBase64(encodedString: string): any {
+    const decodedString = Buffer.from(encodedString, 'base64').toString('utf-8');
+    return JSON.parse(decodedString);
   }
 }
-  };
-
-  /**
-   * gets the available env vars
-   */
-  private getAvailableEnvVars = () => {
-    for (const requiredEnvVar of this.requiredEnvVars) {
-      const chosenVar = this.getEnvVarOnDemand(requiredEnvVar);
-      if (chosenVar) {
-        this.availableEnvVars.push(requiredEnvVar);
-        process.env[requiredEnvVar] = chosenVar;
-        this.keyValueObjectArray.push({
-          key: requiredEnvVar,
-          value: 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,16 +1,10 @@
 // native
 import * as path from 'path';
 
-export {
-  path
-}
+export { path };
 
 // @pushrocks scope
-import * as smartfile from '@pushrocks/smartfile';
-import * as smartlog from '@pushrocks/smartlog';
-
-export {
-  smartfile,
-  smartlog
-}
+import * as smartfile from '@push.rocks/smartfile';
+import * as smartlog from '@push.rocks/smartlog';
 
+export { smartfile, smartlog };

tsconfig.json

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

tslint.json

@@ -1,17 +0,0 @@
-{
-  "extends": ["tslint:latest", "tslint-config-prettier"],
-  "rules": {
-    "semicolon": [true, "always"],
-    "no-console": false,
-    "ordered-imports": false,
-    "object-literal-sort-keys": false,
-    "member-ordering": {
-      "options":{
-        "order": [
-          "static-method"
-        ]
-      }
-    }
-  },
-  "defaultSeverity": "warning"
-}