npm 包 codespell 使用教程-JavaScript中文网-JavaScript教程资源分享门户

代码中常常出现拼写错误，虽然这些错误不会使代码运行失败，但它们会减少代码的可读性和可维护性。因此，在开发代码时，及时发现和纠正拼写错误是至关重要的。在本文中，我们将介绍一个基于 Node.js 的 npm 包 codespell，它可以帮助我们自动检测拼写错误。

什么是 codespell?

codespell 是一款基于 Python 开发的自动检测拼写错误的工具，它能够检查代码文件中的拼写错误，并提供相应的建议和纠正方式。此外，codespell 还支持识别 Markdown 和 LaTeX 等文档格式。codespell 安装后可以在终端命令行中通过 codespell 命令使用。

安装 codespell

codespell 可以通过 npm 包管理工具进行安装。在终端中执行以下命令：

npm install -g codespell

如果您已经安装过 Python 环境，codespell 默认使用 Python2。如果您想用 Python3 替代 Python2 运行 codespell，您需要安装 Python3 的环境并指定 environmental variable PYTHON。

使用 codespell

使用 codespell 的命令格式为：

codespell [options] <path> [<path> ...]

path：代码文件或目录的路径，支持多文件和多目录的检查。
options：codespell 支持一些可选选项，包括：

选项	说明
-i, --ignore-words=FILENAME	指定一个包含忽略词的文本文件
-s, --skip=REGEX,...	指定需要跳过检查的文件名/目录名正则表达式

示例：在项目的根目录下使用 codespell 检查所有文件，排除 node_modules 目录和 .git 目录，忽略单词列表 my_words.txt 并将结果输出到文件 spells.log 中，可以使用以下命令：

codespell -s "node_modules|\.git" -i my_words.txt . > spells.log

codespell 支持多个输入 path，可以一次检查所有相关文件。如果 path 是一个目录，则会递归搜索该目录下的所有文件。

codespell 的输出

codespell 在终端输出中，会将每个拼写错误的文件、行号和类型作为一个 item 显示出来，将所有 input files 中的 item 汇总后得到总的 item 数量。以下是一些常见的类型：

错误类型	说明
TYPOS	拼写错误
WHITESPACE	空格错误
DUPLICATED_WORDS	词汇重复
IRREGULAR_WHITESPACE	不规则空格

以下是 codespell 的部分输出（完整输出请见附录）：

$ codespell -s "node_modules|\.git" -i my_words.txt .
./index.js:69:0:TYPOS:"isEemeiulate"=> emulate
./src/codeSample.js:10:0:DUPLICATED_WORDS:"good good code"=> example code
./src/codeSample.md:6:0:HTML_CONTRADICTION:The alternate text for the image, https://unsplash.alternate.jp, is misleading or redundant with the link text. Consider leaving it empty.
3 items checked, 3 found

输出中的第一行表示总共检查了 3 个 item，其中有 3 个出现了错误。每个 item 内容的格式是：

<path>:<line>:<column>:<type>:<wrong_word>=> <right_word>

在代码仓库中集成 codespell

为了让代码仓库中的所有开发者都能方便地使用 codespell 进行拼写错误检查，可以通过添加 .github/workflows/codespell.yml 文件实现集成。示例如下：

-- -------------------- ---- -------
----- ---------

--- ------ -------------

-----
  ----------
    -------- -------------
    ------
    - ----- --------
      ----- -------------------
    - ----- ----- ------- -----------
      ----- --------------------------
      -----
        ------------- --
    - ----- ------- ---------
      ---- --- ------- -- ---------
    - ----- --- ---------
      ---- --------- -- -------------------- -- ------------ -

该配置的含义是：在 push 和 pull_request 事件触发时，在 ubuntu-latest 操作系统上执行 codespell 任务。先通过 actions/checkout@v2 下载代码仓库，然后使用 actions/setup-node@v2-beta 下载 Node.js 环境。接着，在指定的操作系统环境中安装 codespell，最后运行 codespell 并跳过指定文件和目录，忽略指定的单词列表。执行完成后，GitHub Actions 会将 codespell 的输出显示在 pull request 和提交中。

小结

codespell 是一款自动检测拼写错误的工具，可以帮助开发者及时发现和纠正这种错误，提高代码的可读性和可维护性。本文介绍了 codespell 的安装和使用方法，并演示了在代码仓库中集成 codespell 的过程。希望本文对您有所帮助。

附录

输出结果的完整版本：

$ codespell -s "node_modules|\.git" -i my_words.txt .
./index.js:69:0:TYPOS:"isEemeiulate"=> emulate
./src/codeSample.js:10:0:DUPLICATED_WORDS:"good good code"=> example code
./src/codeSample.md:6:0:HTML_CONTRADICTION:The alternate text for the image, https://unsplash.alternate.jp, is misleading or redundant with the link text. Consider leaving it empty.
3 items checked, 3 found

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60056c4981e8991b448e5ce7