How to disable default (tap) reporter?

[jakerella]

Hello! I would like to implement my own reporter for a project. This would not be an npm package, just a local script. The --reporter documentation suggest this is possible: "To load a reporter from a local Node.js script, use --require instead." Yet I can't figure out how to do that. I can require a local script just fine. I can change various QUnit.config options or add hooks with QUnit.done() and such, but how do I add the local reporter?

I've tried adding my script (per the Reporter API) to QUnit.config.reporters, and just writing a function directly into the reporters object, but that didn't work (and seemed wrong anyway).

As a side note, I see no way to disable all reporting (for example, doing something like QUnit.config.reporters.tap = false. When I do this, results are still displayed in the terminal (I'm running this in Node.js).

[Krinkle]

@jakerella Which version are you using? Can you confirm this is using the built-in QUnit CLI from the "qunit" npm package?

[jakerella]

Sure, it's 2.25.0 in node_modules/qunit/package.json. I can enable and disable the "console" reporter using the boolean syntax, but not the "tap" reporter. I looked through the code that sets the reporter for the current CLI run (src/cli/find-reporter) and it looks like the CLI won't run if I disable ALL reporters, it will default to "tap".

Here's a minimal CLI example:

const QUnit = require('qunit')

// QUnit.config.reporters.tap = true    // this produces duplicate output
// QUnit.config.reporters.tap = false   // this does nothing
// QUnit.config.reporters.console = true   // works as expected

QUnit.test('example', (assert) => {
    assert.equal(1, 1, 'one is one')
})

And the output:

$ npx qunit test/unit/test-matching.cjs
TAP version 13
ok 1 example
1..1
# pass 1
# skip 0
# todo 0
# fail 0

[jakerella]

Okay, so... I have this working, but to require my own reporter via function (not as an npm package), I have to specify the full path name on the command line:

qunit --reporter /home/jakerella/my-project/test/reporter.cjs test/my-tests.cjs

Or I can navigate out of the qunit directory structure inside node_modules: ../../../../test/reporter.cjs

This is because the require in find-reporter doesn't take into account the current working directory of the run. This is sort of okay, except that I want other people to be able to run the tests, so I'd have to document how to do this really well. I don't see a great way around this right now because I can't specify the "reporter" using QUnit.config or add my own reporter to the "reporters" builtin object.

I think there are a couple possibilities here:

1. Add a "reporter" option to QUnit.config for specifying a custom (local) reporter
2. Detecting a custom reporter via a path prefix like ./ or ../ and then using path.resolve() inside find-reporter so that the file can be required using a relative path on the command line.
3. Allowing the developer to add a reporter to the reporters object and maybe using the filename as the key?

Let me know if any of these is of interest and I can probably submit a PR for it.