简介
textlint 是一个可扩展的文本检查工具，用于检查文本使用和写作风格，以及其他自定义功能，比较适用于日本语言处理。textlint-rule-helper 是一个 npm 包，用于编写 textlint 规则插件的工具，帮助我们更方便地封装和复用规则插件。
本文将介绍如何使用 npm 包 textlint-rule-helper，其适用于前端类开发工程师。读者可以从本文中学习到如何利用 textlint 插件编写自己的 textlint 规则插件。
安装
textlint-rule-helper 是 textlint 插件的必要工具，需要全局安装才能使用。我们可以使用 npm 命令安装 textlint-rule-helper。
npm install -g textlint-rule-helper
使用
- 初始化
使用 textlint-rule-helper 的第一步是进行初始化，我们可以使用以下命令行进行初始化。
textlint-rule-helper init
这个命令会在当前目录下生成一个名为 rule-helper 的文件夹，再生成一个名为 helper.js 的文件，这个文件是我们后面使用的核心文件。
- 定义检查的规则
我们可以使用 textlint-rule-helper 提供的 api，编写我们的检查规则。
例如，我们来编写一个检查文章中是否使用了过时的技术词汇的规则插件。我们定义规则名称是 outdated-word，这样我们可以在 textlint 配置文件中引用它。
-- -------------------- ---- ------- -- --------------------- ----- - ---------- - - -------------------------------- -- -------------- -------------- - -------------------- -- - -- --------- ----- ------------- - ---------- ---------- --------- ----------- --------- ------ - -- --- -------- -- -------------- - ---------------------------- -- - -- --------------------- ----- ------ - --- ------------ ----- -- ----------------------- - -------------------- -------------------------- - --- -- -- ---展开代码
- 构建并发布 npm 包
构建完成后，我们可以使用 npm pack 命令打包并生成一个 tar 包文件。我们可以将这个 tar 包文件发布到 npm 的服务器上进行分享，供其他人使用。
npm pack
npm publish- 在配置文件中使用我们的规则插件
在我们的 textlint 配置文件中，我们可以使用我们自己的规则插件，比如我们可以将自己定义的规则 outdated-word 引入到 .textlintrc.js 中进行使用。
module.exports = { rules: { 'outdated-word': true, ... } ... }
- 在文本中测试我们自己定义的规则
最后，我们可以编写一篇文章，在其中使用我们自己定义的技术词汇进行测试。当检测到文章中使用了过时的技术词汇时，textlint 将会抛出错误。
示例
我们可以定义一个简单的文本测试。
// 文本内容 test.md Internet Explorer 是一款浏览器，Netscape Navigator 是一款可以浏览网页的软件。
在我们自己的规则插件中查找并检查文本中使用了过时的技术词汇。
-- -------------------- ---- ------- -- --------------------- ----- - ---------- - - -------------------------------- -- -------------- -------------- - -------------------- -- - -- --------- ----- ------------- - ---------- ---------- --------- ----------- --------- ------ - -- --- -------- -- -------------- - ---------------------------- -- - -- --------------------- ----- ------ - --- ------------ ----- -- ----------------------- - -------------------- -------------------------- - --- -- -- ---展开代码
查找到过时的技术词汇后将在控制台中输出对应的错误信息。
$ textlint test.md [unexpected-word] 文章中使用了过时的技术词汇“Internet Explorer” at line 1 column 1: Internet Explorer 是一款浏览器，Netscape Navigator 是一款可以浏览网页的软.件 [unexpected-word] 文章中使用了过时的技术词汇“Netscape Navigator” at line 1 c.olumn 14: Internet Explorer 是一款浏览器，Netscape Navigator 是一款可以浏览网页的软件。 ✖ 2 problems
结语
textlint-rule-helper 帮助我们快速开发和封装 textlint 规则插件。它使我们能够更方便地使用 textlint，提高了效率和质量。个人认为 textlint-rule-helper 是非常实用的 npm 包，我们可以根据实际需求，自由地编写我们自己的 textlint 规则插件，值得使用和推荐。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/72075
