qunitjs / qunitjs/qunit

Support multiple `--reporter` options on the CLI

Open
#1,784 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component: CLI Type: Enhancement
Dominant language
JavaScript
Stars
4k
Forks
773
PR merge metrics
No merged PRs in 30d

Description

What are you trying to do?

Enable the perf reporter, in combination with Node.js inspector hooked up to Chrome devtools, but still have the tap reporter enabled as well to increase confidence and improve visibility into what's happened upto a breakpoint.

What actually happened?

The option currently allows only one value, so if you do try to do this today, the last one will win

$ qunit --reporter tap --reporter perf

Other information

On the web we've always allowed multiple reporters. The new QUnit.config.reporters option is also naturally not limited. And on the web we actually enable two reporters by default (perf and html).

Note that you can work around this today by calling the reporter directly from a setup using the --require CLI option

qunit --require ./test/setup.js
// test/setup.js
QUnit.reporters.perf.init(QUnit);

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the CLI's --reporter option and compare its behavior with QUnit.config.reporters and the existing --require workaround described in the issue. Check how the tap and perf reporters are initialized together, then verify that repeating --reporter enables both reporters without the later option replacing the earlier one.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.