简介
remark-lint-list-item-bullet-indent 是一个npm包，可以用于在markdown文档中检查列表项符号的缩进是否正确。它是 remark 的一个插件，可以帮助开发者在实际工作中更好地规范自己的文档。
安装
在项目根目录下执行以下命令进行安装：
npm install remark-cli remark-lint remark-lint-list-item-bullet-indent
使用
在项目中运行以下命令：
remark -u lint -u lint-list-item-bullet-indent README.md
这个命令将使用 remark-lint 和 remark-lint-list-item-bullet-indent 来检查 README.md 文件中的列表项缩进是否正确。
如果缩进不正确，remark-lint-list-item-bullet-indent 将会输出一条类似于 List item should be indented with 2 spaces 的错误信息。
示例
假设我们有一个 markdown 文档，文件名为 example.md，内容如下：
-- -------------------- ---- -------
- -------
---- -- -- ------- -----
- ---- -
- ------- -
- ---------- -
- ------- -
- ---- -该文档中有一个嵌套的列表，其中每个列表项都应该缩进两个空格。但是，如果我们将子项缩进了四个空格，就会触发错误。
在终端中运行以下命令：
remark -u lint -u lint-list-item-bullet-indent example.md
将会输出以下信息：
example.md 4:3-4:10 warning List item should be indented with 2 spaces list-item-bullet-indent ⚠ 1 warning
这表明在第四行缩进了四个空格，导致了一个警告。我们可以修改该文件以解决这个问题：
-- -------------------- ---- -------
- -------
---- -- -- ------- -----
- ---- -
- ------- -
- ---------- -
- ------- -
- ---- -现在重新运行以上命令，将不再显示警告。
结论
使用 npm 包 remark-lint-list-item-bullet-indent 能够帮助我们检查 markdown 文档中的列表项缩进是否正确，从而更好地规范文档格式，提高开发效率。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/43027