在编程中,百分之九十的问题可能是粗心大意导致的,而拼写错误是粗心大意的主要原因
社区中推出一个解决Typo的自动化工具 CSpell, 用于检查项目中的 typo
CSpell
CSpell 是一个开源的拼写检查工具,专门用于检查源代码文件中的拼写错误。它通常用于开发环境,帮助开发者确保代码中的注释、文档、变量名、字符串等文本部分没有拼写错误,从而提升代码的可读性和质量
CSpell 提供 npm 安装包,下面开始在项目中安装 cspell
快速开始
在项目中安装 cspell
yarn add cspell -D
然后在根目录的 package.json 中添加 npm script
"cspell": "cspell src/**/*.{ts,tsx,js,mjs,jsx}"
在项目中的某个文件里写一个错误的单词
在终端里运行 yarn cspell
, 其结果如下
cspell 会检查出有typo的单词,并且给出提示。
cspell "src/**/*.js"
# or
cspell lint "src/**/*.js"
表示检查 src
文件下所有的 js
文件
cspell "**"
检查项目中的所有文件
如何设置配置文件
CSpell 支持使用配置文件对 CSpell 进行更详细的控制。CSpell 可以使用 JSON、Yaml 和 JavaScript 文件进行配置。它会自动搜索以下之一:cspell.json
、cspell.config.yaml
、cspell.config.cjs
。笔者使用 cspell.json
请看下面这个配置例子
{
"$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
"version": "0.2",
"dictionaryDefinitions": [
{
"name": "typo-words",
"path": "./typo-words.txt",
"addWords": true
}
],
"dictionaries": ["typo-words"],
"ignorePaths": ["node_modules", "dist", "build"]
}
"name": "typo-words"
:定义了一个自定义词典的名称,叫做typo-words
。"path": "./typo-words.txt"
:指定了自定义词典文件的路径,这里是当前目录下的 typo-words.txt 文件。"addWords": true
:表示可以向这个自定义词典中添加新词。"dictionaries": ["typo-words"]
:指定了要使用的词典,这里使用了前面定义的typo-words
自定义词典。"ignorePaths": ["node_modules", "dist", "build"]
:指定了要忽略的路径,Code Spell Checker 在这些路径下的文件中不会进行拼写检查。这里忽略了 node_modules、dist
和build
目录。
在根目录添加 typo-words.txt 文件,在里面添加 helol, 再执行 yarn cspell, 结果如下
其他命令参数
一般情况下,项目的文件很多,在执行 cspell 检查的时候,不需要显示查询进度,可以使用命令参数
cspell src/**/*.{ts,tsx,js,mjs,jsx} --no-progress