在前端开发中，我们通常使用 Markdown 编写文档。但是，如果没有合适的规范和工具，Markdown 的内容可能会出现格式和结构上的问题。remark-lint-file-extension 是一个用于检查 Markdown 文件扩展名的 npm 包，它可以帮助我们自动检测文件扩展名是否符合规范。
安装
通过 npm 进行安装：
npm install remark-lint-file-extension --save-dev
配置
在项目根目录创建一个名为 .remarkrc.js 的配置文件，并添加以下内容：
-- -------------------- ---- ------- -------------- - - -------- - - ------- - ----------------- ---- -- -- -------- ----- - - - -展开代码
使用
运行以下命令来检查 Markdown 文件是否符合规范：
npx remark --rc .remarkrc.js .
其中，. 表示当前目录。你也可以指定其他目录或文件。
示例
下面是一个样例 Markdown 文件 example.md：
# 标题 这是一段正文。
假设我们将其保存在项目根目录下，并且在命令行中运行 npx remark --rc .remarkrc.js .，则会输出以下信息：
example.md 1:1 warning Missing file extension 'md' file-extension remark-lint
由此可见，该 Markdown 文件扩展名缺失，需要添加 .md 扩展名。
结论
remark-lint-file-extension 是一个非常实用的 npm 包，可以帮助我们规范 Markdown 文件的文件扩展名。通过本文的介绍，你已经学会了如何使用它，并可以在自己的项目中应用。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/43175
