# @dotcraft/plugin 中文文档

规范地址：https://npmcn.com/package/%40dotcraft/plugin/

版本：0\.11\.1
npm 元数据更新时间：2026-11-12T16:04:02.617Z
中文译文更新时间：2026-11-12T23:14:04.647Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40dotcraft/plugin
原文对照：https://npmcn.com/package/%40dotcraft/plugin/?lang=original
项目主页：https://github.com/DotHarness/dotcraft/tree/main/sdk/typescript/packages/plugin
源码仓库：https://github.com/DotHarness/dotcraft

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

- 包体积（解压后）：113 kB，32 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：2 个
- peer 依赖：react ^19\.0\.0，react-dom ^19\.0\.0
- 首次发布：2026-08-27T11:27:14.264Z
- 最新版本发布：2026-11-12T16:04:02.140Z
- 近 30 天下载量：3266（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：51（近 12 个月 51 个）

## 中文简介

DotCraft 插件桌面模块的 TypeScript 和 React 编写工具

## 安装

```sh
npm install @dotcraft/plugin
```

也可以使用：`pnpm add @dotcraft/plugin`、`yarn add @dotcraft/plugin`、`bun add @dotcraft/plugin`

## README

# @ dotcraft/ 插件

`@dotcraft/plugin` 提供公共合同、运行时间约束和构建命令 信任的 DotCraft 桌面扩展 。 使用节点.js 20 或以后与 React 19 和 `react-dom` 19.

## 安装

```shell
npm install --save-dev @dotcraft/plugin
```

## 启动

```tsx
import type { DesktopPluginActivate } from '@dotcraft/plugin'

export const activate: DesktopPluginActivate = (host) => {
  host.ui.add('composer.toolbar.leading', ({ context }) => (
    context.minimalChrome ? null : <button type="button">Review</button>
  ))
}
```

## 文档

-   [构建桌面扩展名](https://www.dotcraft.net/extend/desktop-extensions)
-   [桌面扩展 API](https://www.dotcraft.net/extend/desktop-extension-api)

## 常见问题

### @dotcraft/plugin 是什么？

DotCraft 插件桌面模块的 TypeScript 和 React 编写工具

### 如何安装 @dotcraft/plugin？

在项目目录运行 npm install @dotcraft/plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^19\.0\.0）、react-dom（^19\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 dotcraft-plugin，可以用 npx dotcraft-plugin 直接运行。

### @dotcraft/plugin 支持 TypeScript 吗？

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

### @dotcraft/plugin 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @dotcraft/plugin 需要什么版本的 Node\.js？

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

### @dotcraft/plugin 可以商用吗？

@dotcraft/plugin 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dotcraft/plugin 的下载量有多少？

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

### @dotcraft/plugin 还在维护吗？

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