Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zoontek/valienv
A simple environment variables validator for Node.js, web browsers and React Native ✓
https://github.com/zoontek/valienv
env environment validation
Last synced: about 1 month ago
JSON representation
A simple environment variables validator for Node.js, web browsers and React Native ✓
- Host: GitHub
- URL: https://github.com/zoontek/valienv
- Owner: zoontek
- License: mit
- Created: 2022-02-16T14:34:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-05T15:02:39.000Z (3 months ago)
- Last Synced: 2024-08-09T22:09:12.807Z (about 1 month ago)
- Topics: env, environment, validation
- Language: TypeScript
- Homepage:
- Size: 646 KB
- Stars: 32
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ✓ valienv
A simple environment variables validator for Node.js, web browsers and React Native.
[](https://github.com/zoontek/valienv/blob/main/LICENSE)
[](https://www.npmjs.org/package/valienv)
[](https://bundlephobia.com/result?p=valienv)
## Installation
```sh
$ npm i valienv --save
# --- or ---
$ yarn add valienv
```
## 📘 Usage
This library exports a main function: `validate`.
Using `validators`, you can parse, validate and type required environment variables (other variables will be excluded).
```ts
import { boolean, number, oneOf, string, validate } from "valienv";
// with process.env = {
// ACCENT_COLOR: "#0099e5",
// TIMEOUT_MS: "5000",
// ENABLE_ANALYTICS: "true",
// NODE_ENV: "development",
// }
export const env = validate({
env: process.env,
validators: {
// we validate env using bundled validators
ACCENT_COLOR: string,
TIMEOUT_MS: number,
ENABLE_ANALYTICS: boolean,
NODE_ENV: oneOf("development", "test", "production"),
},
});
// -> typeof env = Readonly<{
// ACCENT_COLOR: string;
// TIMEOUT_MS: number;
// ENABLE_ANALYTICS: boolean;
// NODE_ENV: "development" | "test" | "production";
// }>
```
_⚠️ In case of incorrect environment variables, the function will either exit the process or throw an EnvValidationError, exposing the variable names (but not their values) to prevent your application from starting._
#### overrides
The `overrides` option is useful to override some variables in some contexts.
```ts
import { string, validate } from "valienv";
// with process.env = {
// CONTACT_EMAIL: "[email protected]",
// }
export const env = validate({
env: process.env,
validators: {
CONTACT_EMAIL: string,
},
overrides: {
...(process.env.NODE_ENV === "test" && {
CONTACT_EMAIL: "no-mail",
}),
},
});
// -> typeof env = Readonly<{ CONTACT_EMAIL: string }>
```
_⚠️ The values set has to be correctly typed but are **not** validated._
### Custom validators
By default, `valienv` exports 6 validators: `string`, `number`, `boolean`, `url`, `port` and `email`. It also offers `oneOf`, a helper to create validators for union of string literals.
It's very easy to write your own:
```ts
import { validate, Validator } from "valienv";
// A validator take raw input, try to parse it and
// returns the result in case of valid value:
const buffer: Validator = (value: string = "") => {
const valid = /^[A-F\d]+$/i.test(value);
if (valid) {
return Buffer.from(value);
}
};
// with process.env = {
// COOKIE_KEY: "aba4a6fb2222ef28d81e4be445a51fba",
// }
export const env = validate({
env: process.env,
validators: {
COOKIE_KEY: buffer,
},
});
// -> typeof env = Readonly<{ COOKIE_KEY: Buffer }>
```
You can even go wild by using stricter types, complex parsing, your favorite validation library, etc! 🔥
```ts
import validator from "validator";
import { validate } from "valienv";
// with process.env = {
// ETHEREUM_ADDRESS: "0xb794f5ea0ba39494ce839613fffba74279579268",
// OPENED_COUNTRIES: "FR,BE,DE",
// }
export const env = validate({
env: process.env,
validators: {
// inlined validators return types are correctly inferred
ETHEREUM_ADDRESS: (value = "") => {
if (validator.isEthereumAddress(value)) {
return value;
}
},
OPENED_COUNTRIES: (value = "") => {
const array = value.split(",");
if (array.every(validator.isISO31661Alpha2)) {
return array;
}
},
},
});
// -> typeof env = Readonly<{
// ETHEREUM_ADDRESS: string;
// OPENED_COUNTRIES: string[];
// }>
```
### Optional values
As it's a common pattern to have some optional environment values, we provide `optional`, a small helper to wrap every validator with:
```ts
import { optional, string, validate } from "valienv";
const env = validate({
env: process.env,
validators: {
FOO: optional(string),
},
});
if (env.FOO.defined) {
console.log(env.FOO.value); // FOO.value can only be accessed when defined is true
}
```
You can also wrap validators using a library of your choice. Here's an example with [`@swan-io/boxed`](https://github.com/swan-io/boxed):
```ts
import { string, validate } from "valienv";
import { Option } from "@swan-io/boxed";
const optional =
(validator: Validator): Validator> =>
(value) =>
Option.fromUndefined(validator(value));
const env = validate({
env: process.env,
validators: {
FOO: optional(string),
},
});
env.FOO.match({
Some: (value) => {
// env.FOO is set, you can use its value
},
None: () => {
// env.FOO isn't set
},
});
```
## ❓ Questions
#### Why not handling `NODE_ENV` for us?
Frontend bundlers generally **statically replace** `process.env.NODE_ENV` values at build time, allowing minifiers like [`terser`](https://github.com/terser/terser) to eliminate dead code from production build. Aliasing `NODE_ENV` would prevent such optimisations.
But if you are working with Node.js, feel free to use `oneOf` on `NODE_ENV` if you want.