feat: add jest-watch package

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master
 
+### Features
+
+* `[jest-watch]` create new package `jest-watch` to ease custom watch plugin development ([#6318](https://github.com/facebook/jest/pull/6318))
+
 ### Fixes
 
 * `[expect]` toMatchObject throws TypeError when a source property is null ([#6313](https://github.com/facebook/jest/pull/6313))

packages/jest-cli/package.json

@@ -28,6 +28,7 @@
     "jest-snapshot": "^23.0.1",
     "jest-util": "^23.0.1",
     "jest-validate": "^23.0.1",
+    "jest-watch": "^23.0.1",
     "jest-worker": "^23.0.1",
     "micromatch": "^2.3.11",
     "node-notifier": "^5.2.1",

packages/jest-cli/src/__tests__/snapshot_interactive_mode.test.js

@@ -6,16 +6,9 @@
  */
 
 import chalk from 'chalk';
-import {KEYS} from '../constants';
+import {KEYS} from 'jest-watch';
 import SnapshotInteractiveMode from '../snapshot_interactive_mode';
 
-jest.mock('../lib/terminal_utils', () => ({
-  getTerminalWidth: () => 80,
-  rightPad: () => {
-    '';
-  },
-}));
-
 jest.mock('ansi-escapes', () => ({
   clearScreen: '[MOCK - eraseDown]',
   cursorRestorePosition: '[MOCK - cursorRestorePosition]',
@@ -86,7 +79,7 @@ describe('SnapshotInteractiveMode', () => {
 
   test('press Q or ESC triggers an abort', () => {
     instance.abort = jest.fn();
-    instance.put(KEYS.Q);
+    instance.put('q');
     instance.put(KEYS.ESCAPE);
     expect(instance.abort).toHaveBeenCalledTimes(2);
   });
@@ -107,12 +100,12 @@ describe('SnapshotInteractiveMode', () => {
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.S);
+    instance.put('s');
     expect(mockCallback).toHaveBeenCalledTimes(1);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.R);
+    instance.put('r');
     expect(instance.getSkippedNum()).toBe(0);
     expect(mockCallback).nthCalledWith(2, assertions[0], false);
     expect(mockCallback).toHaveBeenCalledTimes(2);
@@ -127,12 +120,12 @@ describe('SnapshotInteractiveMode', () => {
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.S);
+    instance.put('s');
     expect(mockCallback).toHaveBeenCalledTimes(1);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.Q);
+    instance.put('q');
     expect(instance.getSkippedNum()).toBe(0);
     expect(mockCallback).nthCalledWith(2, null, false);
     expect(mockCallback).toHaveBeenCalledTimes(2);
@@ -157,7 +150,7 @@ describe('SnapshotInteractiveMode', () => {
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.U);
+    instance.put('u');
     expect(mockCallback).nthCalledWith(2, assertions[0], true);
     expect(mockCallback).toHaveBeenCalledTimes(2);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
@@ -177,18 +170,18 @@ describe('SnapshotInteractiveMode', () => {
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.S);
+    instance.put('s');
     expect(mockCallback).nthCalledWith(2, assertions[1], false);
     expect(mockCallback).toHaveBeenCalledTimes(2);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.S);
+    instance.put('s');
     expect(mockCallback).toHaveBeenCalledTimes(2);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.R);
+    instance.put('r');
     expect(instance.getSkippedNum()).toBe(0);
     expect(mockCallback).nthCalledWith(3, assertions[0], false);
     expect(mockCallback).toHaveBeenCalledTimes(3);
@@ -224,14 +217,14 @@ describe('SnapshotInteractiveMode', () => {
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.U);
+    instance.put('u');
     expect(mockCallback).nthCalledWith(2, assertions[0], true);
     expect(mockCallback).nthCalledWith(3, assertions[1], false);
     expect(mockCallback).toHaveBeenCalledTimes(3);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.U);
+    instance.put('u');
     expect(mockCallback).nthCalledWith(4, assertions[1], true);
     expect(mockCallback).toHaveBeenCalledTimes(4);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
@@ -272,19 +265,19 @@ describe('SnapshotInteractiveMode', () => {
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.U);
+    instance.put('u');
     expect(mockCallback).nthCalledWith(2, assertions[0], true);
     expect(mockCallback).nthCalledWith(3, assertions[1], false);
     expect(mockCallback).toHaveBeenCalledTimes(3);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.S);
+    instance.put('s');
     expect(mockCallback).toHaveBeenCalledTimes(3);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.R);
+    instance.put('r');
     expect(instance.getSkippedNum()).toBe(0);
     expect(mockCallback).nthCalledWith(4, assertions[1], false);
     expect(mockCallback).toHaveBeenCalledTimes(4);
@@ -320,19 +313,19 @@ describe('SnapshotInteractiveMode', () => {
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.S);
+    instance.put('s');
     expect(mockCallback).nthCalledWith(2, assertions[1], false);
     expect(mockCallback).toHaveBeenCalledTimes(2);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.U);
+    instance.put('u');
     expect(mockCallback).nthCalledWith(3, assertions[1], true);
     expect(mockCallback).toHaveBeenCalledTimes(3);
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();
     pipe.write.mockClear();
 
-    instance.put(KEYS.R);
+    instance.put('r');
     expect(instance.getSkippedNum()).toBe(0);
     expect(mockCallback).nthCalledWith(4, assertions[0], false);
     expect(mockCallback).toHaveBeenCalledTimes(4);

packages/jest-cli/src/__tests__/watch.test.js

@@ -10,8 +10,7 @@
 
 import chalk from 'chalk';
 import TestWatcher from '../test_watcher';
-import JestHooks from '../jest_hooks';
-import {KEYS} from '../constants';
+import {JestHook, KEYS} from 'jest-watch';
 
 const runJestMock = jest.fn();
 const watchPluginPath = `${__dirname}/__fixtures__/watch_plugin`;
@@ -286,7 +285,7 @@ describe('Watch mode flows', () => {
     expect(pipeMockCalls.slice(determiningTestsToRun + 1)).toMatchSnapshot();
   });
 
-  it('allows WatchPlugins to hook into JestHooks', async () => {
+  it('allows WatchPlugins to hook into JestHook', async () => {
     const apply = jest.fn();
     const pluginPath = `${__dirname}/__fixtures__/plugin_path_register`;
     jest.doMock(
@@ -498,7 +497,7 @@ describe('Watch mode flows', () => {
     watch(globalConfig, contexts, pipe, hasteMapInstances, stdin);
     runJestMock.mockReset();
 
-    stdin.emit(KEYS.O);
+    stdin.emit('o');
 
     expect(runJestMock).toBeCalled();
     expect(runJestMock.mock.calls[0][0].globalConfig).toMatchObject({
@@ -512,7 +511,7 @@ describe('Watch mode flows', () => {
     watch(globalConfig, contexts, pipe, hasteMapInstances, stdin);
     runJestMock.mockReset();
 
-    stdin.emit(KEYS.A);
+    stdin.emit('a');
 
     expect(runJestMock).toBeCalled();
     expect(runJestMock.mock.calls[0][0].globalConfig).toMatchObject({
@@ -530,12 +529,12 @@ describe('Watch mode flows', () => {
   });
 
   it('Pressing "t" reruns the tests in "test name pattern" mode', async () => {
-    const hooks = new JestHooks();
+    const hooks = new JestHook();
 
     watch(globalConfig, contexts, pipe, hasteMapInstances, stdin, hooks);
     runJestMock.mockReset();
 
-    stdin.emit(KEYS.T);
+    stdin.emit('t');
     ['t', 'e', 's', 't'].forEach(key => stdin.emit(key));
     stdin.emit(KEYS.ENTER);
     await nextTick();
@@ -549,12 +548,12 @@ describe('Watch mode flows', () => {
   });
 
   it('Pressing "p" reruns the tests in "filename pattern" mode', async () => {
-    const hooks = new JestHooks();
+    const hooks = new JestHook();
 
     watch(globalConfig, contexts, pipe, hasteMapInstances, stdin, hooks);
     runJestMock.mockReset();
 
-    stdin.emit(KEYS.P);
+    stdin.emit('p');
     ['f', 'i', 'l', 'e'].forEach(key => stdin.emit(key));
     stdin.emit(KEYS.ENTER);
     await nextTick();
@@ -568,17 +567,17 @@ describe('Watch mode flows', () => {
   });
 
   it('Can combine "p" and "t" filters', async () => {
-    const hooks = new JestHooks();
+    const hooks = new JestHook();
 
     watch(globalConfig, contexts, pipe, hasteMapInstances, stdin, hooks);
     runJestMock.mockReset();
 
-    stdin.emit(KEYS.P);
+    stdin.emit('p');
     ['f', 'i', 'l', 'e'].forEach(key => stdin.emit(key));
     stdin.emit(KEYS.ENTER);
     await nextTick();
 
-    stdin.emit(KEYS.T);
+    stdin.emit('t');
     ['t', 'e', 's', 't'].forEach(key => stdin.emit(key));
     stdin.emit(KEYS.ENTER);
     await nextTick();
@@ -592,7 +591,7 @@ describe('Watch mode flows', () => {
   });
 
   it('Pressing "u" reruns the tests in "update snapshot" mode', async () => {
-    const hooks = new JestHooks();
+    const hooks = new JestHook();
 
     globalConfig.updateSnapshot = 'new';
 
@@ -601,7 +600,7 @@ describe('Watch mode flows', () => {
 
     hooks.getEmitter().onTestRunComplete({snapshot: {failure: true}});
 
-    stdin.emit(KEYS.U);
+    stdin.emit('u');
     await nextTick();
 
     expect(runJestMock.mock.calls[0][0].globalConfig).toMatchObject({
@@ -610,7 +609,7 @@ describe('Watch mode flows', () => {
       watchAll: false,
     });
 
-    stdin.emit(KEYS.A);
+    stdin.emit('a');
 
     await nextTick();
     // updateSnapshot is not sticky after a run.
@@ -622,11 +621,11 @@ describe('Watch mode flows', () => {
 
     results = {snapshot: {failure: true}};
 
-    stdin.emit(KEYS.A);
+    stdin.emit('a');
     await nextTick();
 
     runJestMock.mockReset();
-    stdin.emit(KEYS.U);
+    stdin.emit('u');
     await nextTick();
 
     expect(runJestMock.mock.calls[0][0].globalConfig).toMatchObject({
@@ -652,8 +651,8 @@ describe('Watch mode flows', () => {
     const ci_watch = require('../watch').default;
     ci_watch(globalConfig, contexts, pipe, hasteMapInstances, stdin);
 
-    stdin.emit(KEYS.F);
-    stdin.emit(KEYS.W);
+    stdin.emit('f');
+    stdin.emit('w');
 
     const lastWatchDisplay = pipe.write.mock.calls.reverse()[0][0];
     expect(lastWatchDisplay).toMatch('Press a to run all tests.');

packages/jest-cli/src/__tests__/watch_filename_pattern_mode.test.js

@@ -9,7 +9,7 @@
 'use strict';
 
 import chalk from 'chalk';
-import {KEYS} from '../constants';
+import {KEYS} from 'jest-watch';
 
 const runJestMock = jest.fn();
 
@@ -79,10 +79,6 @@ jest.doMock(
     },
 );
 
-jest.doMock('../lib/terminal_utils', () => ({
-  getTerminalWidth: () => terminalWidth,
-}));
-
 const watch = require('../watch').default;
 
 const nextTick = () => new Promise(res => process.nextTick(res));
@@ -110,7 +106,7 @@ describe('Watch mode flows', () => {
     watch(globalConfig, contexts, pipe, hasteMapInstances, stdin);
 
     // Write a enter pattern mode
-    stdin.emit(KEYS.P);
+    stdin.emit('p');
     expect(pipe.write).toBeCalledWith(' pattern › ');
 
     const assertPattern = hex => {
@@ -146,26 +142,26 @@ describe('Watch mode flows', () => {
     contexts[0].config = {rootDir: ''};
     watch(globalConfig, contexts, pipe, hasteMapInstances, stdin);
 
-    stdin.emit(KEYS.P);
+    stdin.emit('p');
     await nextTick();
 
     ['p', '.', '*', '1', '0']
 
       .concat(KEYS.ENTER)
       .forEach(key => stdin.emit(key));
 
-    stdin.emit(KEYS.T);
+    stdin.emit('t');
     await nextTick();
 
     ['t', 'e', 's', 't'].concat(KEYS.ENTER).forEach(key => stdin.emit(key));
 
     await nextTick();
 
-    stdin.emit(KEYS.C);
+    stdin.emit('c');
     await nextTick();
 
     pipe.write.mockReset();
-    stdin.emit(KEYS.P);
+    stdin.emit('p');
     await nextTick();
 
     expect(pipe.write.mock.calls.join('\n')).toMatchSnapshot();

packages/jest-cli/src/__tests__/watch_test_name_pattern_mode.test.js

@@ -9,7 +9,7 @@
 'use strict';
 
 import chalk from 'chalk';
-import {KEYS} from '../constants';
+import {KEYS} from 'jest-watch';
 
 const runJestMock = jest.fn();
 
@@ -93,10 +93,6 @@ jest.doMock(
     },
 );
 
-jest.doMock('../lib/terminal_utils', () => ({
-  getTerminalWidth: () => terminalWidth,
-}));
-
 const watch = require('../watch').default;
 
 const globalConfig = {
@@ -124,7 +120,7 @@ describe('Watch mode flows', () => {
     watch(globalConfig, contexts, pipe, hasteMapInstances, stdin);
 
     // Write a enter pattern mode
-    stdin.emit(KEYS.T);
+    stdin.emit('t');
     expect(pipe.write).toBeCalledWith(' pattern › ');
 
     const assertPattern = hex => {