check-react-env v2.0.0

check-react-env

Check that all used environment variables are set.

❗This tool expects that all env variables have same prefix, eg. VITE_

Installation

npm install --save-dev check-react-env

or

yarn add --dev check-react-env

Usage

Basic Usage

Add this tool before start or build scripts of your application into your package.json. You can also use pre script, more details here.

Specify --prefix param based on your env variables.

"prestart": "check-react-env --prefix=NX_",

Add --env param to specify .env file to analyze.

"prestart": "check-react-env --prefix=NX_ --env=.env.development",

Optionally add --pattern to specify files to analyze, by default equals ./**/*.{ts,tsx,js,jsx}, so it checks all javaScript and typeScript files

"prestart": "check-react-env --prefix=NX_ --env=.env.development --pattern='libs/**/*.{ts,tsx,js,jsx}'",

Parameters

--prefix

• Required: true
• Type: string

A prefix for env variables, eg. VITE_ or NX_.

--env

• Type: string

Path to desired .env file.

--pattern

• Type: string
• Default: ./**/*.{ts,tsx,js,jsx}

Any correct glob pattern. Check fast-glob#basic-syntax for more details.

--ignore-pattern

• Type: string

Glob pattern to exclude matches.

find-new-env

Helps do not forget to provide example for env variables.

Usage

Perfectly to add this tool to the pre-commit hook, using for example husky

find-new-env --example-env=.env.example --prefix=VITE_ --pattern='app/**/*.{ts,tsx,js,jsx}'

Parameters

--prefix

• Required: true
• Type: string

A prefix for env variables, eg. VITE_ or NX_.

--example-env

• Required: true
• Type: string

Path to the file with env examples.

--pattern

• Type: string
• Default: ./**/*.{ts,tsx,js,jsx}

Any correct glob pattern. Check fast-glob#basic-syntax for more details.

--ignore-pattern

• Type: string

Glob pattern to exclude matches.

License

MIT