# @cspell/cspell-tools 中文文档

规范地址：https://npmcn.com/package/%40cspell/cspell-tools/

版本：10\.4\.1
npm 元数据更新时间：2026-11-06T17:19:44.692Z
中文译文更新时间：2026-11-11T03:19:38.919Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40cspell/cspell-tools
原文对照：https://npmcn.com/package/%40cspell/cspell-tools/?lang=original
项目主页：https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-tools#readme
源码仓库：https://github.com/streetsidesoftware/cspell

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

- 包体积（解压后）：90.9 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.18\.0
- 运行依赖：6 个
- 首次发布：2020-12-31T13:57:46.997Z
- 最新版本发布：2026-11-06T17:19:44.314Z
- 近 30 天下载量：3476（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：319（近 12 个月 39 个）

## 中文简介

协助开发 cSpell 的工具

## 安装

```sh
npm install @cspell/cspell-tools
```

也可以使用：`pnpm add @cspell/cspell-tools`、`yarn add @cspell/cspell-tools`、`bun add @cspell/cspell-tools`

## README

# CSpell 工具

用于协助CSpell开发的工具.

该工具的主要用途是构建cspell使用的词典. 此工具将把一个单词列表或hunspell文件转换为cspell可以使用的文件.

## 安装

```sh
npm install -g @cspell/cspell-tools
```

## 使用量

```sh
cspell-tools-cli --help
```

要创建单词列表 .

```sh
cspell-tools-cli compile keywords.txt -o ./dictionaries/
```

这将过滤从 `keywords.txt` 写给 `./dictionaries/keywords.txt.gz`。 。 。 .

从 hunspell 文件创建 tree 文件 .

```sh
cspell-tools-cli compile-trie english.dic
```

这将读出并扩展 `english.dic` 基于规则的文件 `english.aff` 输入名为新文件 `english.trie.gz`

对于大的文件来说,这个过程需要很长时间,我们也需要很多记忆.

工具 `cspell-trie` 可用于读取 a 的内容 `.trie` 或者说 `.trie.gz` 文档.

## 企业的 CSpell

作为Tidelift订阅的一部分提供.

Cspell和其他上千个软件包的维护者与Tidelift合作,为您用于构建应用程序的开源软件包提供商业支持和维护. 节省时间,降低风险,改善代码健康,同时向维护者支付使用的确切包. [学多取.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)

  

* * *

带给你的 [![Street Side Software Logo](https://i.imgur.com/CyduuVY.png) 街边软件](https://streetsidesoftware.com/ "Street Side Software")

## 常见问题

### @cspell/cspell-tools 是什么？

协助开发 cSpell 的工具

### 如何安装 @cspell/cspell-tools？

在项目目录运行 npm install @cspell/cspell-tools，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cspell-tools、cspell-tools-cli，可以用 npx cspell-tools 直接运行。

### @cspell/cspell-tools 支持 TypeScript 吗？

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

### @cspell/cspell-tools 支持 ESM 还是 CommonJS？

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

### @cspell/cspell-tools 需要什么版本的 Node\.js？

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

### @cspell/cspell-tools 可以商用吗？

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

### @cspell/cspell-tools 的下载量有多少？

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

### @cspell/cspell-tools 还在维护吗？

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