介绍
在前端开发中,经常需要用到 markdown 格式的文档。而 markdown-it 是一个流行的解析 markdown 的工具,提供了丰富的插件和配置。但是,我们如何测试这些插件是否正常工作呢?
这时,就需要用到 @gerhobbelt/markdown-it-testgen 这个 npm 包了。它能够自动生成测试用例,并验证解析器是否按照预期工作。本文将为大家介绍如何使用它。
安装
npm install -D @gerhobbelt/markdown-it-testgen
使用
生成测试用例
首先,我们需要创建一个 testgen.js
的文件来生成测试用例。以 markdown-it-emoji
这个插件为例:
-- -------------------- ---- ------- ----- ------- - ------------------------------------------- ----- ---------- - ----------------------- ----- ----- - ----------------------------- ----- -- - --- ------------------------ ----- ----- - --- ---------- ---------------------------------------- ----
上面的代码用 Testgen
类创建了一个测试套件 suite
,并调用了 generate
方法来生成测试用例。'../test/fixtures/emoji'
是测试用例的输出路径,md
是 markdown-it 的实例,包含 emoji
插件。
执行下面的命令生成测试用例:
node testgen.js
验证解析器
接下来,我们需要用测试用例来验证解析器。以 ava
为例:
-- -------------------- ---- ------- ----- ---- - ---------------- ----- ---- - --------------- ----- ---------- - ----------------------- ----- ----- - ----------------------------- ----- - -------- - - ------------------------------- ----- -- - --- ------------------------ -------------- -- - ----- ------- - -------------------- -------------------------- ----------------- ---- ---
上面的代码用 runTests
函数来执行测试用例,包含了 emoji
插件。执行下面的命令运行测试:
npm test
示例代码
下面是完整的示例代码,供大家参考:
-- -------------------- ---- ------- -- ---------- ----- ------- - ------------------------------------------- ----- ---------- - ----------------------- ----- ----- - ----------------------------- ----- -- - --- ------------------------ ----- ----- - --- ---------- ---------------------------------------- ---- -- ------- ----- ---- - ---------------- ----- ---- - --------------- ----- ---------- - ----------------------- ----- ----- - ----------------------------- ----- - -------- - - ------------------------------- ----- -- - --- ------------------------ -------------- -- - ----- ------- - -------------------- -------------------------- ----------------- ---- ---
结论
使用 @gerhobbelt/markdown-it-testgen 可以方便地生成测试用例,并验证解析器是否按照预期工作。同时,本文也希望能够帮助大家更深入地理解 markdown-it 的使用,提升开发效率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/5f02c870403f2923b035bd93