vitest icon indicating copy to clipboard operation
vitest copied to clipboard

Docs: Reporter Guide

Open patak-dev opened this issue 4 years ago • 5 comments

Clear and concise description of the problem

See https://github.com/vitest-dev/vitest/blob/main/packages/vitest/src/types/reporter.ts

Suggested solution

A new guide

Alternative

No response

Additional context

No response

Validations

patak-dev avatar Dec 24 '21 09:12 patak-dev

Will take a look 👍

mitchelvanbever avatar Jan 04 '22 07:01 mitchelvanbever

Got sidetracked (with #429), so free to be picked up as we've now got the tap reporter as well 🚀

mitchelvanbever avatar Jan 05 '22 11:01 mitchelvanbever

https://github.com/tapjs/tap-mocha-reporter - Formats a TAP stream using Mocha's set of reporters

Demivan avatar Jan 05 '22 16:01 Demivan

I am not so sure we should document the reporter API, as average users won't touch that. I would think a Reporters Guide is more useful than the API docs (as TS already served as a good docs for developers)

antfu avatar Jan 05 '22 16:01 antfu

I am not so sure we should document the reporter API, as average users won't touch that. I would think a Reporters Guide is more useful than the API docs (as TS already served as a good docs for developers)

Yeah I agree, I believe the issue is about making a "guide" covering basic usage (like we have for mocking).

If we were to add additional information describing the API we would add to the current section in "config" I would assume.

mitchelvanbever avatar Jan 05 '22 16:01 mitchelvanbever