doc: add new reporter events to custom reporter examples · nodejs/node@5173c55 · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 636
• Pull requests 761
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 5173c55

Browse filesBrowse the repository at this point in the historyBrowse files

atlowChemi

authored and

RafaelGSS

committed

doc: add new reporter events to custom reporter examples

Fixes: #48894 PR-URL: #48903 Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

1 parent c14ff69 commit 5173c55
Copy full SHA for 5173c55

1 file changed

+44Lines changed: 44 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/api
  • test.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/api/test.md‎

Copy file name to clipboardExpand all lines: doc/api/test.md

+44Lines changed: 44 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -687,6 +687,15 @@ const customReporter = new Transform({
687	687	writableObjectMode: true,
688	688	transform(event, encoding, callback) {
689	689	switch (event.type) {
	690	+ case 'test:dequeue':
	691	+ callback(null, `test ${event.data.name} dequeued`);
	692	+ break;
	693	+ case 'test:enqueue':
	694	+ callback(null, `test ${event.data.name} enqueued`);
	695	+ break;
	696	+ case 'test:watch:drained':
	697	+ callback(null, 'test watch queue drained');
	698	+ break;
690	699	case 'test:start':
691	700	callback(null, `test ${event.data.name} started`);
692	701	break;
@@ -700,6 +709,8 @@ const customReporter = new Transform({
700	709	callback(null, 'test plan');
701	710	break;
702	711	case 'test:diagnostic':
	712	+ case 'test:stderr':
	713	+ case 'test:stdout':
703	714	callback(null, event.data.message);
704	715	break;
705	716	case 'test:coverage': {
@@ -721,6 +732,15 @@ const customReporter = new Transform({
721	732	writableObjectMode: true,
722	733	transform(event, encoding, callback) {
723	734	switch (event.type) {
	735	+ case 'test:dequeue':
	736	+ callback(null, `test ${event.data.name} dequeued`);
	737	+ break;
	738	+ case 'test:enqueue':
	739	+ callback(null, `test ${event.data.name} enqueued`);
	740	+ break;
	741	+ case 'test:watch:drained':
	742	+ callback(null, 'test watch queue drained');
	743	+ break;
724	744	case 'test:start':
725	745	callback(null, `test ${event.data.name} started`);
726	746	break;
@@ -734,6 +754,8 @@ const customReporter = new Transform({
734	754	callback(null, 'test plan');
735	755	break;
736	756	case 'test:diagnostic':
	757	+ case 'test:stderr':
	758	+ case 'test:stdout':
737	759	callback(null, event.data.message);
738	760	break;
739	761	case 'test:coverage': {
@@ -754,6 +776,15 @@ Example of a custom reporter using a generator function:
754	776	export default async function * customReporter(source) {
755	777	for await (const event of source) {
756	778	switch (event.type) {
	779	+ case 'test:dequeue':
	780	+ yield `test ${event.data.name} dequeued`;
	781	+ break;
	782	+ case 'test:enqueue':
	783	+ yield `test ${event.data.name} enqueued`;
	784	+ break;
	785	+ case 'test:watch:drained':
	786	+ yield 'test watch queue drained';
	787	+ break;
757	788	case 'test:start':
758	789	yield `test ${event.data.name} started\n`;
759	790	break;
@@ -767,6 +798,8 @@ export default async function * customReporter(source) {
767	798	yield 'test plan';
768	799	break;
769	800	case 'test:diagnostic':
	801	+ case 'test:stderr':
	802	+ case 'test:stdout':
770	803	yield `${event.data.message}\n`;
771	804	break;
772	805	case 'test:coverage': {
@@ -783,6 +816,15 @@ export default async function * customReporter(source) {
783	816	module.exports = async function * customReporter(source) {
784	817	for await (const event of source) {
785	818	switch (event.type) {
	819	+ case 'test:dequeue':
	820	+ yield `test ${event.data.name} dequeued`;
	821	+ break;
	822	+ case 'test:enqueue':
	823	+ yield `test ${event.data.name} enqueued`;
	824	+ break;
	825	+ case 'test:watch:drained':
	826	+ yield 'test watch queue drained';
	827	+ break;
786	828	case 'test:start':
787	829	yield `test ${event.data.name} started\n`;
788	830	break;
@@ -796,6 +838,8 @@ module.exports = async function * customReporter(source) {
796	838	yield 'test plan\n';
797	839	break;
798	840	case 'test:diagnostic':
	841	+ case 'test:stderr':
	842	+ case 'test:stdout':
799	843	yield `${event.data.message}\n`;
800	844	break;
801	845	case 'test:coverage': {

0 commit comments

Comments

0 (0)