简介
cspell-tools 是一个用于拼写检查的 npm 包，它可以帮助我们在代码编写过程中检查单词拼写错误。它支持多种语言，并且可以在终端或者在编辑器中使用。
安装
使用 npm 进行全局安装。
npm install -g cspell-tools
使用方法
检查文件
我们可以直接使用 cspell 命令来检查文件的拼写，例如：
cspell index.js
这将会检查 index.js 文件中的拼写错误。
检查文件夹
我们可以使用 cspell "**/*.js" 命令来检查某个文件夹下所有的 .js 文件。这里使用了 glob 语法，** 代表零个或多个目录层级。
cspell "**/*.js"
检查多个文件
要检查多个文件，我们可以在命令中列举多个文件名，用空格隔开。例如：
cspell index.js utils.js
输出格式
cspell 提供了多种输出格式，可以帮助我们更好地分析检查结果。
默认输出
默认输出格式包含所有的拼写错误，以及行号和列号信息。
cspell index.js ... index.js:39:20 - Spelling Error: 'prototyp' is not a valid spelling (protot) ...
JSON 输出
JSON 格式输出可以帮助我们方便地使用脚本来处理结果。
-- -------------------- ---- ------- ------ ------- -------- --- - ------- ----------- --------- ----- ------------- --- --------------- --- ------------- --- ----------- ----- ------------- ----------------------------- - ---展开代码
VS Code 输出
如果你使用 VS Code，可以使用 --extension 命令来输出 VS Code 友好的错误格式。
cspell --extension=text ms-python.python-2020.10.332292344.json ... ms-python.python-2020.10.332292344.json:193,35 Spelling Error: 'lineout' is not a valid spelling of 'line up', suggest: line up ...
检查代码
我们可以在代码中直接使用 cspell-parser 模块来检查拼写错误。
-- -------------------- ---- ------- ----- - ------ ---------------- - - ------------------------- ----- ---- - ---- -- - ----------- -- ------ ----- ------ - ------------------- -- ----- ---- ----- ------- - ----------- --------展开代码
配置
我们可以通过配置文件来自定义检查规则和语言支持。
cspell 支持多种配置文件格式，例如 JSON、YAML 和 INI。
我们可以在当前目录下的 .cspell.json 文件中指定规则, 例如：
{ "version": "0.1", "language": "en", "words": ["varibale"] }
这将会忽略 varibale 这个单词的拼写错误。
总结
cspell-tools 是一个非常实用的拼写检查工具，它可以帮助我们更好地保证代码的质量。本文介绍了 cspell-tools 的基本使用方法和一些高级特性，希望能够对你有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/63592
