# @caxy/dotenv-updater 中文文档

规范地址：https://npmcn.com/package/%40caxy/dotenv-updater/

版本：1\.0\.11
npm 元数据更新时间：2025-09-04T20:21:19.493Z
中文译文更新时间：2026-11-09T18:37:12.436Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40caxy/dotenv-updater
原文对照：https://npmcn.com/package/%40caxy/dotenv-updater/?lang=original
项目主页：https://github.com/caxy/dotenv-updater#readme
源码仓库：https://github.com/caxy/dotenv-updater

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：13.1 kB，5 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=8
- 运行依赖：3 个
- 首次发布：2019-08-16T07:39:51.849Z
- 最新版本发布：2025-09-04T20:21:19.290Z
- 近 30 天下载量：1905（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 0 个）

## 中文简介

保持您的 gitignored 本地 .env 文件与 dist 文件的更新 .

## 安装

```sh
npm install @caxy/dotenv-updater
```

也可以使用：`pnpm add @caxy/dotenv-updater`、`yarn add @caxy/dotenv-updater`、`bun add @caxy/dotenv-updater`

## README

[![npm (scoped)](https://img.shields.io/npm/v/@caxy/dotenv-updater?style=flat-square)](https://www.npmjs.com/package/@caxy/dotenv-updater) [![npm](https://img.shields.io/npm/dm/@caxy/dotenv-updater?style=flat-square)](https://www.npmjs.com/package/@caxy/dotenv-updater)

# Dotenv 更新器

多腾夫 更新器是一个模块 保持您的本地,被忽略, `.env` 最新文件 在 dist/ 例如文件中定义的变量, 如 `.env.example`。 。 。 .

它比较你的 `.env` 文件与 `.env.example` (或配置中指定的其他文件),如果有的话 变量从您的 `.env` 文件将交互提示您在命令上的值 线条,并更新您的 `.env` 为你准备的文件.

## 安装

```bash
# with npm
npm install --save-dev @caxy/dotenv-updater

# or with Yarn
yarn add --dev @caxy/dotenv-updater
```

## 使用量

主要使用大小写是运行此脚本与您定义的其他 npm/ Yarn 脚本 `package.json`。 。 。 .

例如,你可以在 `dotenv-updater` 在您通常运行的脚本开头, 这样你就能确保你永远拥有一个最新的内存文件.

```json
# in your package.json

"scripts": {
  "start": "dotenv-updater && node dist/index.js",
  "build": "dotenv-updater && ..."
},
...
```

也可以从项目根部的命令行(或全球安装的任何地方)手动运行:

```bash
dotenv-updater
```

## 配置

您可以在您的配置中添加配置 `package.json` 用于修改一些默认设置的文件, 如果您的文件没有命名, 您肯定想要这样做 `.env.example`。 。 。 .

以下显示可用的配置选项及其默认值 .

```json
# 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` |

## 常见问题

### @caxy/dotenv-updater 是什么？

保持您的 gitignored 本地 \.env 文件与 dist 文件的更新 \.

### 如何安装 @caxy/dotenv-updater？

在项目目录运行 npm install @caxy/dotenv-updater，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 dotenv-updater，可以用 npx dotenv-updater 直接运行。

### @caxy/dotenv-updater 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/caxy\_\_dotenv-updater 是否存在。

### @caxy/dotenv-updater 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=8。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @caxy/dotenv-updater 可以商用吗？

@caxy/dotenv-updater 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @caxy/dotenv-updater 的下载量有多少？

根据 npm 官方下载统计，@caxy/dotenv-updater 在 2026/10/09 – 2026/11/07 这 30 天内被下载 1,905 次，日均约 64 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @caxy/dotenv-updater 还在维护吗？

最新版本 1\.0\.11 发布于 2025/09/05（1\.2 年前）；至今共发布 11 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/08/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。