# @biscuitpants/codemirror-spell-checker 中文文档

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

版本：0\.0\.12
npm 元数据更新时间：2022-04-04T18:56:12.677Z
中文译文更新时间：2026-11-08T03:46:35.063Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40biscuitpants/codemirror-spell-checker
原文对照：https://npmcn.com/package/%40biscuitpants/codemirror-spell-checker/?lang=original
项目主页：https://github.com/biscuitpants/codemirror-spell-checker
源码仓库：https://github.com/biscuitpants/codemirror-spell-checker

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

- 包体积（解压后）：1.5 MB，20 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：1 个
- 首次发布：2021-07-22T16:03:00.800Z
- 最新版本发布：2021-08-10T14:10:36.650Z
- 近 30 天下载量：2366（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 0 个）

## 中文简介

修改并更新了 CodeMirror 的拼写检查器

## 安装

```sh
npm install @biscuitpants/codemirror-spell-checker
```

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

## README

# 代码密钥拼写检查器

拼写检查那么简单,你可以设置在60秒内。 它会突出任何用浅红色拼错的词. 与其他 CodeMirror 模式配合效果很好, 如 GitHub Flavored Markdown .

## 叉头

这是叉子 [火花套房的密码镜检查器](https://github.com/sparksuite/codemirror-spell-checker)。 。 。 .

添加的修改 :

-   数字不被视为拼写错误.
-   27D不被视为拼写错误( 对于27维).
-   切换到 [`hunspell-en_US-large` 词典](https://sourceforge.net/projects/wordlist/files/speller/2018.04.16/) 通过 [国家防范机制一揽子计划](https://www.npmjs.com/package/hunspell-dict-en-us)

![Screenshot](http://i.imgur.com/7yb5Nne.png)

## 安装

通过 [无](https://www.npmjs.com/package/codemirror-spell-checker)。 。 。 .

```
npm install @biscuitpants/codemirror-spell-checker --save
```

通过 [箭头](https://www.bower.io/)。 。 。 .

```
bower install @biscuitpants/codemirror-spell-checker --save
```

通过 [日记](https://www.jsdelivr.com/package/npm/@biscuitpants/codemirror-spell-checker)。 。 。 . _请注意,jsDelivr可能需要几天时间更新最新版._

```HTML
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@biscuitpants/codemirror-spell-checker/latest/spell-checker.min.css">
<script src="https://cdn.jsdelivr.net/npm/@biscuitpants/codemirror-spell-checker/latest/spell-checker.min.js"></script>
```

## 快开始

一旦安装并加载了 CodeMiror,首先向 CodeMiror 拼写检查器提供正确的 CodeMiror 函数. 然后,将主模式设置为 `"spell-checker"` 和您想要的模式的背景模式。 确保装入/需要 `overlay.min.js` 如果你还没有.

```JS
CodeMirrorSpellChecker({
    codeMirrorInstance: CodeMirror,
});

CodeMirror.fromTextArea(document.getElementById("textarea"), {
    mode: "spell-checker",
    backdrop: "gfm" // Your desired mode
});
```

就这样!

## 自定义

您可以通过更新 CSS 自定义拼错的单词外观 。 所有拼错的字都有 `.cm-spell-error` 课.

```CSS
.CodeMirror .cm-spell-error{
    /* Your styling here */
}
```

## 词典

词典是从 [这里](https://spellcheck-dictionaries.github.io/)。 。 。 .

## 配置

-   **自定义字**: 自定义不会被视为拼写错误的单词(或函数返回数组)的数组。 默认为空数组.
-   **忽略正则x**: 自定义 regex 以检查是否应该忽略匹配的单词 。 默认为 `/[0-9'_-]+/`
-   **单词Regex**: 自定义 regex 以匹配要对照词典检查的单词 。 默认为 `/^[^!"#$%&()*+,\-./:;<=>?@[\\\]^_`+/
-   **词典标签**: 一旦词典被装入内存后运行的函数 .
-   **词典语言**: 要使用的字典字符串名称。 可找到支持的词典 [这里](https://spellcheck-dictionaries.github.io/)。 。 。 .
-   **注释开始**:表示评论行开始的字符串。 拼写将被忽略以备评论 .

```JavaScript
// Most options demonstrate the non-default behavior
CodeMirrorSpellChecker({
    codeMirrorInstance: CodeMirror,
    customWords: ["CodeMirror", "GitHub"],
});
```

`customWords` 既可以是字符串的矩阵,也可以是返回字符串的函数.

```JavaScript
CodeMirrorSpellChecker({
    codeMirrorInstance: CodeMirror,
    customWords: function() { return ["NPM", "Javascript"]; },
});
```

## 常见问题

### @biscuitpants/codemirror-spell-checker 是什么？

修改并更新了 CodeMirror 的拼写检查器

### 如何安装 @biscuitpants/codemirror-spell-checker？

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

### @biscuitpants/codemirror-spell-checker 支持 TypeScript 吗？

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

### @biscuitpants/codemirror-spell-checker 支持 ESM 还是 CommonJS？

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

### @biscuitpants/codemirror-spell-checker 可以商用吗？

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

### @biscuitpants/codemirror-spell-checker 的下载量有多少？

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

### @biscuitpants/codemirror-spell-checker 还在维护吗？

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