feat: new configuration to skip report on watch mode

README.md

@@ -19,7 +19,8 @@
           {
             channels: [], // an array with the twitch channels names the report is going to send messages
             username: '', // an string with the username for the twitch chat
-            password: '' // an string with the oauth2 token for the twitch chat
+            password: '', // an string with the oauth2 token for the twitch chat
+            messagesOnWatchMode: false // report or not test results to twitch in watch mode (default false)
           },
         ],
       ],

jest.config.js

@@ -109,6 +109,7 @@ module.exports = {
 		// 		channels: ['SantiMA10'],
 		// 		username: process.env.TWITCH_USERNAME,
 		// 		password: process.env.TWITCH_PASSWORD,
+		// 		messagesOnWatchMode: false,
 		// 	},
 		// ],
 	],

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@santima10/jest-chat-reporter",
-	"version": "0.1.1",
+	"version": "0.2.0",
 	"publishConfig": {
 		"access": "public"
 	},

src/index.ts

@@ -1,4 +1,4 @@
-import { AggregatedResult, Context, Reporter } from '@jest/reporters';
+import { AggregatedResult, Config, Context, Reporter } from '@jest/reporters';
 import tmi from 'tmi.js';
 
 import { TwitchChatService } from './services/chat/TwitchChatService';
@@ -8,8 +8,13 @@ export default class TwitchJestReporter implements Pick<Reporter, 'onRunComplete
 	private tmiClient: tmi.Client;
 
 	public constructor(
-		_: Record<string, unknown>,
-		reporterConfig: { channels: string[]; username: string; password: string },
+		private globalConfig: Config.GlobalConfig,
+		private reporterConfig: {
+			channels: string[];
+			username: string;
+			password: string;
+			messagesOnWatchMode?: boolean;
+		},
 	) {
 		this.tmiClient = new tmi.Client({
 			identity: {
@@ -21,6 +26,11 @@ export default class TwitchJestReporter implements Pick<Reporter, 'onRunComplete
 	}
 
 	public onRunComplete = async (_: Set<Context>, results: AggregatedResult): Promise<void> => {
-		await new ReportTestResults(new TwitchChatService(this.tmiClient)).run(results);
+		await new ReportTestResults(new TwitchChatService(this.tmiClient), {
+			messagesOnWatchMode: !!this.reporterConfig.messagesOnWatchMode,
+		}).run({
+			...results,
+			runningOnWatchMode: this.globalConfig.watch || this.globalConfig.watchAll,
+		});
 	};
 }

src/useCases/ReportTestResults.ts

@@ -1,13 +1,21 @@
 import { ChatService } from '../services/chat/ChatService';
 
 export class ReportTestResults {
-	public constructor(private chatService: ChatService) {}
+	public constructor(
+		private chatService: ChatService,
+		private config: { messagesOnWatchMode: boolean } = { messagesOnWatchMode: false },
+	) {}
 
 	public async run(results: {
 		numFailedTests: number;
 		numPassedTests: number;
 		numTotalTests: number;
+		runningOnWatchMode?: boolean;
 	}): Promise<void> {
+		if (!this.config.messagesOnWatchMode && results.runningOnWatchMode) {
+			return;
+		}
+
 		if (results.numPassedTests > 0) {
 			await this.chatService.say(
 				`✅ ${results.numPassedTests}/${results.numTotalTests} tests passed`,

tests/useCases/ReportTestResults.spec.ts

@@ -32,5 +32,33 @@ describe('ReportTestResults', () => {
 			expect(chatService.say).toHaveBeenNthCalledWith(1, '❌ 1/1 tests failed');
 			expect(chatService.say).not.toHaveBeenNthCalledWith(2, '✅ 0/1 tests passed');
 		});
+
+		it('sent messages if the tests are running in watch mode and the watch mode is enabled', async () => {
+			const chatService = new ChatServiceMock();
+			const subject = new ReportTestResults(chatService, { messagesOnWatchMode: true });
+
+			await subject.run({
+				numFailedTests: 1,
+				numPassedTests: 0,
+				numTotalTests: 1,
+				runningOnWatchMode: true,
+			});
+
+			expect(chatService.say).toHaveBeenCalled();
+		});
+
+		it('does not sent messages if the tests are running in watch mode and the watch mode is disabled', async () => {
+			const chatService = new ChatServiceMock();
+			const subject = new ReportTestResults(chatService);
+
+			await subject.run({
+				numFailedTests: 1,
+				numPassedTests: 0,
+				numTotalTests: 1,
+				runningOnWatchMode: true,
+			});
+
+			expect(chatService.say).not.toHaveBeenCalled();
+		});
 	});
 });