@danmasta/mocha-sonar

中文文档
1.1.0发布于 2024/01/12MITCommonJS近 30 天下载 2999

索纳克贝的莫查记者

中文使用文档
文档目录5 节
  1. 关于
  2. 使用量
  3. 选项
  4. 实例
  5. 联系人

莫查声纳记者

Mocha 的 SonarQube XML 记者

特征 :

  • 生成兼容的 xml 报表 声纳Qube
  • 同时写入 stdout 的能力
  • 为 stdout 定义自定义记者的能力
  • 禁用输出的静态模式
  • 自定义输出文件路径和/或名称

关于

我们需要能够生成xml报告供单位测试,然后导入到 声纳Qube。有几个图书馆试图帮助它,但是它们要么已经过时,生成了不相容的xml,要么只登录了xml来进行tdout。 此库将允许您以兼容的格式生成单位测试执行报告 普通测试格式 把它们写成文件 也可以向二级记者输送输出,用于人类可读视图.

使用量

添加摩卡- sonar 作为您的应用程序的依赖, 通过 npm 安装

npm install @danmasta/mocha-sonar --save-dev

使用记者进行测试

mocha -R @danmasta/mocha-sonar tests

选项

选项可用 reporterOptions 字段,或 --reporter-options 字段通过命令行

名称说明
cwd用于生成用于测试的相对文件路径的位置 。 默认是 process.cwd()
output您想要保存声纳 xml 报告的文件路径 。 默认是 ./coverage/sonar.xml
delimiter用于合并名字用于巢穴测试的限定器 。 默认是 ' '
reporter您想要用于控制台输出的记者姓名 。 默认是 list
silent若为 true 禁用二次报告输出。 默认是 false
spaces格式化 xml 输出时要使用的空格数 。 默认是 4

实例

从命令行使用摩卡- 声纳

mocha -R @danmasta/mocha-sonar ./tests/unit/**/*.js

传递选项到 npm 测试命令

npm run test -- --reporter=@danmasta/mocha-sonar --reporter-options --reporter=nyan,delimeter=::

覆盖面报告 无

nyc --reporter=lcov mocha -R @danmasta/mocha-sonar ./tests/unit/**/*.js

使用摩卡和/或尼克作为 ulp 任务

const spawn = require('child_process').spawn;
const gulp = require('gulp');

gulp.task('test', () => {
    return spawn('mocha -R @danmasta/mocha-sonar ./tests/unit/**/*.js', {
        shell: true,
        stdio: ['inherit', 'inherit', 'inherit']
    });
});

gulp.task('coverage', () => {
    return spawn('nyc --reporter=lcov mocha -R @danmasta/mocha-sonar ./tests/unit/**/*.js', {
        shell: true,
        stdio: ['inherit', 'inherit', 'inherit']
    });
});

gulp.task('default', gulp.series('test', 'build'));
gulp.task('publish', gulp.series('coverage', 'build', 'deploy'));

联系人

有问题可以联系

版本与发布记录

@danmasta/mocha-sonar 共发布 9 个版本,首次发布于 2019/03/07;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.1.0latest2024/01/122 年前
1.0.12021/03/185 年前
1.0.02020/08/026 年前
0.0.62019/05/227 年前
0.0.52019/04/237 年前
0.0.42019/03/167 年前

关于 @danmasta/mocha-sonar 的常见问题

@danmasta/mocha-sonar 是什么?

索纳克贝的莫查记者

如何安装 @danmasta/mocha-sonar?

在项目目录运行 npm install @danmasta/mocha-sonar,或使用 pnpm add / yarn add / bun add。

@danmasta/mocha-sonar 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/danmasta__mocha-sonar 是否存在。

@danmasta/mocha-sonar 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@danmasta/mocha-sonar 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=6。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@danmasta/mocha-sonar 可以商用吗?

@danmasta/mocha-sonar 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@danmasta/mocha-sonar 的下载量有多少?

根据 npm 官方下载统计,@danmasta/mocha-sonar 在 2026/10/12 – 2026/11/10 这 30 天内被下载 2,999 次,日均约 100 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@danmasta/mocha-sonar 还在维护吗?

最新版本 1.1.0 发布于 2024/01/12(2 年前);至今共发布 9 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/03/07。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。