@nitra/check-env 3.2.0 → 4.1.0

package/README.md

@@ -4,14 +4,11 @@ Check that the critical environment variables are set for your app,
 and that you did not leave dangerous development overrides in production.
 
 [![NPM](https://img.shields.io/npm/v/@nitra/check-env?color=red)](https://www.npmjs.com/package/@nitra/check-env)
-[![MIT License](https://img.shields.io/github/license/47ng/check-env.svg?color=blue)](https://github.com/47ng/check-env/blob/next/LICENSE)
-[![Continuous Integration](https://github.com/47ng/check-env/workflows/Continuous%20Integration/badge.svg?branch=next)](https://github.com/47ng/check-env/actions)
-[![Coverage Status](https://coveralls.io/repos/github/47ng/check-env/badge.svg?branch=next)](https://coveralls.io/github/47ng/check-env?branch=next)
 
 ## Installation
 
 ```bash
-yarn add @nitra/check-env
+bun add @nitra/check-env
 ```
 
 ## Usage
@@ -34,6 +31,17 @@ If some required environment variable are not set, it will tell you and throw
 an error at the end:
 !["CLI output"](output.png)
 
+## SKIP_CHECK_ENV
+
+If the `SKIP_CHECK_ENV` environment variable is set, the library will skip required variable checks and will not throw. This can be useful for local development or specific CI scenarios.
+
+```bash
+SKIP_CHECK_ENV=1 bun node app.js
+```
+
+- With `SKIP_CHECK_ENV` enabled, you'll see a warning in logs: `SKIP_CHECK_ENV is set, skipping environment variable check`.
+- The exported `env` will behave like plain `process.env` (no proxy checks for prior validation).
+
 ## License
 
 [MIT](https://github.com/47ng/check-env/blob/master/LICENSE) - Made with ❤️ by [François Best](https://francoisbest.com)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitra/check-env",
-  "version": "3.2.0",
+  "version": "4.1.0",
   "description": "Check that the critical environment variables are set",
   "type": "module",
   "main": "./src/index.js",
@@ -30,5 +30,8 @@
   "files": [
     "src",
     "types"
-  ]
+  ],
+  "dependencies": {
+    "@nitra/pino": "^2.7.4"
+  }
 }

package/src/index.js

@@ -1,16 +1,16 @@
-import process from 'node:process'
+import { log } from '@nitra/pino'
+import { env as pEnv } from 'node:process'
 
-const testEnv = name => !process.env[name]
+const testEnv = name => !pEnv[name]
 
 const displayMissing = name => {
-  console.error(`❌  Missing required environment variable ${name}`)
+  log.error(`❌  Missing required environment variable ${name}`)
 }
 
 /**
  * MissingEnvironmentVariableError
- *
  * @class
- * @extends Error
+ * @augments Error
  */
 export class MissingEnvironmentVariableError extends Error {
   constructor(envs) {
@@ -23,14 +23,19 @@ const checked = new Set()
 
 /**
  * Перевірка наявності змінних середовища
- *
  * @function
- * @param {Array.<String>} required
+ * @param {Array.<string>} required - список обов'язкових змінних середовища
  */
 export const checkEnv = required => {
+  // Якщо змінна SKIP_CHECK_ENV встановлена, то пропускаємо перевірку
+  if (pEnv.SKIP_CHECK_ENV) {
+    log.warn('SKIP_CHECK_ENV is set, skipping environment variable check')
+    return
+  }
+
   const missingReq = []
 
-  required.forEach(name => {
+  for (const name of required) {
     // додаємо в список перевірених
     checked.add(name)
 
@@ -38,7 +43,7 @@ export const checkEnv = required => {
       displayMissing(name)
       missingReq.push(name)
     }
-  })
+  }
 
   if (missingReq.length > 0) {
     throw new MissingEnvironmentVariableError(missingReq)
@@ -47,15 +52,17 @@ export const checkEnv = required => {
 
 /**
  * Для сумісності з попередніми версіями
- *
- * @param {Array.<String>} required to capture
+ * @param {Array.<string>} required to capture
  */
 export default checkEnv
 
 const envProxyHandler = {
   /**
-   * Set colour of object
-   * @returns {String}
+   * Проксі-доступ до значень змінних середовища
+   * @param {object} target - об'єкт із змінними середовища
+   * @param {string} prop - назва змінної середовища
+   * @param {unknown} _ - не використовується
+   * @returns {string} - значення змінної середовища
    */
   get(target, prop, _) {
     // Якщо зі списку перевірених то повертаємо значення
@@ -69,6 +76,6 @@ const envProxyHandler = {
 }
 
 /**
- * @type {Object.<string, string>}
+ * @type {Record<string, string>}
  */
-export const env = new Proxy(process.env, envProxyHandler)
+export const env = pEnv.SKIP_CHECK_ENV ? pEnv : new Proxy(pEnv, envProxyHandler) // Якщо змінна SKIP_CHECK_ENV встановлена, то пропускаємо перевірку

package/types/index.d.ts

@@ -2,7 +2,7 @@
  * MissingEnvironmentVariableError
  *
  * @class
- * @extends Error
+ * @augments Error
  */
 export class MissingEnvironmentVariableError extends Error {
     constructor(envs: any);