@47ng/check-env\n Check that the critical environment variables are set for your app,\n and that you did not leave dangerous development overrides in production.\n
\n\n## Installation\n\n```\nyarn add @47ng/check-env\n```\n\n## Usage\n\n```js\nimport { checkEnv } from '@47ng/check-env'\n\ncheckEnv({\n // Will log an error and throw if any of these are missing:\n required: [\n 'SOME_API_SECRET',\n 'PRIVATE_TOKEN',\n 'SOME_OTHER_IMPORTANT_THING'\n // ...\n ],\n\n // Will log an error and throw if any of these are set in production:\n unsafe: [\n 'LOCAL_OVERRIDE_DISABLE_HTTPS',\n 'INSECURE_COOKIES'\n // ...\n ]\n})\n```\n\nIf some required environment variable are not set, it will tell you and throw\nan error at the end:\n\n\n## Error handling\n\nYou can choose to skip throwing an error with the `noThrow` option:\n\n```js\ncheckEnv({\n noThrow: true,\n ...\n})\n```\n\n## Conditional Checks\n\nIf you want to require some variables only in production, you can add a condition\nbefore the variable name, any falsy value will be ignored:\n\n```ts\nconst __PROD__ = process.env.NODE_ENV === 'production'\n\ncheckEnv({\n required: [\n 'ALWAYS_REQUIRED',\n __PROD__ && 'ONLY_REQUIRED_IN_PRODUCTION',\n !__PROD__ && 'YOU_GET_THE_IDEA'\n ]\n})\n```\n\n## Logging\n\nBy default, `check-env` uses `console.err` with emoji.\n\nYou can override the default logging methods with `logMissing` and `logUnsafe`.\n\nExample using [Pino](https://github.com/pinojs/pino):\n\n```js\nconst logger = require('pino')()\n\ncheckEnv({\n logMissing: name => logger.error(`Missing required environment variable ${name}`),\n logUnsafe: name => logger.warn(`Unsafe environment variable ${name} set in production`),\n ...\n})\n```\n\n## License\n\n[MIT](https://github.com/47ng/check-env/blob/master/LICENSE) - Made with ❤️ by [François Best](https://francoisbest.com)\n\nUsing this package at work ? [Sponsor me](https://github.com/sponsors/franky47) to help with support and maintenance.\n","readmeFilename":"README.md","gitHead":"4411c39b90a8bfc8f8bc8a794397bad86b68f7ce","bugs":{"url":"https://github.com/47ng/check-env/issues"},"homepage":"https://github.com/47ng/check-env#readme","_id":"@47ng/check-env@3.0.0-beta.1","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-SmXFgL3CMEms4skBKru+GQv6QO4h93yn8yMgMIhwLbXuHbIEAsMeR0GKKlyeaaThml4IRwll7/Eu2lRkpm+m8g==","shasum":"1cae8a423203b0e4250580dc5b6d9ecfb33ae648","tarball":"https://registry.npmjs.org/@47ng/check-env/-/check-env-3.0.0-beta.1.tgz","fileCount":6,"unpackedSize":11171,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCGzWh3eodNptHGPT1RsTMhhkYm0PCZNN+G4LKNC6kb1wIgU6CtWZDf3qKHHb4AJP+cJ7fMq85CweXYssvWQMpX2Q0="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjWE5yACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoyNhAAh2Zws35iEe6Qy8bzFIa6eB6GSwsaRHCxujtCUS6A/1dbQE2T\r\nKfJtHC6HZL3xWV9TLUEhGIosr+11XNxg2elollhPcKPKJw2KwglzRINur5mq\r\nAeRxwM5nYQ3PMc9gvvVVVwePR5r4OzPFOb4schyLZThKqpE/c2SU//PVaw//\r\nFirWb8AmqdqnnxgrSCaoNoKGQ9oFFQ89aTeWfr3421ESskN+F2Bgmjo8ht6q\r\ngmy4csCiMk8S68cndvgILcRqlqb/e7KjIbmXLeaPWaa/lSbpcwzuVUW5Aj+m\r\nZseE1i0rT8R26oX8DSR+ITScOUZXzQKEgl1ecUNv70Za6nQi5orjhzTP4hcL\r\nvQjlzRWn9JjFeFjGkXxGNHIWCcJFGnEi+2eafxvPYwBoHcmiujj5P89QSo2R\r\nR2nrhtP9maqTJU9eyl5FM+DH3BZxKTfJQa6JdpaDHCwAJQcyhsfEyadEU9yI\r\nChs7LxXFQ13z28DYV3Vc7i0uUe0j8zvo7D/rkPDIDo2GrpKVUAUCU+n0HDbS\r\nPVozv21DMmKKg/HjwfVVeZ2ZVZSoFpZdzMxSh59I4xGWD87dPxIlGIUVkGyq\r\nnWkIf+/iioqpdpriCLxHAzl/NJ0VGi78B4XYiY1MJiJivpKE8Wz9DUll5NkW\r\nryHCd2KW+06PPJVyU2mAew3nOM16KFmTq8E=\r\n=lSwG\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"franky47","email":"accounts@francoisbest.com"},"directories":{},"maintainers":[{"name":"franky47","email":"accounts@francoisbest.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/check-env_3.0.0-beta.1_1666731634636_0.4001860357079925"},"_hasShrinkwrap":false},"3.0.0":{"name":"@47ng/check-env","version":"3.0.0","description":"Check that the critical environment variables are set","license":"MIT","author":{"name":"François Best","email":"contact@francoisbest.com","url":"https://francoisbest.com"},"repository":{"type":"git","url":"git+https://github.com/47ng/check-env.git"},"keywords":["environment","environment-variables"],"publishConfig":{"access":"public"},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","type":"module","sideEffects":false,"exports":{".":{"require":"./dist/index.cjs","import":"./dist/index.mjs","types":"./dist/index.d.ts"}},"scripts":{"test":"jest --coverage","test:watch":"jest --verbose --watch","prebuild":"rm -rf ./dist","build:typecheck":"tsc","build:transpile":"unbuild","build":"run-p build:*","ci":"run-s test build","prepare":"husky install"},"devDependencies":{"@commitlint/config-conventional":"^17.1.0","@types/jest":"^29.2.0","@types/node":"^18.11.4","commitlint":"^17.1.2","husky":"8.x","jest":"^29.2.1","npm-run-all":"^4.1.5","ts-jest":"^29.0.3","ts-node":"^10.9.1","typescript":"^4.8.4","unbuild":"^0.9.4"},"jest":{"verbose":true,"preset":"ts-jest/presets/js-with-ts","testEnvironment":"node"},"prettier":{"arrowParens":"avoid","semi":false,"singleQuote":true,"tabWidth":2,"trailingComma":"none","useTabs":false},"husky":{"hooks":{"commit-msg":"commitlint -E HUSKY_GIT_PARAMS"}},"commitlint":{"extends":["@commitlint/config-conventional"],"rules":{"type-enum":[2,"always",["build","chore","ci","clean","doc","feat","fix","perf","ref","revert","style","test"]],"subject-case":[0,"always","sentence-case"],"body-leading-blank":[2,"always",true]}},"gitHead":"4411c39b90a8bfc8f8bc8a794397bad86b68f7ce","bugs":{"url":"https://github.com/47ng/check-env/issues"},"homepage":"https://github.com/47ng/check-env#readme","_id":"@47ng/check-env@3.0.0","_nodeVersion":"12.20.1","_npmVersion":"6.14.10","dist":{"integrity":"sha512-PCUdJqcX8EhnUoH2ELHSYNq9lnhHOnf5LUj+GLA+Vy3ChFrCLy974ArIulwbhhkg5xIvzKbulWeXTVHcWBASeA==","shasum":"b23f61c33c5789746ce61b9e43ef814e105659b6","tarball":"https://registry.npmjs.org/@47ng/check-env/-/check-env-3.0.0.tgz","fileCount":6,"unpackedSize":11164,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIEbvXqZkUhx72mD+9P5oNUoQBvqLRaN5whdX4pvhVqnYAiEArMo90pJ7zrhNCJkmoSB/tPMcvb+7TSIRyGI+H2+PHCI="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjWFAXACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmq51xAAjOCRkMOZRibmJiin+UEYtV9fukMQWkqMtm9dqzBqw5naLwwt\r\nAUyvy8fkRpL8dmKadxdt0f9RG0n4E0lPNkWdHJU+n33WFp5+mppO/BKOt5br\r\n+naB+D3xAwjkagjlrANXJcKSVF93xY91Z8csPMw5DONk2KKjIyGoYvxCowyp\r\npHQiVuRgVw4nDOZ68iv8b9OVaE0IbpCAno8REwQ06DyvX08c7wp59OzfhbZF\r\nyVaYgWtJQ9ueO2H8JR3lPJz1WUP9gCfCUXYrhDAxDiv7YAdn04Xubfbghdnt\r\nnco48nkPE8/J4bpUCk5PvjpGyHKRKfZY7hqro5++eIUA5LdnHbVCeLOvHoR8\r\nQgkJ+JCy0tF8jjdkGGpbfcEb2BuHOEqx999UirKaTrRw/xVJK0d/uCiUXbpE\r\neqBA4Yr7QjJTB3NhdOLaHPtXCEMuyGZo/SVGpVOANhTRsl2xpntQDRtAm9cd\r\n+FaWHhpl+aHLvB+eBVL7RtsV5503505husgddh8z7Bd1y1dVP/plP7LW4qj8\r\nhg6eOSXxCFKUAqN1lUlh9PGbZv7wl+1m4CO/DEc6B3Kfm9TevpGgXOjwxTUM\r\nTUlAK7RU3VJwOvKJzunvaZP6/jt/FmxaGhtiuuV21P6zaRWPnfg0yaN0aBql\r\nifnJhfocfO2ns3O+GXEf77wBjzCgtBcEfa4=\r\n=x0G0\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"franky47","email":"accounts@francoisbest.com"},"directories":{},"maintainers":[{"name":"franky47","email":"accounts@francoisbest.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/check-env_3.0.0_1666732055082_0.21434044929846063"},"_hasShrinkwrap":false}},"time":{"created":"2018-11-10T20:39:43.219Z","1.0.0":"2018-11-10T20:39:43.533Z","modified":"2022-10-25T21:07:35.306Z","1.1.0":"2018-11-10T21:09:08.623Z","1.2.0":"2018-11-10T21:33:29.208Z","1.2.1":"2018-11-10T21:35:31.807Z","1.3.0":"2019-06-06T12:23:18.669Z","1.3.1":"2019-06-13T16:11:47.982Z","1.4.0":"2019-11-28T13:08:33.484Z","1.5.0":"2020-01-08T14:51:03.272Z","2.0.0":"2020-01-08T17:01:55.032Z","2.0.1":"2020-04-23T15:54:38.353Z","2.0.2":"2020-12-22T19:35:44.688Z","2.1.0":"2022-02-10T13:01:25.935Z","2.1.1":"2022-10-24T14:57:25.429Z","3.0.0-beta.1":"2022-10-25T21:00:34.819Z","3.0.0":"2022-10-25T21:07:35.212Z"},"maintainers":[{"name":"franky47","email":"accounts@francoisbest.com"}],"description":"Check that the critical environment variables are set","homepage":"https://github.com/47ng/check-env#readme","keywords":["environment","environment-variables"],"repository":{"type":"git","url":"git+https://github.com/47ng/check-env.git"},"author":{"name":"François Best","email":"contact@francoisbest.com","url":"https://francoisbest.com"},"bugs":{"url":"https://github.com/47ng/check-env/issues"},"license":"MIT","readme":"@47ng/check-env\n Check that the critical environment variables are set for your app,\n and that you did not leave dangerous development overrides in production.\n
\n\n## Installation\n\n```\nyarn add @47ng/check-env\n```\n\n## Usage\n\n```js\nimport { checkEnv } from '@47ng/check-env'\n\ncheckEnv({\n // Will log an error and throw if any of these are missing:\n required: [\n 'SOME_API_SECRET',\n 'PRIVATE_TOKEN',\n 'SOME_OTHER_IMPORTANT_THING'\n // ...\n ],\n\n // Will log an error and throw if any of these are set in production:\n unsafe: [\n 'LOCAL_OVERRIDE_DISABLE_HTTPS',\n 'INSECURE_COOKIES'\n // ...\n ]\n})\n```\n\nIf some required environment variable are not set, it will tell you and throw\nan error at the end:\n\n\n## Error handling\n\nYou can choose to skip throwing an error with the `noThrow` option:\n\n```js\ncheckEnv({\n noThrow: true,\n ...\n})\n```\n\n## Conditional Checks\n\nIf you want to require some variables only in production, you can add a condition\nbefore the variable name, any falsy value will be ignored:\n\n```ts\nconst __PROD__ = process.env.NODE_ENV === 'production'\n\ncheckEnv({\n required: [\n 'ALWAYS_REQUIRED',\n __PROD__ && 'ONLY_REQUIRED_IN_PRODUCTION',\n !__PROD__ && 'YOU_GET_THE_IDEA'\n ]\n})\n```\n\n## Logging\n\nBy default, `check-env` uses `console.err` with emoji.\n\nYou can override the default logging methods with `logMissing` and `logUnsafe`.\n\nExample using [Pino](https://github.com/pinojs/pino):\n\n```js\nconst logger = require('pino')()\n\ncheckEnv({\n logMissing: name => logger.error(`Missing required environment variable ${name}`),\n logUnsafe: name => logger.warn(`Unsafe environment variable ${name} set in production`),\n ...\n})\n```\n\n## License\n\n[MIT](https://github.com/47ng/check-env/blob/master/LICENSE) - Made with ❤️ by [François Best](https://francoisbest.com)\n\nUsing this package at work ? [Sponsor me](https://github.com/sponsors/franky47) to help with support and maintenance.\n","readmeFilename":"README.md"}