# @automerge/automerge-codemirror 中文文档

规范地址：https://npmcn.com/package/%40automerge/automerge-codemirror/

版本：0\.2\.0
npm 元数据更新时间：2026-04-13T19:45:06.102Z
中文译文更新时间：2026-11-07T07:09:15.433Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：12.5 kB，15 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2023-06-26T00:01:03.673Z
- 最新版本发布：2025-07-21T15:10:29.901Z
- 近 30 天下载量：2064（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 0 个）

## 中文简介

此插件将协作编辑添加到 codemiror 中 `automerge-repo`。 。 。 .

## 安装

```sh
npm install @automerge/automerge-codemirror
```

也可以使用：`pnpm add @automerge/automerge-codemirror`、`yarn add @automerge/automerge-codemirror`、`bun add @automerge/automerge-codemirror`

## README

# 自动相接 + 密码解码器

此插件将协作编辑添加到 codemiror 中 `automerge-repo`。 。 。 .

## 示例

```typescript
import { Repo } from "@automerge/automerge-repo";
import { automergeSyncPlugin } from "@automerge/automerge-codemirror";
import { EditorView } from "@codemirror/view"
import { basicSetup } from "codemirror"

// Setup a repo and create a doc handle. In practice you'll probably get a
// DocHandle by loading it from a document URL
const repo = new Repo(..)
const doc = repo.create({text: ""})

// Setup the codemirror view
const container = document.createElement("div")
const view = new EditorView({
  doc: handle.doc().text,
  extensions: [
    basicSetup,
    automergeSyncPlugin({
      handle,
      path: ["text"],
    }),
  ],
  parent: container,
})
```

### 自动相容性

此编码器插件用于 `automerge-repo` 2.0 那个 表示它预期会作为 `handle` 参数 匹配签名 `DocHandle` 接口 `automerge-repo` 2.0 (英语). 主要区别是 `automerge-repo` 1.0是自动合并1.0 `DocHandle.doc` 方法是同步的。 如果你不能升级到 `automerge-repo` 2.0 然后,你可以绕过这个 包装1.0 把手 在使用 1.0 对象中 `DocHandle.docSync` 执行《公约》的方法 `DocHandle.doc` 方法。 像这样:

```typescript
import { type DocHandle } from "@automerge/automerge-codemirror"
import { type DocHandle as RepoHandle } from "@automerge/automerge-repo"

// Convert an automerge-repo 1.0 DocHandle to the interface this plugin expects
function makeHandle<T>(h: RepoHandle<T>): DocHandle<T> {
    return Object.assign({}, h, {
        doc: () => h.docSync(),
    })
}
```

## 常见问题

### @automerge/automerge-codemirror 是什么？

此插件将协作编辑添加到 codemiror 中 automerge-repo。 。 。 \.

### 如何安装 @automerge/automerge-codemirror？

在项目目录运行 npm install @automerge/automerge-codemirror，或使用 pnpm add / yarn add / bun add。

### @automerge/automerge-codemirror 支持 TypeScript 吗？

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

### @automerge/automerge-codemirror 支持 ESM 还是 CommonJS？

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

### @automerge/automerge-codemirror 可以商用吗？

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

### @automerge/automerge-codemirror 的下载量有多少？

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

### @automerge/automerge-codemirror 还在维护吗？

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