@nitra/check-env 2.0.7 → 3.1.0

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@nitra/check-env",
-  "version": "2.0.7",
+  "version": "3.1.0",
   "description": "Check that the critical environment variables are set",
   "type": "module",
   "main": "./src/index.js",
+  "types": "./types/index.d.ts",
   "exports": {
     ".": "./src/index.js"
   },
   "scripts": {
-    "standard": "npx standard --fix",
-    "fix": "npx standard --fix && npx prettier --write .",
+    "fix": "npx eslint --fix --ext .js . && npx prettier --write '**/*.js'",
     "test": "NODE_OPTIONS=--experimental-vm-modules npx jest"
   },
   "repository": {
@@ -21,11 +21,10 @@
     "email": "contact@francoisbest.com",
     "url": "https://francoisbest.com"
   },
-  "devDependencies": {
-    "@cspell/dict-ru_ru": "^2.0.2",
-    "@cspell/dict-uk-ua": "^1.0.20",
-    "@nitra/cspell-dict": "^1.0.8",
-    "@nitra/prettier-config": "^1.0.0"
+  "eslintConfig": {
+    "extends": [
+      "@nitra"
+    ]
   },
   "license": "MIT",
   "bugs": {
@@ -38,6 +37,7 @@
   ],
   "prettier": "@nitra/prettier-config",
   "files": [
-    "src"
+    "src",
+    "types"
   ]
 }

package/src/index.js

@@ -1,9 +1,17 @@
+import process from 'node:process'
+
 const testEnv = name => !process.env[name]
 
 const displayMissing = name => {
   console.error(`❌  Missing required environment variable ${name}`)
 }
 
+/**
+ * MissingEnvironmentVariableError
+ *
+ * @class
+ * @extends Error
+ */
 export class MissingEnvironmentVariableError extends Error {
   constructor(envs) {
     const joined = envs.join(', ')
@@ -11,10 +19,21 @@ export class MissingEnvironmentVariableError extends Error {
   }
 }
 
-export default required => {
+const checked = new Set()
+
+/**
+ * Перевірка наявності змінних середовища
+ *
+ * @function
+ * @param {Array.<String>} required
+ */
+export const checkEnv = required => {
   const missingReq = []
 
   required.forEach(name => {
+    // додаємо в список перевірених
+    checked.add(name)
+
     if (testEnv(name)) {
       displayMissing(name)
       missingReq.push(name)
@@ -25,3 +44,31 @@ export default required => {
     throw new MissingEnvironmentVariableError(missingReq)
   }
 }
+
+/**
+ * Для сумісності з попередніми версіями
+ *
+ * @param {Array.<String>} required to capture
+ */
+export default checkEnv
+
+const envProxyHandler = {
+  /**
+   * Set colour of object
+   * @returns {String}
+   */
+  get(target, prop, _) {
+    // Якщо зі списку перевірених то повертаємо значення
+    // інакше аварійно завершуємо програму
+    if (!checked.has(prop)) {
+      throw new Error(`❌  Environment variable ${prop} is not checked`)
+    }
+
+    return target[prop]
+  }
+}
+
+/**
+ * @type {Object.<string, string>}
+ */
+export const env = new Proxy(process.env, envProxyHandler)

package/types/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * MissingEnvironmentVariableError
+ *
+ * @class
+ * @extends Error
+ */
+export class MissingEnvironmentVariableError extends Error {
+    constructor(envs: any);
+}
+export function checkEnv(required: Array<string>): void;
+export default checkEnv;
+/**
+ * @type {Object.<string, string>}
+ */
+export const env: {
+    [x: string]: string;
+};