@achs/env 3.0.0 → 3.1.0

package/.eslintignore

@@ -0,0 +1,3 @@
+.vscode/**/*
+dist/**/*
+*.js

package/.eslintrc.json

@@ -0,0 +1,329 @@
+{
+    "root": true,
+    "env": {
+        "es6": true,
+        "jest": true,
+        "node": true,
+        "es2021": true,
+        "jest/globals": true
+    },
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "project": "tsconfig.json",
+        "sourceType": "module",
+        "ecmaFeatures": {
+            "modules": true,
+            "legacyDecorators": true
+        }
+    },
+    "plugins": [
+        "@typescript-eslint/eslint-plugin",
+        "prettier",
+        "sonarjs",
+        "unicorn",
+        "promise",
+        "jest",
+        "jest-formatting"
+    ],
+    "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:prettier/recommended",
+        "plugin:eslint-comments/recommended",
+        "plugin:sonarjs/recommended"
+    ],
+    "rules": {
+        "prettier/prettier": [
+            "warn",
+            {
+                "useTabs": false,
+                "tabWidth": 4,
+                "printWidth": 80,
+                "trailingComma": "none",
+                "singleQuote": true,
+                "semi": true,
+                "bracketSpacing": true,
+                "bracketSameLine": false,
+                "quoteProps": "as-needed",
+                "arrowParens": "always",
+                "endOfLine": "auto"
+            }
+        ],
+        "@typescript-eslint/explicit-function-return-type": "off",
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/interface-name-prefix": "off",
+        "@typescript-eslint/no-empty-interface": [
+            "error",
+            {
+                "allowSingleExtends": true
+            }
+        ],
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-unused-vars": [
+            "warn",
+            {
+                "args": "after-used",
+                "caughtErrors": "all",
+                "vars": "local",
+                "varsIgnorePattern": "^_.*"
+            }
+        ],
+        "array-callback-return": "error",
+        "block-scoped-var": "warn",
+        "block-spacing": "warn",
+        "class-methods-use-this": "off",
+        "comma-dangle": ["warn", "never"],
+        "comma-spacing": [
+            "warn",
+            {
+                "after": true,
+                "before": false
+            }
+        ],
+        "comma-style": ["warn", "last"],
+        "curly": ["warn", "multi-or-nest", "consistent"],
+        "default-case": "warn",
+        "dot-location": ["warn", "property"],
+        "dot-notation": "warn",
+        "eqeqeq": "warn",
+        "func-call-spacing": ["warn", "never"],
+        "getter-return": [
+            "error",
+            {
+                "allowImplicit": true
+            }
+        ],
+        "jest-formatting/padding-around-all": "warn",
+        "jest/no-disabled-tests": "warn",
+        "jest/no-focused-tests": "error",
+        "jest/no-identical-title": "error",
+        "jest/prefer-to-have-length": "warn",
+        "jest/valid-expect": "error",
+        "key-spacing": [
+            "warn",
+            {
+                "beforeColon": false
+            }
+        ],
+        "lines-around-comment": [
+            "warn",
+            {
+                "allowArrayStart": true,
+                "allowBlockStart": true,
+                "allowClassStart": true,
+                "allowObjectStart": true,
+                "beforeBlockComment": true,
+                "beforeLineComment": false
+            }
+        ],
+        "lines-between-class-members": ["warn", "always"],
+        "no-console": "warn",
+        "no-duplicate-case": "error",
+        "no-empty": "error",
+        "no-empty-pattern": "error",
+        "no-eq-null": "warn",
+        "no-extra-semi": "warn",
+        "no-mixed-spaces-and-tabs": ["warn", "smart-tabs"],
+        "no-multi-spaces": "warn",
+        "no-multiple-empty-lines": [
+            "warn",
+            {
+                "max": 1,
+                "maxBOF": 0,
+                "maxEOF": 0
+            }
+        ],
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "warn",
+        "no-unneeded-ternary": "warn",
+        "no-unreachable": "error",
+        "object-curly-spacing": ["warn", "always"],
+        "object-shorthand": "warn",
+        "padded-blocks": ["warn", "never"],
+        "padding-line-between-statements": [
+            "warn",
+            {
+                "blankLine": "always",
+                "next": "return",
+                "prev": "*"
+            },
+            {
+                "blankLine": "always",
+                "next": "class",
+                "prev": "*"
+            },
+            {
+                "blankLine": "never",
+                "next": "import",
+                "prev": "import"
+            }
+        ],
+        "prefer-promise-reject-errors": "warn",
+        "promise/always-return": "error",
+        "promise/avoid-new": "off",
+        "promise/catch-or-return": "error",
+        "promise/no-callback-in-promise": "warn",
+        "promise/no-native": "off",
+        "promise/no-nesting": "warn",
+        "promise/no-new-statics": "error",
+        "promise/no-promise-in-callback": "warn",
+        "promise/no-return-in-finally": "warn",
+        "promise/no-return-wrap": "error",
+        "promise/param-names": "error",
+        "promise/valid-params": "off",
+        "quote-props": ["warn", "as-needed"],
+        "quotes": ["warn", "single", "avoid-escape"],
+        "radix": ["warn", "as-needed"],
+        "require-await": "error",
+        "semi": ["error", "always"],
+        "semi-spacing": "warn",
+        "semi-style": ["warn", "last"],
+        "sonarjs/cognitive-complexity": ["warn", 14],
+        "sonarjs/max-switch-cases": ["warn", 10],
+        "sonarjs/no-all-duplicated-branches": "error",
+        "sonarjs/no-collapsible-if": "warn",
+        "sonarjs/no-collection-size-mischeck": "error",
+        "sonarjs/no-duplicate-string": "warn",
+        "sonarjs/no-duplicated-branches": "error",
+        "sonarjs/no-element-overwrite": "error",
+        "sonarjs/no-extra-arguments": "warn",
+        "sonarjs/no-identical-conditions": "error",
+        "sonarjs/no-identical-expressions": "warn",
+        "sonarjs/no-identical-functions": "warn",
+        "sonarjs/no-inverted-boolean-check": "warn",
+        "sonarjs/no-one-iteration-loop": "error",
+        "sonarjs/no-redundant-boolean": "error",
+        "sonarjs/no-redundant-jump": "error",
+        "sonarjs/no-same-line-conditional": "error",
+        "sonarjs/no-small-switch": "warn",
+        "sonarjs/no-unused-collection": "warn",
+        "sonarjs/no-use-of-empty-return-value": "error",
+        "sonarjs/no-useless-catch": "warn",
+        "sonarjs/prefer-immediate-return": "warn",
+        "sonarjs/prefer-object-literal": "warn",
+        "sonarjs/prefer-single-boolean-return": "warn",
+        "sonarjs/prefer-while": "error",
+        "sort-imports": "off",
+        "sort-keys": ["off", "asc"],
+        "space-before-blocks": "warn",
+        "space-in-parens": ["warn", "never"],
+        "spaced-comment": [
+            "warn",
+            "always",
+            {
+                "block": {
+                    "balanced": true,
+                    "exceptions": ["*"],
+                    "markers": ["!"]
+                },
+                "line": {
+                    "exceptions": ["-", "+"],
+                    "markers": ["/"]
+                }
+            }
+        ],
+        "switch-colon-spacing": "warn",
+        "vars-on-top": "warn",
+        "unicorn/better-regex": "error",
+        "unicorn/catch-error-name": "error",
+        "unicorn/consistent-destructuring": "error",
+        "unicorn/consistent-function-scoping": "error",
+        "unicorn/custom-error-definition": "off",
+        "unicorn/empty-brace-spaces": "error",
+        "unicorn/error-message": "error",
+        "unicorn/escape-case": "error",
+        "unicorn/expiring-todo-comments": "error",
+        "unicorn/explicit-length-check": "error",
+        "unicorn/filename-case": "error",
+        "unicorn/import-index": "off",
+        "unicorn/import-style": "error",
+        "unicorn/new-for-builtins": "error",
+        "unicorn/no-abusive-eslint-disable": "error",
+        "unicorn/no-array-callback-reference": "error",
+        "unicorn/no-array-for-each": "error",
+        "unicorn/no-array-method-this-argument": "error",
+        "unicorn/no-array-push-push": "error",
+        "unicorn/no-array-reduce": "off",
+        "unicorn/no-await-expression-member": "error",
+        "unicorn/no-console-spaces": "error",
+        "unicorn/no-document-cookie": "error",
+        "unicorn/no-empty-file": "error",
+        "unicorn/no-for-loop": "off",
+        "unicorn/no-hex-escape": "error",
+        "unicorn/no-instanceof-array": "error",
+        "unicorn/no-invalid-remove-event-listener": "error",
+        "unicorn/no-keyword-prefix": "off",
+        "unicorn/no-lonely-if": "error",
+        "no-nested-ternary": "off",
+        "unicorn/no-nested-ternary": "error",
+        "unicorn/no-new-array": "error",
+        "unicorn/no-new-buffer": "error",
+        "unicorn/no-null": "off",
+        "unicorn/no-object-as-default-parameter": "error",
+        "unicorn/no-process-exit": "off",
+        "unicorn/no-static-only-class": "error",
+        "unicorn/no-thenable": "error",
+        "unicorn/no-this-assignment": "error",
+        "unicorn/no-unreadable-array-destructuring": "error",
+        "unicorn/no-unsafe-regex": "off",
+        "unicorn/no-unused-properties": "off",
+        "unicorn/no-useless-fallback-in-spread": "error",
+        "unicorn/no-useless-length-check": "error",
+        "unicorn/no-useless-promise-resolve-reject": "error",
+        "unicorn/no-useless-spread": "error",
+        "unicorn/no-useless-undefined": "error",
+        "unicorn/no-zero-fractions": "error",
+        "unicorn/number-literal-case": "error",
+        "unicorn/numeric-separators-style": "error",
+        "unicorn/prefer-add-event-listener": "error",
+        "unicorn/prefer-array-find": "error",
+        "unicorn/prefer-array-flat": "error",
+        "unicorn/prefer-array-flat-map": "error",
+        "unicorn/prefer-array-index-of": "error",
+        "unicorn/prefer-array-some": "error",
+        "unicorn/prefer-at": "off",
+        "unicorn/prefer-code-point": "error",
+        "unicorn/prefer-date-now": "error",
+        "unicorn/prefer-default-parameters": "error",
+        "unicorn/prefer-dom-node-append": "error",
+        "unicorn/prefer-dom-node-dataset": "error",
+        "unicorn/prefer-dom-node-remove": "error",
+        "unicorn/prefer-dom-node-text-content": "error",
+        "unicorn/prefer-export-from": "error",
+        "unicorn/prefer-includes": "error",
+        "unicorn/prefer-json-parse-buffer": "error",
+        "unicorn/prefer-keyboard-event-key": "error",
+        "unicorn/prefer-math-trunc": "error",
+        "unicorn/prefer-modern-dom-apis": "error",
+        "unicorn/prefer-module": "off",
+        "unicorn/prefer-negative-index": "error",
+        "unicorn/prefer-node-protocol": "off",
+        "unicorn/prefer-number-properties": "error",
+        "unicorn/prefer-object-from-entries": "error",
+        "unicorn/prefer-optional-catch-binding": "error",
+        "unicorn/prefer-prototype-methods": "error",
+        "unicorn/prefer-query-selector": "error",
+        "unicorn/prefer-reflect-apply": "error",
+        "unicorn/prefer-regexp-test": "error",
+        "unicorn/prefer-set-has": "error",
+        "unicorn/prefer-spread": "error",
+        "unicorn/prefer-string-replace-all": "off",
+        "unicorn/prefer-string-slice": "error",
+        "unicorn/prefer-string-starts-ends-with": "error",
+        "unicorn/prefer-string-trim-start-end": "error",
+        "unicorn/prefer-switch": "error",
+        "unicorn/prefer-ternary": "off",
+        "unicorn/prefer-top-level-await": "off",
+        "unicorn/prefer-type-error": "error",
+        "unicorn/prevent-abbreviations": "off",
+        "unicorn/relative-url-style": "error",
+        "unicorn/require-array-join-separator": "error",
+        "unicorn/require-number-to-fixed-digits-argument": "error",
+        "unicorn/require-post-message-target-origin": "off",
+        "unicorn/string-content": "off",
+        "unicorn/template-indent": "warn",
+        "unicorn/text-encoding-identifier-case": "error",
+        "unicorn/throw-new-error": "error"
+    }
+}

package/.vscode/extensions.json

@@ -0,0 +1,18 @@
+{
+    "recommendations": [
+        "abhijoybasak.nestjs-files",
+        "adam-bender.commit-message-editor",
+        "alefragnani.bookmarks",
+        "bradgashler.htmltagwrap",
+        "dbaeumer.vscode-eslint",
+        "eamodio.gitlens",
+        "exodiusstudios.comment-anchors",
+        "manuelalabor.rxjs-debugging-for-vs-code",
+        "oouo-diogo-perdigao.docthis",
+        "rbbit.typescript-hero",
+        "svipas.prettier-plus",
+        "tyriar.windows-terminal",
+        "waderyan.gitblame",
+        "yatki.vscode-surround"
+    ]
+}

package/.vscode/launch.json

@@ -0,0 +1,30 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Test",
+            "type": "node",
+            "request": "launch",
+            "cwd": "${workspaceFolder}",
+            "sourceMaps": true,
+            "restart": true,
+            "disableOptimisticBPs": true,
+            "runtimeExecutable": "npm",
+            "runtimeArgs": [
+                "run",
+                "test",
+                "${fileBasenameNoExtension}",
+                "-no-cache"
+            ],
+            "outFiles": [
+                "${workspaceFolder}/src/**/*.ts"
+            ],
+            "skipFiles": [
+                "<node_internals>/**/*.js"
+            ],
+            "protocol": "inspector",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen"
+        }
+    ]
+}

package/.vscode/settings.json

@@ -0,0 +1,29 @@
+{
+    "editor.rulers": [80, 100],
+    "explorer.sortOrder": "type",
+    "files.exclude": {
+        "**/*.log": true,
+        "**/*.map.js": true,
+        "**/.DS_Store": true,
+        "**/.git": true,
+        "**/.git/objects/**": true,
+        "**/.git/subtree-cache/**": true,
+        "**/.hg": true,
+        "**/.history/**": true,
+        "**/.svn": true,
+        "**/CVS": true,
+        "**/bower_components/**": true,
+        "**/node_modules/**": true,
+        "desktop.ini": true,
+        "folderico*.ico": true
+    },
+    "files.insertFinalNewline": true,
+    "files.trimTrailingWhitespace": true,
+    "typescript.tsdk": "node_modules\\typescript\\lib",
+    "[javascript]": {
+        "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+    },
+    "[typescript]": {
+        "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+    }
+}

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## [3.1.0] - 2022-07-18
+
+-   dependencies updated
+
 ## [3.0.0] - 2022-05-15
 
 -   reworked file paths

package/jest.config.json

@@ -0,0 +1,28 @@
+{
+    "rootDir": ".",
+    "roots": ["src", "tests"],
+    "testEnvironment": "node",
+    "globalSetup": "./tests/setup.ts",
+    "bail": 1,
+    "verbose": true,
+    "clearMocks": true,
+    "testTimeout": 30000,
+    "slowTestThreshold": 10,
+    "moduleDirectories": ["node_modules", "src"],
+    "moduleFileExtensions": ["js", "json", "ts"],
+    "testRegex": ".*\\.(spec|test)\\.ts$",
+    "transform": {
+        "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": ["src/**/*.(t|j)s"],
+    "coverageDirectory": "__reports__/coverage",
+    "coveragePathIgnorePatterns": [
+        "index.ts",
+        "main.ts",
+        ".d.ts",
+        "tests",
+        "__reports__",
+        "__tests__",
+        "__mocks__"
+    ]
+}

package/package.json

@@ -1,5 +1,5 @@
 {
-    "version": "3.0.0",
+    "version": "3.1.0",
     "project": "common",
     "name": "@achs/env",
     "title": "Environment Variables CLI Tool",
@@ -23,7 +23,7 @@
         "postbuild": "copyfiles package.json README.md LICENSE.md CHANGELOG.md assets/* dist"
     },
     "dependencies": {
-        "@achs/azure-key-vault": "^3.2.0",
+        "@achs/azure-key-vault": "^3.3.0",
         "ajv": "^8.11.0",
         "ajv-formats": "^2.1.1",
         "chalk": "^4.1.2",
@@ -31,28 +31,28 @@
         "subslate": "^1.0.0",
         "to-json-schema": "^0.2.5",
         "tslog": "^3.3.3",
-        "yargs": "^17.5.0"
+        "yargs": "^17.5.1"
     },
     "devDependencies": {
-        "@types/jest": "^27.5.1",
+        "@types/jest": "^28.1.6",
         "@types/merge-deep": "^3.0.0",
-        "@types/node": "^17.0.33",
+        "@types/node": "^18.0.6",
         "@types/to-json-schema": "^0.2.1",
-        "@typescript-eslint/eslint-plugin": "^5.23.0",
-        "@typescript-eslint/parser": "^5.23.0",
+        "@typescript-eslint/eslint-plugin": "^5.30.7",
+        "@typescript-eslint/parser": "^5.30.7",
         "copyfiles": "^2.4.1",
-        "eslint": "^8.15.0",
+        "eslint": "^8.20.0",
         "eslint-config-prettier": "^8.5.0",
         "eslint-plugin-eslint-comments": "^3.2.0",
-        "eslint-plugin-jest": "^26.2.1",
+        "eslint-plugin-jest": "^26.6.0",
         "eslint-plugin-jest-formatting": "^3.1.0",
-        "eslint-plugin-prettier": "^4.0.0",
+        "eslint-plugin-prettier": "^4.2.1",
         "eslint-plugin-promise": "^6.0.0",
         "eslint-plugin-sonarjs": "^0.13.0",
-        "eslint-plugin-unicorn": "^42.0.0",
-        "jest": "^28.1.0",
-        "ts-jest": "^28.0.2",
-        "typescript": "^4.6.4"
+        "eslint-plugin-unicorn": "^43.0.2",
+        "jest": "^28.1.3",
+        "ts-jest": "^28.0.7",
+        "typescript": "^4.7.4"
     },
     "main": "index.js",
     "types": "index.d.ts",
@@ -60,8 +60,8 @@
         "env": "main.js"
     },
     "engines": {
-        "node": "~14.0.0 || ^16.14.2",
-        "npm": ">=7.5.6"
+        "node": ">=16.16.0 || ^18.0.0",
+        "npm": ">=8.0.0"
     },
     "config": {
         "delimiters": {

package/{arguments.js → src/arguments.ts}

@@ -1,13 +1,37 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.args = void 0;
-const providers_1 = require("./providers");
+import { JSONSchemaType } from 'ajv';
+import { Arguments, Options } from 'yargs';
+import { EnvProviderConfig } from './interfaces';
+import { IntegratedProviderConfig } from './providers';
+
 const GROUPS = {
     LOG_WORKSPACE: 'Logger Options',
     GROUP_WORKSPACE: 'Workspace Options',
     JSON_SCHEMA_WORKSPACE: 'JSON Schema Options'
 };
-exports.args = {
+
+export interface CommandArguments extends Arguments {
+    env: string;
+    modes?: string[];
+    app?: Record<string, unknown>;
+    schema?: Record<string, JSONSchemaType<object>>;
+    providers: EnvProviderConfig[];
+    ci: boolean;
+    nestingDelimiter: string;
+    arrayDescomposition: boolean;
+    expand: boolean;
+    root: string;
+    configFile: string;
+    schemaFile: string;
+    resolve: 'merge' | 'override';
+    nullable: boolean;
+    detectFormat: boolean;
+    logLevel?: 'silly' | 'trace' | 'debug' | 'info' | 'warn' | 'error';
+    logMaskAnyRegEx?: string[];
+    logMaskValuesOfKeys?: string[];
+}
+
+// common CLI arguments
+export const args: Record<keyof CommandArguments, Options> = {
     env: {
         alias: 'e',
         type: 'string',
@@ -23,7 +47,7 @@ exports.args = {
     providers: {
         type: 'array',
         hidden: true,
-        default: providers_1.IntegratedProviderConfig,
+        default: IntegratedProviderConfig,
         describe: 'Providers handling variables loading'
     },
     ci: {
@@ -36,7 +60,8 @@ exports.args = {
         alias: 'nd',
         type: 'string',
         default: '__',
-        describe: 'Nesting level delimiter for flatten, i.e. { l1: { l2: "value" } } turns into { l1__l2: "value" }'
+        describe:
+            'Nesting level delimiter for flatten, i.e. { l1: { l2: "value" } } turns into { l1__l2: "value" }'
     },
     arrayDescomposition: {
         alias: 'arrDesc',
@@ -114,4 +139,3 @@ exports.args = {
         default: []
     }
 };
-//# sourceMappingURL=arguments.js.map