Easily generate env.d.ts files for .env files
// ./env.d.ts
declare global {
namespace NodeJS {
interface ProcessEnv {
AK: string
SK: string
}
}
}
export {}npx gen-env-dts# npm
npm install --save-dev gen-env-dts
#yarn
yarn add --dev gen-env-dts
#pnpm
pnpm add --save-dev gen-env-dts./package.json
{
"scripts": {
"env-dts": "gen-env-dts"
}
}npm run env-dts-
--input(or-i) -
--output(or-o) -
--template(or-t)
Input file path, default: .env
npx gen-env-dts -i ./path/to/env/fileMultiple input files
npx gen-env-dts -i ./path/to/env/file1 -i ./path/to/env/file2 -o ./path/to/output/file1 -o ./path/to/output/file2NOTE: If multiple input files are set, you need to use
--outputoption to specify all of output files path.
Output file path, default: ./env.d.ts
npx gen-env-dts -o ./path/to/output/fileCustom template file path
npx gen-env-dts -t ./path/to/template/fileDefault template:
// ./template.d.ts
declare global {
namespace NodeJS {
interface ProcessEnv {
// DON'T CHANGE NEXT LINE, this will be replaced by the env variables
TEMPLATE_REPLACE
}
}
}
export {}Your custom template:
// ./my-template.d.ts
export interface MyEnv {
// DON'T CHANGE NEXT LINE, this will be replaced by the env variables
TEMPLATE_REPLACE
}npx gen-env-dts -t ./my-template.d.tsYou will get:
// ./env.d.ts
export interface MyEnv {
AK: string
SK: string
}