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

nodejs / node Public

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

• Code
• Issues 633
• Pull requests 756
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit ec0a6c1

Browse filesBrowse the repository at this point in the historyBrowse files

atlowChemi

authored and

targos

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 e8a32fb commit ec0a6c1
Copy full SHA for ec0a6c1

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
@@ -672,6 +672,15 @@ const customReporter = new Transform({
672	672	writableObjectMode: true,
673	673	transform(event, encoding, callback) {
674	674	switch (event.type) {
	675	+ case 'test:dequeue':
	676	+ callback(null, `test ${event.data.name} dequeued`);
	677	+ break;
	678	+ case 'test:enqueue':
	679	+ callback(null, `test ${event.data.name} enqueued`);
	680	+ break;
	681	+ case 'test:watch:drained':
	682	+ callback(null, 'test watch queue drained');
	683	+ break;
675	684	case 'test:start':
676	685	callback(null, `test ${event.data.name} started`);
677	686	break;
@@ -685,6 +694,8 @@ const customReporter = new Transform({
685	694	callback(null, 'test plan');
686	695	break;
687	696	case 'test:diagnostic':
	697	+ case 'test:stderr':
	698	+ case 'test:stdout':
688	699	callback(null, event.data.message);
689	700	break;
690	701	case 'test:coverage': {
@@ -706,6 +717,15 @@ const customReporter = new Transform({
706	717	writableObjectMode: true,
707	718	transform(event, encoding, callback) {
708	719	switch (event.type) {
	720	+ case 'test:dequeue':
	721	+ callback(null, `test ${event.data.name} dequeued`);
	722	+ break;
	723	+ case 'test:enqueue':
	724	+ callback(null, `test ${event.data.name} enqueued`);
	725	+ break;
	726	+ case 'test:watch:drained':
	727	+ callback(null, 'test watch queue drained');
	728	+ break;
709	729	case 'test:start':
710	730	callback(null, `test ${event.data.name} started`);
711	731	break;
@@ -719,6 +739,8 @@ const customReporter = new Transform({
719	739	callback(null, 'test plan');
720	740	break;
721	741	case 'test:diagnostic':
	742	+ case 'test:stderr':
	743	+ case 'test:stdout':
722	744	callback(null, event.data.message);
723	745	break;
724	746	case 'test:coverage': {
@@ -739,6 +761,15 @@ Example of a custom reporter using a generator function:
739	761	export default async function * customReporter(source) {
740	762	for await (const event of source) {
741	763	switch (event.type) {
	764	+ case 'test:dequeue':
	765	+ yield `test ${event.data.name} dequeued`;
	766	+ break;
	767	+ case 'test:enqueue':
	768	+ yield `test ${event.data.name} enqueued`;
	769	+ break;
	770	+ case 'test:watch:drained':
	771	+ yield 'test watch queue drained';
	772	+ break;
742	773	case 'test:start':
743	774	yield `test ${event.data.name} started\n`;
744	775	break;
@@ -752,6 +783,8 @@ export default async function * customReporter(source) {
752	783	yield 'test plan';
753	784	break;
754	785	case 'test:diagnostic':
	786	+ case 'test:stderr':
	787	+ case 'test:stdout':
755	788	yield `${event.data.message}\n`;
756	789	break;
757	790	case 'test:coverage': {
@@ -768,6 +801,15 @@ export default async function * customReporter(source) {
768	801	module.exports = async function * customReporter(source) {
769	802	for await (const event of source) {
770	803	switch (event.type) {
	804	+ case 'test:dequeue':
	805	+ yield `test ${event.data.name} dequeued`;
	806	+ break;
	807	+ case 'test:enqueue':
	808	+ yield `test ${event.data.name} enqueued`;
	809	+ break;
	810	+ case 'test:watch:drained':
	811	+ yield 'test watch queue drained';
	812	+ break;
771	813	case 'test:start':
772	814	yield `test ${event.data.name} started\n`;
773	815	break;
@@ -781,6 +823,8 @@ module.exports = async function * customReporter(source) {
781	823	yield 'test plan\n';
782	824	break;
783	825	case 'test:diagnostic':
	826	+ case 'test:stderr':
	827	+ case 'test:stdout':
784	828	yield `${event.data.message}\n`;
785	829	break;
786	830	case 'test:coverage': {

0 commit comments

Comments

0 (0)