@nitra/check-env 2.0.3 → 2.0.4

package/README.md

@@ -7,7 +7,6 @@ and that you did not leave dangerous development overrides in production.
 [![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)
-[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=47ng/check-env)](https://dependabot.com)
 
 ## Installation
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nitra/check-env",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Check that the critical environment variables are set",
   "type": "module",
   "exports": {

package/src/index.js

@@ -0,0 +1,27 @@
+const testEnv = name => !process.env[name]
+
+const displayMissing = name => {
+  console.error(`❌  Missing required environment variable ${name}`)
+}
+
+export class MissingEnvironmentVariableError extends Error {
+  constructor(envs) {
+    const joined = envs.join(', ')
+    super(`Some required environment variables are missing: ${joined}`)
+  }
+}
+
+export default required => {
+  const missingReq = []
+
+  required.forEach(name => {
+    if (testEnv(name)) {
+      displayMissing(name)
+      missingReq.push(name)
+    }
+  })
+
+  if (missingReq.length > 0) {
+    throw new MissingEnvironmentVariableError(missingReq)
+  }
+}

package/.cspell.json

@@ -1,18 +0,0 @@
-{
-  "version": "0.2",
-  "language": "en,uk,ru-ru,nitra",
-  "ignorePaths": [
-    "**/node_modules/**",
-    "**/vscode-extension/**",
-    "**/.git/**",
-    ".vscode",
-    "report",
-    "yarn.lock"
-  ],
-  "import": [
-    "@nitra/cspell-dict/cspell-ext.json",
-    "@cspell/dict-ru_ru/cspell-ext.json",
-    "@cspell/dict-uk-ua/cspell-ext.json"
-  ],
-  "words": ["vitaliytv"]
-}

package/.prettierrc.cjs

@@ -1,10 +0,0 @@
-const prettierConfigStandard = require("prettier-config-standard");
-
-const modifiedConfig = {
-  ...prettierConfigStandard,
-  ...{
-    arrowParens: "avoid",
-  },
-};
-
-module.exports = modifiedConfig;

package/test/checkenv.test.js

@@ -1,71 +0,0 @@
-/* global it, expect, test */
-import checkEnv from '../src/index.js'
-import { jest } from '@jest/globals'
-
-test('Empty options', () => {
-  console.error = jest.fn()
-  console.warn = jest.fn()
-  expect(() => checkEnv([])).not.toThrow()
-  expect(console.error).not.toHaveBeenCalled()
-  expect(console.warn).not.toHaveBeenCalled()
-})
-
-test('A single required env is missing', () => {
-  console.error = jest.fn()
-  console.warn = jest.fn()
-  expect(() => checkEnv(['foo'])).toThrowError()
-  expect(console.error).toHaveBeenCalledTimes(1)
-  expect(console.warn).not.toHaveBeenCalled()
-})
-
-test('All required envs are missing', () => {
-  const input = ['foo', 'bar']
-  console.error = jest.fn()
-  console.warn = jest.fn()
-  expect(() => checkEnv(input)).toThrowError()
-  expect(console.error).toHaveBeenCalledTimes(2)
-  expect(console.warn).not.toHaveBeenCalled()
-})
-
-test('Some required env are missing', () => {
-  const input = ['foo', 'NODE_ENV']
-  process.env['NODE_ENV'] = 'production'
-
-  console.error = jest.fn()
-  console.warn = jest.fn()
-  expect(() => checkEnv(input)).toThrowError()
-  expect(console.error).toHaveBeenCalledTimes(1)
-  expect(console.warn).not.toHaveBeenCalled()
-})
-
-test('A single required envs is available', () => {
-  const input = ['NODE_ENV']
-  process.env['NODE_ENV'] = 'production'
-
-  console.error = jest.fn()
-  console.warn = jest.fn()
-  checkEnv(input)
-  expect(console.error).not.toHaveBeenCalled()
-  expect(console.warn).not.toHaveBeenCalled()
-})
-
-test('Error message type', () => {
-  const input = ['foo']
-
-  expect(() => checkEnv(input)).toThrowError(
-    checkEnv.MissingEnvironmentVariableError
-  )
-})
-
-test('Error message contains name of missing variable', () => {
-  const input = ['foo']
-
-  try {
-    const run = () => checkEnv(input)
-    run()
-    expect(run).not.toHaveReturned() // Should throw
-  } catch (error) {
-    // Only missing required variables are shown in the message string
-    expect(error.message).toMatch('foo')
-  }
-})