Dotenv 更新器
多腾夫 更新器是一个模块 保持您的本地,被忽略, .env 最新文件
在 dist/ 例如文件中定义的变量, 如 .env.example。 。 。 .
它比较你的 .env 文件与 .env.example (或配置中指定的其他文件),如果有的话
变量从您的 .env 文件将交互提示您在命令上的值
线条,并更新您的 .env 为你准备的文件.
安装
# with npm
npm install --save-dev @caxy/dotenv-updater
# or with Yarn
yarn add --dev @caxy/dotenv-updater
使用量
主要使用大小写是运行此脚本与您定义的其他 npm/ Yarn 脚本 package.json。 。 。 .
例如,你可以在 dotenv-updater 在您通常运行的脚本开头,
这样你就能确保你永远拥有一个最新的内存文件.
# in your package.json
"scripts": {
"start": "dotenv-updater && node dist/index.js",
"build": "dotenv-updater && ..."
},
...
也可以从项目根部的命令行(或全球安装的任何地方)手动运行:
dotenv-updater
配置
您可以在您的配置中添加配置 package.json 用于修改一些默认设置的文件,
如果您的文件没有命名, 您肯定想要这样做 .env.example。 。 。 .
以下显示可用的配置选项及其默认值 .
# in your package.json
{
# ...
"dotenvUpdater": {
"envFile": ".env",
"distFile": ".env.example",
"checkExtraVars": true
}
}
选项
| 选项名称 | 说明 | 默认值 |
|---|---|---|
| 环境文件 | 本地 Env 文件的名称 。 此文件将在 distFile 中找到新的变量来更新 。 这个文件经常被忽略,被排除在源控制之外,因为它可能包含敏感的信息. | ".env" |
| 单数 | "dist"env文件的名称,它作为可供定义的环境变量的空模板. 此文件常被跟踪在寄存器中,并有默认/位置持有人值. | ".env.example" |
| 检查外部变量 | 布尔旗以启用/失效“ 检查额外 vars” 特性 。 设定为 true,脚本将检查是否在 envFile 未定义在 distFile。如果找到任何信息,将会向控制台打印一个信息,显示在 dist 文件中没有找到额外的变量,并将包括哪些变量. 这里的想法是,如果有任何额外的变量 envFile,它们可能已经过时/不再使用并且可以删除,或者可能表明 distFile 缺少一些使用的变量,应当用这些变量来更新. 这将不删除任何变量 envFile,它只会登录一个消息到控制台. | true |