# @fluidware-it/env2doc 中文文档

规范地址：https://npmcn.com/package/%40fluidware-it/env2doc/

版本：0\.3\.2
npm 元数据更新时间：2026-09-18T09:34:54.589Z
中文译文更新时间：2026-11-15T04:45:26.086Z
软件包许可：ISC

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

原始 npm 页面：https://www.npmjs.com/package/%40fluidware-it/env2doc
原文对照：https://npmcn.com/package/%40fluidware-it/env2doc/?lang=original

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

- 包体积（解压后）：10.6 kB，3 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：3 个
- 首次发布：2023-11-18T17:35:59.548Z
- 最新版本发布：2025-11-21T10:23:30.192Z
- 近 30 天下载量：2145（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：5（近 12 个月 1 个）

## 中文简介

EnvParse 使用的文档生成器

## 安装

```sh
npm install @fluidware-it/env2doc
```

也可以使用：`pnpm add @fluidware-it/env2doc`、`yarn add @fluidware-it/env2doc`、`bun add @fluidware-it/env2doc`

## README

# 内存2doc

此工具帮助您跟踪所有使用的环境变量—— 如果访问通过 `@fluidware-it/saddleback` `EnvParse` 函数.

## 使用量

它可以通过 `npx`

```
npx @fluidware-it/env2doc -p /path/to/javascript/files
```

或可以在全球安装,然后使用

```
npm i -g @fluidware-it/env2doc

env2doc -p /path/to/javascript/files

```

默认情况下,它以Markdown格式输出。 使用 `-o json` 以 JSON 格式输出的参数

### 实例

```
node @fluidware-it/env2doc -p ~/Projects/fluidware/express-microservice/build/src

## Environment variables

| ENV                           |     type |                        default | required |
| ----------------------------- | -------- | ------------------------------ | -------- |
| FW_MS_PRE_SHARED_TOKEN_PREFIX |   string |                                |          |
| FW_MS_PORT                    |  integer |                           8080 |          |
| FW_MS_LOG_404                 |  boolean |                          false |          |
| FW_MS_HOSTNAME                |   string |          default to hostname() |          |
| FW_MS_ADDRESS                 |   string |                                |          |
| FW_MS_ADDRESSES               | string[] |                                |          |
| FW_MS_TRUST_PROXY             | string[] | loopback,linklocal,uniquelocal |          |
| FW_MS_MAX_UPLOAD_SIZE         |   string |                          128kb |          |
| FW_MS_JWT_PUBLIC_KEY          |   string |                                |          |
| FW_MS_KEY                     |   string |                                |          |
| FW_MS_CERT                    |   string |                                |          |
```

## 常见问题

### @fluidware-it/env2doc 是什么？

EnvParse 使用的文档生成器

### 如何安装 @fluidware-it/env2doc？

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

### @fluidware-it/env2doc 支持 TypeScript 吗？

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

### @fluidware-it/env2doc 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @fluidware-it/env2doc 可以商用吗？

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

### @fluidware-it/env2doc 的下载量有多少？

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

### @fluidware-it/env2doc 还在维护吗？

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