🚀 Feature: Overloading consoleLog in reporters.Base for custom reporter

[chengB12]

When creating custom reporter, and to utilize reporters.Base functions, it is best to extends reporter.Base function.

However, mocha doesn't provide type-safe (for typescript) way to overload consoleLog function, since many of reporter.Base functions are directly call Base.consoleLog function. it would be better to overload it if we don't want it print them to console

I found I can force overload it through

(Mocha.reporters.Base as any).consoleLog = (...data: any[]) => {
    // do my own logging
}

However, I feel this is undocumented and unexposed to @types/mocha, so it is subjected to change and breaks code above

can we have declared way to overload that method, ideally like

class MyReporter extends Mocha.reporters.base {
    override consoleLog(... data) {
        // my own logging
    }
}

[github-actions]

This issue hasn't had any recent activity, and I'm labeling it stale. Remove the label or comment or this issue will be closed in 14 days. Thanks for contributing to Mocha!

[JoshuaKGoldberg]

Good idea! I like it, and it seems reasonable given the API docs suggest Base as a good starter.

Right now, Base.consoleLog is the equivalent of a static property on the Base class:

mocha/lib/reporters/base.js

Line 548 in 11c4560

Base.consoleLog = consoleLog;

...which is referenced as Base.consoleLog elsewhere:

mocha/lib/reporters/base.js

Line 235 in 11c4560

Base.consoleLog();

That's going to be more difficult to refactor until Base gets refactored to a real class per #5025. Marking as blocked on that issue.

Once #5025 is done, we can re-evaluate to see if this would be feasible without major changes in the new class structure.