npm 包 spelly 使用教程

阅读时长 4 分钟读完

简介:

Spelly 是一个基于 JavaScript 的拼写检查工具,它可以帮助前端开发者快速发现并修复拼写错误。该工具使用简单、易于安装,适用于 JavaScript、TypeScript、JSX、TSX 等项目。本篇文章将介绍如何在项目中正确使用 Spelly 工具。

安装 Spelly:

在使用 Spelly 之前,需要先安装在项目中, 在终端中进入项目目录并运行以下命令。

或者,您也可以使用 yarn 安装:

在项目中使用 Spelly:

在安装 Spelly 之后,我们需要将其引入项目,并运行以下命令以检查拼写错误。

<file/to/check.txt> 表示您要检查的文件路径,例如:

Spelly 检查语言支持:

Spelly 提供多种语言支持。在运行命令时,可使用 -l--language 标志指定语言。例如,如果您想要检查的语言是英语,则应运行以下命令:

Spelly 支持的所有语言名称以降序排列,如下所示:

您可以从以上选项中选择一个适合您的语言。

Spelly 忽略规则:

在检查文件时,有时您需要忽略某些特定单词或行。可以使用 -g--ignore 标志指定这些单词或行。例如,若您想要忽略文件中的错误单词 color,则应运行以下命令:

您还可以使用“#”表示一行的开头以进行忽略。例如,若您想要忽略文件中的错误行:

则应运行以下命令:

Spelly 高级选项:

在使用 Spelly 时,您还可以设置许多其他选项以更好地适应您的项目需要。可以使用-r--ruleset 将规则文件用于检查。另外,还可以使用 -e--ext 来指定检查的文件扩展名。例如,若您想让 Spelly 检查 TypeScript 的文件,则应运行以下命令:

此外,还支持其他多项高级选项。详细信息请参考 Spelly文档

总结:

Spelly 作为一款前端拼写检查工具,可以帮助开发者快速发现并修复拼写错误。从安装到使用,本篇文章已经为大家详细讲解了如何在项目中使用 Spelly 工具,快来一试吧!

代码示例

下面是一个 TypeScript 项目的示例代码:

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

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

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

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

我们运行以下命令,将会发现工具会检查到 title 是个单词错误。

Spelly 帮我们找到了单词错误,那么我们就能正确地修改代码了。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600670a48ccae46eb111f12f

纠错
反馈