yaspeller-ci 是一款基于 yaspeller 的命令行工具，可用于检查中英文拼写错误，并支持集成到 CI/CD 流程中。本文将为你详细介绍如何使用 yaspeller-ci 进行拼写检查，并提供一些实用的示例代码。
安装
yaspeller-ci 可以通过 npm 安装：
npm install -D yaspeller-ci
命令行参数
yaspeller-ci 支持以下命令行参数：
--config：指定配置文件路径，默认为.yaspellerrc。--exclude：排除某些文件或目录，多个用逗号分隔。--dictionary：自定义词典文件路径。--report：生成报告文件（JSON 或 HTML），默认不生成。--report-type：报告类型，可选值有 JSON 和 HTML，默认为 HTML。--verbose：详细输出模式。--help：显示帮助信息。
配置文件
yaspeller-ci 支持使用配置文件进行设置，配置文件应该是一个 JSON 文件，可以包含以下字段：
dictionary：自定义词典文件路径。exclude：排除某些文件或目录，数组类型。reportType：报告类型，可选值有 JSON 和 HTML，默认为 HTML。- 其他 yaspeller 支持的配置项。
以下是一个示例配置文件 .yaspellerrc：
{ "dictionary": ".mydict", "exclude": ["node_modules", "dist"], "ignoreText": [ "/<img src=(.*?)>/gi", "/<a href=(.*?)<\/a>/gi" ] }
集成到 CI/CD 流程
yaspeller-ci 可以集成到 CI/CD 流程中，在每次代码提交时自动进行拼写检查，如果检查失败，则可以阻止代码合并。下面以 GitHub Actions 为例，演示如何集成 yaspeller-ci。
在仓库根目录创建
.github/workflows/spelling.yml文件。在
spelling.yml文件中添加以下内容：-- -------------------- ---- ------- ----- -------- ----- --- ----- --------- - ---- ----- --------- -------- ------------- ------ - ----- -------- ---- ----- ------------------- - ----- ------- ------------ ---- --- -- - ----- --- -------- ----- ---- --- ------------ - ----- ---- -- -------- ------ --- ----- ---- - -- - -- --- - -- ---- ---- - ---- ---- --------- ------ ---- ------- ---- - --
展开代码提交并推送代码到 GitHub，此时会触发 GitHub Actions 进行拼写检查。
如果检查失败，则 GitHub Actions 将会返回错误，阻止代码合并。
实例代码
以下是一个示例代码，它演示了如何使用 yaspeller-ci 进行拼写检查，并输出检查结果：
-- -------------------- ---- ------- ----- --------- - ------------------------ ----- -------- ------ - ----- ------ - ----- ----------- ------ ----------------------- ----------- ---------- ----------- ------ --- -------------------- - ----------------------------展开代码
上述示例代码中，我们使用了 yaspeller-ci 包的默认导出函数。该函数接受一个对象作为参数，可以通过该对象的属性来设置命令行参数和配置文件字段。
总结
本文介绍了 yaspeller-ci 的基本用法和一些实用技巧，并提供了集成到 CI/CD 流程的示例代码。希
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/44690
