在前端开发中, 要保证代码的正确性, 文字的准确性是非常重要的. 然而, 由于时间紧张或者粗心大意等原因, 我们难免会犯一些拼写以及语法错误. 如果需要排查这些错误, 则需要在代码中逐个进行查找和修正, 这个过程既费时又费力.
这时候, 一个好用的拼写检查工具就显得尤为重要. Zeppelin-markdown-spell 是一个非常实用的工具, 可以非常方便地解决前端开发过程中的这个问题.
安装
安装是非常简单的，只需要在终端中运行：
npm install -g zeppelin-markdown-spell
这个工具是通过 npm 官方源进行下载和安装. 根据网络速度不同, 需要等待一段不等的时间.
使用方法
安装完成后, 打开终端, 以 markdown 文件为例, 这是一个普通的 markdown 文件.
# one The is a jorscat.. and two
运行以下命令：
zms file.md
会输出以下内容：
file.md:2:13: Typo: jorscat
其中, file.md 是文件名, 2:13 是错误位置, Typo 是错误类型, jorscat 是错误单词.
使用参数
通过默认配置文件运行
默认情况下, Zeppelin-markdown-spell 会读取当前目录下名字为 .zms.json 或者 .spelling 的文件作为相关配置, 如果没有则会采用默认配置. 如果需要修改默认配置, 则需要在当前目录下建立这样的配置文件.
比如, 我们可以新建一个名为 .zms.json 的文件, 文件中指定了需要排除的文件类型和文件夹:
{
"ignoreFiles": ["*.md", "*.js", "*.tag", "*.html"],
"ignoreFolders": ["node_modules", ".git"]
}改变了默认参数后, 运行以下命令：
zms --config=.zms.json
会按照新的配置对 markdown 文件进行检查.
手动配置参数运行
除了采用默认配置和配置文件, 还可以采用命令行参数的方式进行运行. 常用的命令行参数包括：
--dictionary指定自定义字典文件-ior--ignore排除某个目录或文件-cor--color指定错误信息前景色
以下是一个自定义字典文件格式的例子
-- -------------------- ---- ------- - -------- ------------ ------------ ----------- ----------- ----------- ------------------------- ----------- -------------------------- ---------- ---------------- ----- -------------- ----- ---------- ----- -
运行命令：
zms --ignore=dist,lib --dictionary=mydict.json file.md
根据设定的参数, Zeppelin-markdown-spell 会对 file.md 进行检查并输出检查结果.
总结
在大型项目中, 经常需要针对代码和文本进行校对, 但这个过程常常是十分耗时和繁琐的. Zeppelin-markdown-spell 可以大幅度改善这个问题, 并且其有多种方式的配置可以适应不同需求, 是一款十分值得推荐的工具.
错误纠正示例
我们此前检查的文件一句为
The is a jorscat..
正确的句子是
This is a zebra.
经过纠正后, markdown 文件变为
# one This is a zebra. and two
这样, 我们就使用 Zeppelin-markdown-spell 完成了对文本的检查和纠正, 存在的错误被很好地修正了.
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005555281e8991b448d2845