npm 包 mocha-docdash 使用教程

阅读时长 3 分钟读完

简介

在 JavaScript 开发中,使用单元测试可以有效保证代码质量,而 Mocha 是一个流行的 JavaScript 单元测试框架。Mocha 在测试的同时也能够生成测试报告,但默认的 Mocha 报告的可读性比较差,因此我们可以使用一个 npm 包 mocha-docdash 来生成更美观、易读的测试报告。

安装

使用 npm 命令安装 mocha-docdash

使用

在项目的根目录下创建一个 test 目录,并在 test 目录中创建一个名为 test.js 的文件,并添加如下代码:

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

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

然后在命令行工具中执行以下命令:

打开浏览器访问 ./test-report/mocha.html,即可查看美观、易读的测试报告。

Mocha Docdash 还提供了一些配置项,可以根据需要进行配置。在 package.json 中添加 mochaDocdashConfig 属性,会覆盖默认的配置。例如:

目前 Mocha Docdash 总共支持以下属性:

  1. layout:布局方式,有 "linear" 和 "nested" 两种。
  2. output: 生成的路径,默认为 ./test-report/。
  3. sidebar: 是否显示侧边栏,true 或 false。
  4. docdash: 是直接使用 Docdash 模板,还是 Mocha 自定义模板。Option 是 boolean 类型,默认值是 true。
  5. parser: 选择你想要使用的测试输出解析器,可以从 ["spec", "dot", "tap", "landing", "nyan", "progress", "json", "json-stream"] 选择。

如上配置项就是设置布局为 "linear",同时显示侧边栏。

示例代码

以下代码演示了如何使用 Mocha Docdash 进行单元测试,并生成测试报告:

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

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

执行命令:

就可以在浏览器中查看测试报告。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60065b40c6eb7e50355dbc7d

纠错
反馈