# @atlaskit/editor-plugin-custom-autoformat 中文文档

规范地址：https://npmcn.com/package/%40atlaskit/editor-plugin-custom-autoformat/

版本：30\.0\.0
npm 元数据更新时间：2026-10-27T02:04:18.950Z
中文译文更新时间：2026-11-07T03:02:10.651Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40atlaskit/editor-plugin-custom-autoformat
原文对照：https://npmcn.com/package/%40atlaskit/editor-plugin-custom-autoformat/?lang=original
项目主页：https://bitbucket.org/atlassian/atlassian-frontend-mirror#readme
源码仓库：https://bitbucket.org/atlassian/atlassian-frontend-mirror

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

- 包体积（解压后）：74 kB，56 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：react ^18\.2\.0 \|\| ^19\.2\.0，react-dom ^18\.2\.0 \|\| ^19\.2\.0，@atlaskit/editor-common ^134\.0\.0
- 首次发布：2023-12-22T04:53:31.871Z
- 最新版本发布：2026-10-27T02:04:18.131Z
- 近 30 天下载量：25158（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：85（近 12 个月 31 个）

## 中文简介

自定义@atlaskit/ editor- core 的自动格式插件

## 安装

```sh
npm install @atlaskit/editor-plugin-custom-autoformat
```

也可以使用：`pnpm add @atlaskit/editor-plugin-custom-autoformat`、`yarn add @atlaskit/editor-plugin-custom-autoformat`、`bun add @atlaskit/editor-plugin-custom-autoformat`

## README

# 编辑器插件自定义自动格式

自定义@atlaskit/ editor- core 的自动格式插件

**说明:** 这一构成部分是为阿特拉斯系统内部开发而设计的. 外部捐助者将能够使用这一构成部分,但无法提交问题.

## 概览

自定义自动格式插件为Atlassian编辑器提供了文本模式匹配和替换能力. 它与自动格式化提供商相融合,以检测用户自定义的文本模式并自动取而代之以格式化内容,如内置卡或已转换的文本节点.

## 主要特点

-   **模式匹配** - 利用自定义规则检测和匹配用户类型的文本模式
-   **同步替换** - 与替换内容同步确定模式
-   **以提供者为基础的规则** - 从自动格式提供者动态地装入自动格式化规则
-   **软断开支持** - 正确处理跨软线断层的自动格式
-   **国家管理** - 跟踪解决和用位置再绘图完成替换
-   **历史融合** - 与ProseMirror历史适当结合,用于撤销/重做功能

## 安装

* * *

-   **安装** - 说吧 _线条添加@atlaskit/editor-plugin-custom-autoformat_
-   **无** - 说吧 [@atlaskit/editor-plugin-海关-自动格式](https://www.npmjs.com/package/@atlaskit/editor-plugin-custom-autoformat)
-   **来源** - 说吧 [键盘](https://bitbucket.org/atlassian/atlassian-frontend/src/master/packages/editor/editor-plugin-custom-autoformat)
-   **套装** - 说吧 [unpkg.com (英语)](https://unpkg.com/@atlaskit/editor-plugin-custom-autoformat/dist/)

## 使用量

* * *

**仅内部使用**

@atlaskit/editor-plugin-custom-autiform 供@atlaskit/editor-core内部使用,并作为编辑器在您产品中的插件依赖.

不支持直接使用此组件.

请看 [Atlaskit - 编辑器插件自定义自动格式](https://atlaskit.atlassian.com/packages/editor/editor-plugin-custom-autoformat) 用于此软件包的文档和示例.

## 支助

* * *

对于内部阿特拉斯人, 访问懒惰的通道 [\# 帮助编辑器 #](https://atlassian.slack.com/archives/CFG3PSQ9E) 支助或访问 [去/编辑-帮助](https://go/editor-help) 以提交错误.

## 许可证

* * *

请看 [阿特拉斯前端 - 许可证](https://hello.atlassian.net/wiki/spaces/AF/pages/2589099144/Documentation#License) 获取更多的许可证信息.

## 常见问题

### @atlaskit/editor-plugin-custom-autoformat 是什么？

自定义@atlaskit/ editor- core 的自动格式插件

### 如何安装 @atlaskit/editor-plugin-custom-autoformat？

在项目目录运行 npm install @atlaskit/editor-plugin-custom-autoformat，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^18\.2\.0 \|\| ^19\.2\.0）、react-dom（^18\.2\.0 \|\| ^19\.2\.0）、@atlaskit/editor-common（^134\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @atlaskit/editor-plugin-custom-autoformat 支持 TypeScript 吗？

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

### @atlaskit/editor-plugin-custom-autoformat 支持 ESM 还是 CommonJS？

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

### @atlaskit/editor-plugin-custom-autoformat 可以商用吗？

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

### @atlaskit/editor-plugin-custom-autoformat 的下载量有多少？

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

### @atlaskit/editor-plugin-custom-autoformat 还在维护吗？

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

