feat(reporter): implement Jest reporter

[lkipke]

Summary

This leverages the jest packages and tap-parser to create a Jest-style reporter.

Screenshots

Default reporter

Verbose reporter

Failing due to assert

Failing due to runtime exception

In test case

In source code

Print statements

Code:

m.it("passing test case", sub()
    print "here's a print statement with an object: " { some: "field" }
    m.assert.equal("abcd", "abcd", "they are equal")
end sub)

m.it("passing test case", sub()
    print "hello, i am but a humble print statement"
    m.assert.deepEquals({ foo: "abcd" }, { foo: "abcd" }, "they are equal")
end sub)

[lkipke]

This was the best solution I could think of. It's a little wonky, but it's not too far off from how Jest prints console.log statements in JS tests. The main problem is we don't have any stack trace for the logs.

Jest reporter for roca (what this PR implements):

Actual jest reporter for JS (I put some console.logs in the roca project's JS test suite):

[alimnios72]

I think this is fine as long as we get stack traces for errors which seems like we do already 😄

[sjbarag]

Agreed! Since we treat brs (specifically its print statements) as an opaque box from the roca perspective, I'm fine with losing that for now. It might be possible to add an eventEmitter that handles writes to stdout instead of calling interpreter.stdout.write() directly from within brs's implementation of print, but that's not necessary here at all. It'd be neat to consider for the future though — especially in combination with a --quiet in brs to suppress writes to stdout?

[lkipke]

It'd be neat to consider for the future though — especially in combination with a --quiet in brs to suppress writes to stdout?

I agree, that'd be great!

[alimnios72]

I think this is fine as long as we get stack traces for errors which seems like we do already 😄

[alimnios72]

Thanks for the changes

[sjbarag]

For safety's sake it might be worth keeping --reporter spec as the default for a release or two while we opt-into --reporter jest to shake out any hidden bugs, but if you're comfortable with it I'm down to give this a try!

Excellent work @lkipke — I'm excited to get this out to the world!

[sjbarag]

Aw bummer it reports as console.print instead of just print? So close!

[lkipke]

I know, so close 😢 And we have no control over the outputted string here, either, so we can't use replace or anything, sadly.