npm 包 chin-plugin-unified 使用教程

阅读时长 4 分钟读完

前言

随着互联网的发展,前端的重要性也越来越凸显。在前端的开发中,npm 包是不可或缺的一部分,它们可以帮助我们完成很多重复且复杂的工作。而 chin-plugin-unified 就是一款值得推荐的 npm 包,它可以帮助我们统一风格、格式化并检查代码。

chin-plugin-unified 是什么?

chin-plugin-unified 是一个基于 unified 的插件,可以对 Markdown 文件或者 HTML 文件进行一些格式化和检查。它包含以下功能:

  1. 格式化 Markdown 文件或 HTML 文件并输出。
  2. 校验 Markdown 文件或 HTML 文件的语法和格式。
  3. 统一 Markdown 文件或 HTML 文件内链接的格式。

使用 chin-plugin-unified 可以有效地规范文件格式,减少人工修整的时间,提高团队协作效率。

安装

chin-plugin-unified 可以通过 npm 安装:

使用

1. 格式化文件

在项目中的 .md 或者 .html 文件中,使用以下命令格式化文件:

其中,filename 指文件名(包含文件后缀),例如:

执行该命令后,会将 index.md 文件中的代码格式化,然后覆盖原文件。

2. 校验文件

使用以下命令检验 .md 或者 .html 文件:

其中,filename 指文件名(包含文件后缀),例如:

执行该命令后,会在控制台输出文件中的问题和错误信息。

3. 统一链接格式

统一链接格式可以帮助我们避免在长期协作过程中出现链接格式不一致的问题。使用以下命令可以实现无扰动的自动更新链接格式:

其中,filename 指文件名(包含文件后缀),例如:

执行该命令后,会自动将文件中的链接统一格式,并输出到控制台。

示例代码

为了更好地理解 chin-plugin-unified 的使用方法,我们来看一下示例代码。

下面是一个 index.md 文件的示例:

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

-------

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

-------

- --- -
- --- -

-------

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

这是一个图片:

npx chin-plugin-unified --format index.md

npx chin-plugin-unified --lint index.md

Error: Found the following duplicate heading levels: 1, 2, 3. Error: Expected 2 blank lines before a code block, but instead saw 1.

npx chin-plugin-unified --link index.md

纠错
反馈