# @esbuilder/html 中文文档

规范地址：https://npmcn.com/package/%40esbuilder/html/

版本：0\.0\.6
npm 元数据更新时间：2025-06-05T20:03:57.179Z
中文译文更新时间：2026-11-14T06:42:23.966Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40esbuilder/html
原文对照：https://npmcn.com/package/%40esbuilder/html/?lang=original
项目主页：https://github.com/rx-ts/esbuilder/blob/main/packages/html
源码仓库：https://github.com/rx-ts/esbuilder

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

- 包体积（解压后）：81.2 kB，22 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^12\.20\.0 \|\| ^14\.18\.0 \|\| \>=16\.0\.0
- 运行依赖：2 个
- peer 依赖：esbuild \>=0\.14\.42
- 首次发布：2021-06-28T10:45:37.335Z
- 最新版本发布：2022-07-08T15:21:55.444Z
- 近 30 天下载量：2228（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 0 个）

## 中文简介

简化创建 HTML 文件的插件以服务您的 esbuild 捆绑

## 安装

```sh
npm install @esbuilder/html
```

也可以使用：`pnpm add @esbuilder/html`、`yarn add @esbuilder/html`、`bun add @esbuilder/html`

## README

![](https://worldvectorlogo.com/logos/html5.svg) [![](https://esbuild.github.io/favicon.svg)](https://github.com/evanw/esbuild)

# 新建 HTML 插件

用于简化创建 HTML 文件的插件, 以服务您的 esbuild 捆绑 .

## 技选

-   [使用量](https://npmcn.com/package/%40esbuilder/html/#readme-usage)
    -   [安装](https://npmcn.com/package/%40esbuilder/html/#readme-install)
    -   [API 密码](https://npmcn.com/package/%40esbuilder/html/#readme-api)
-   [发起人](https://npmcn.com/package/%40esbuilder/html/#readme-sponsors)
-   [备份](https://npmcn.com/package/%40esbuilder/html/#readme-backers)
-   [更改日志](https://npmcn.com/package/%40esbuilder/html/#readme-changelog)
-   [许可证](https://npmcn.com/package/%40esbuilder/html/#readme-license)

## 使用量

### 安装

```sh
# yarn
yarn add -D esbuild @esbuilder/html

# npm
npm install -D esbuild @esbuilder/html
```

### API 密码

```ts
import esbuild from 'esbuild'
import { html } from '@esbuilder/html'

// serve mode
await esbuild.serve(
  {},
  {
    entryPoints: ['src/index.html'],
    plugins: [
      html({
        // required in serve mode
        serve: true,
        /**
         * Output filename pattern for `src` attribute in `script` tag,
         * the default value is `[name].[hash]`,
         * you can override it here.
         */
        // entryNames: 'js/[name]',
      }),
    ],
    outdir: 'dist',
    /**
     * required for keeping `dist/index.html` instead of `dist/index.{hash}.html`
     */
    assetNames: ['[name]'],
  },
)

// build mode
await esbuild.build({
  entryPoints: ['src/index.html'],
  plugins: [html()],
  outdir: 'dist',
  assetNames: ['[name]'],
})
```

```html
<!-- src/index.html -->
<!DOCTYPE html>
<html>
  <head>
    <!-- ... -->
  </head>
  <body>
    <script src="index.ts"></script>
  </body>
</html>
```

## 发起人

| 第1类 | 帐号 | 调试 |
| --- | --- | --- |
| [![1stG Open Collective backers and sponsors](https://opencollective.com/1stG/organizations.svg)](https://opencollective.com/1stG) | [![unTS Open Collective backers and sponsors](https://opencollective.com/unts/organizations.svg)](https://opencollective.com/unts) | [![UnTS Open Collective backers and sponsors](https://opencollective.com/unts/organizations.svg)](https://opencollective.com/unts) |

## 备份

| 第1类 | 帐号 | 调试 |
| --- | --- | --- |
| [![1stG Open Collective backers and sponsors](https://opencollective.com/1stG/individuals.svg)](https://opencollective.com/1stG) | [![unTS Open Collective backers and sponsors](https://opencollective.com/unts/individuals.svg)](https://opencollective.com/unts) | [![UnTS Open Collective backers and sponsors](https://opencollective.com/unts/individuals.svg)](https://opencollective.com/unts) |

## 更改日志

每个版本的详细变动记录如下: [变动情况](https://npmcn.com/package/%40esbuilder/html/CHANGELOG.md)。 。 。 .

## 许可证

[麻省理工学院](http://opensource.org/licenses/MIT) © [琼秦](https://github.com/JounQin)@[1stG.me (英语)](https://www.1stg.me/)

## 常见问题

### @esbuilder/html 是什么？

简化创建 HTML 文件的插件以服务您的 esbuild 捆绑

### 如何安装 @esbuilder/html？

在项目目录运行 npm install @esbuilder/html，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：esbuild（\>=0\.14\.42）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @esbuilder/html 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @esbuilder/html 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @esbuilder/html 需要什么版本的 Node\.js？

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

### @esbuilder/html 可以商用吗？

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

### @esbuilder/html 的下载量有多少？

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

### @esbuilder/html 还在维护吗？

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