API for registering custom reporters

[tymfear]

@novemberborn , what do you think about creating an API for custom reporters (not only reporters, probably)?
Something like an array of objects in settings, each object implements some set of functions called for each hook.

Like

class Reporter {
  onBeforeStart(t: Context);
  onBeforeEnd(t: Context);

  onBeforeEachStart(t: Context);
  onBeforeEachEnd(t: Context);

  onAssertionFailure(t: Context);
  
  onTestStart(t: Context);
  onTestEnd(t: Context);

  onAfterEachStart(t: Context);
  onAfterEachEnd(t: Context);

  onAfterStart(t: Context);
  onAfterEnd(t: Context);
}

ANd then in config file something like

const customReporter = new Reporter();

export default {
  plugins: [customReporter]
}

That would allow creating different plugins/reporters easily.

[novemberborn]

When it comes to reporters I think the right approach is to output high-fidelity structured data, which can be piped to another process.

More concretely:

• AVA would have one, awesome reporter
• AVA emits some JSON format that captures all the detail it has available internally
• Other CLI tools exist which can process that JSON

This is still a ways off I think.

What do you think?

(I'm closing this issue for housekeeping purposes, but let's keep the conversation going.)

[tymfear]

@novemberborn So I would like to have a hook for failed assertion to be able to take screenshots when I use browser tests. Otherwise I have to check every result before/after to have precise screenshots.

Anyway, is there an issue for that JSON report?

[novemberborn]

I would like to have a hook for failed assertion to be able to take screenshots when I use browser tests. Otherwise I have to check every result before/after to have precise screenshots.

You should be able to do that with t.try() or afterEach checking for t.passed.

Anyway, is there an issue for that JSON report?

No it's just in my head I think.