@nitra/check-env 2.0.3

package/.cspell.json

@@ -0,0 +1,18 @@
+{
+  "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

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

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 François Best <contact@francoisbest.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,42 @@
+# `check-env`
+
+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)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=47ng/check-env)](https://dependabot.com)
+
+## Installation
+
+```
+yarn add @nitra/check-env
+```
+
+## Usage
+
+```js
+import checkEnv from '@nitra/check-env'
+
+checkEnv(
+  // Will log an error and throw if any of these are missing:
+  [
+    'SOME_API_SECRET',
+    'PRIVATE_TOKEN',
+    'SOME_OTHER_IMPORTANT_THING'
+    // ...
+  ]
+)
+```
+
+If some required environment variable are not set, it will tell you and throw
+an error at the end:
+!["CLI output"](output.png)
+
+## License
+
+[MIT](https://github.com/47ng/check-env/blob/master/LICENSE) - Made with ❤️ by [François Best](https://francoisbest.com)
+
+Using this package at work ? [Sponsor me](https://github.com/sponsors/franky47) to help with support and maintenance.

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@nitra/check-env",
+  "version": "2.0.3",
+  "description": "Check that the critical environment variables are set",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "scripts": {
+    "standard": "npx standard --fix",
+    "fix": "npx standard --fix && npx prettier --write .",
+    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nitra/checkenv.git"
+  },
+  "author": {
+    "name": "François Best",
+    "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",
+    "prettier-config-standard": "^4.0.0"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nitra/checkenv/issues"
+  }
+}

package/test/checkenv.test.js

@@ -0,0 +1,71 @@
+/* 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')
+  }
+})