在前端开发中，我们通常需要编写和维护大量的文档和博客。为了保证文档质量和可读性，在编写过程中经常需要遵循一些规范和最佳实践。其中之一就是不要使用字面URL链接。为了方便开发者在编写文档时能够快速检查并修正这类问题，npm社区推出了一个非常好用的工具：remark-lint-no-literal-urls。
什么是remark-lint-no-literal-urls？
remark-lint-no-literal-urls 是一个 remark-lint 插件，它可以帮助开发者检查文档中是否包含字面URL链接。当该插件被应用到文档中时，会扫描所有的URL链接，并提供警告或错误信息，根据开发者的设置决定是否允许存在字面URL链接。
安装
在使用该工具之前，您需要先安装 Node.js 和 npm。安装完成后，使用以下命令安装 remark-lint-no-literal-urls ：
npm install remark-lint-no-literal-urls
使用
在 CLI 中使用
在命令行界面 (CLI) 中使用该插件的方法如下：
remark -u remark-lint -u remark-lint-no-literal-urls your-document.md
这里的 remark-lint 是 remark 的一个内置插件，通过 -u 参数来加载。
在代码中使用
如果您希望在编写代码时使用该插件，则需要进行以下设置：
-- -------------------- ---- -------
----- ------- - ------------------
----- -------- - -----------------------
----- ---- - ----------------------
----- ------------- - --------------------------------------
---------
--------------
----------
-------------------
---------------------- -------- ----- ----- -
------------------------ -- ------
--这里我们使用 unified 和 remark-parse 解析 Markdown 文档，然后使用 remark-lint 检查文档中的问题，并最终使用 remark-lint-no-literal-urls 来避免字面URL链接的出现。
配置项
该插件提供了一些配置项，可以根据自己的需求进行设置。具体地说，您可以使用以下选项：
allowInParens：布尔类型，默认为false，表示是否允许在圆括号中包含字面URL链接。allowProtocolRelative：布尔类型，默认为false，表示是否允许使用协议相对URL链接。repositoryURLs：字符串数组，默认为空数组，表示一组URL地址，如果URL与之匹配，则被视为“仓库URL”，允许出现字面URL链接。
这里是一个示例配置：
-- -------------------- ---- -------
----- ------------- - --------------------------------------
---------
--------------
----------
------------------- -
-------------- -----
---------------------- -----
--------------- -
-------------
------------
-
--总结
remark-lint-no-literal-urls 是一款非常有用的插件，它可以帮助前端开发者在编写文档时快速地发现并修复字面URL链接问题。无论是在命令行界面还是代码中使用，都非常简单方便。通过合适的配置，我们可以轻松地满足自己的需求。如果您想要进一步提高文档的质量和可读
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/43007