在前端开发中，代码质量是一个非常重要的问题。为了避免出现错漏，我们通常会使用一些代码检查工具来规范化代码风格和语法。其中，eslint 是目前比较流行的代码检查工具之一。而 eslint-markdown-test 是一个可以在 markdown 文件中执行 eslint 检查的 npm 包。
什么是 eslint-markdown-test？
eslint-markdown-test 是一个基于 eslint 的插件，可以在 markdown 文件中执行 eslint 检查，并在文档中展示检查结果。它可以帮助我们将代码规范和文档编写结合起来，提高代码的可读性和易维护性。
安装与使用
安装 eslint-markdown-test 可以使用 npm 命令：
--- ------- -- --------------------
接着，在你的项目根目录下创建一个 .eslintrc.json 配置文件，并添加一些规则：
-
------ -
---------- -----
--------- ----
--
---------- ---------------------
---------------- -
-------------- ---
------------- --------
--
-------- -
------------- -------
--------- -
--------
-
--
--------- -
--------
--------
--
------- -
--------
--------
-
-
-然后，在你的 markdown 文件中添加以下代码块：
----- ------ ------------------- ---------
----------- ----- -------- ---------- ----------- ----------------------------- -------------- ------- --- -------------------- ----------------
其中，your-document.md 是你要检查的 markdown 文件名。
如果你的 markdown 文件中包含多个代码块，它们都会被依次检查，并在文档中显示检查结果。
示例代码
以下是一个示例 markdown 文件，它包含了两个 JavaScript 代码块：
- -- -------- ------- -- ---- ----- ------ -------- ------ -- - ------ - - -- - ----- ------ - ------ --- --------------------
------------------- ---------
第一个代码块中定义了一个加法函数，并计算了 1 和 2 的和。第二个代码块中输出了一条字符串。
运行 npx eslint-markdown-test your-document.md 命令后，将会得到以下输出：
- -- -------- ------- -- ---- ----- ------ -------- ------ -- - ------ - - -- - ----- ------ - ------ --- --------------------
- Line 4: Missing semicolon. (semi)
------------------- ---------
- Line 1: Unexpected console statement. (no-console)
--------------------------- -------- -- ------ ------------- --------- ------ -------- -- ------------- -- -- ---------------------- --- -------- ----- -------- --------------------------------------------------------------------- ----------------------------------------------------------- ---------- ---------------------------------------------------------------------------------------