avajs/ava

Improved reporter experience

Open

#2500 opened on May 25, 2020

View on GitHub
 (6 comments) (2 reactions) (0 assignees)JavaScript (20,600 stars) (1,408 forks)batch import
help wantedscope:reporters

Description

By default it provides minimal output. We show a spinner and the status of the last test, so you get a sense of activity, and once an entire test file completes do we print failures. In verbose mode, we'd print the results of all tests & hooks, including logs. Various counts for passing and failing tests are always shown at the end of the output.

If a TTY is not available, we wouldn't print a spinner and only write the appropriate output for a test file once it completes.

We'd use ink to construct the output.

Contributor guide

Tech stack
javascriptnodejsreact
Domain
testingcli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Node.jsReact knowledge for inkAVA testing framework
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Implement a new reporter using ink (https://www.npmjs.com/package/ink) to provide improved output during test runs. The reporter should show a spinner and status of last test, and in verbose mode print all results including logs. Ensure fallback for non TTY environments. Look at existing reporter implementations in AVA's source code, specifically the 'lib/reporters' directory.