chore: migrate jest-watcher to TypeScript

Author: SimenB

CHANGELOG.md

@@ -21,6 +21,7 @@
 - `[jest-serializer]`: Migrate to TypeScript ([#7841](https://github.com/facebook/jest/pull/7841))
 - `[jest-message-util]`: Migrate to TypeScript ([#7834](https://github.com/facebook/jest/pull/7834))
 - `[@jest/types]`: New package to handle shared types ([#7834](https://github.com/facebook/jest/pull/7834))
+- `[jest-watcher]`: Migrate to TypeScript ([#7843](https://github.com/facebook/jest/pull/7843))
 
 ### Performance
 

packages/jest-cli/src/plugins/quit.js

@@ -21,7 +21,6 @@ class QuitPlugin extends BaseWatchPlugin {
 
   async run() {
     if (typeof this._stdin.setRawMode === 'function') {
-      // $FlowFixMe
       this._stdin.setRawMode(false);
     }
     this._stdout.write('\n');

packages/jest-runner/src/runTest.js

@@ -89,7 +89,6 @@ async function runTestInternal(
   if (customEnvironment) {
     testEnvironment = getTestEnvironment({
       ...config,
-      // $FlowFixMe
       testEnvironment: customEnvironment,
     });
   }

packages/jest-types/src/Config.ts

@@ -213,6 +213,14 @@ export type InitialOptions = {
 
 export type SnapshotUpdateState = 'all' | 'new' | 'none';
 
+type NotifyMode =
+  | 'always'
+  | 'failure'
+  | 'success'
+  | 'change'
+  | 'success-change'
+  | 'failure-change';
+
 export type GlobalConfig = {
   bail: number;
   changedSince: string;
@@ -260,7 +268,7 @@ export type GlobalConfig = {
   nonFlagArgs: Array<string>;
   noSCM: boolean | null | undefined;
   notify: boolean;
-  notifyMode: string;
+  notifyMode: NotifyMode;
   outputFile: Path | null | undefined;
   onlyChanged: boolean;
   onlyFailures: boolean;

packages/jest-watcher/package.json

@@ -4,6 +4,8 @@
   "version": "24.0.0",
   "main": "build/index.js",
   "dependencies": {
+    "@jest/types": "^24.1.0",
+    "@types/node": "*",
     "ansi-escapes": "^3.0.0",
     "chalk": "^2.0.1",
     "jest-util": "^24.0.0",

packages/jest-watcher/src/BaseWatchPlugin.js

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {WatchPlugin} from './types';
+
+class BaseWatchPlugin implements WatchPlugin {
+  _stdin: NodeJS.ReadableStream;
+  _stdout: NodeJS.WritableStream;
+
+  constructor({
+    stdin,
+    stdout,
+  }: {
+    stdin: NodeJS.ReadableStream;
+    stdout: NodeJS.WritableStream;
+  }) {
+    this._stdin = stdin;
+    this._stdout = stdout;
+  }
+
+  apply() {}
+
+  getUsageInfo() {
+    return null;
+  }
+
+  onKey() {}
+
+  run() {
+    return Promise.resolve();
+  }
+}
+
+export default BaseWatchPlugin;

packages/jest-watcher/src/BaseWatchPlugin.ts

@@ -3,17 +3,15 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
-import type {
+import {
   JestHookSubscriber,
   JestHookEmitter,
   FileChange,
   ShouldRunTestSuite,
   TestRunComplete,
-} from 'types/JestHooks';
+} from './types';
 
 type AvailableHooks =
   | 'onFileChange'
@@ -22,9 +20,9 @@ type AvailableHooks =
 
 class JestHooks {
   _listeners: {
-    onFileChange: Array<FileChange>,
-    onTestRunComplete: Array<TestRunComplete>,
-    shouldRunTestSuite: Array<ShouldRunTestSuite>,
+    onFileChange: Array<FileChange>;
+    onTestRunComplete: Array<TestRunComplete>;
+    shouldRunTestSuite: Array<ShouldRunTestSuite>;
   };
 
   constructor() {
@@ -61,14 +59,15 @@ class JestHooks {
         this._listeners.onTestRunComplete.forEach(listener =>
           listener(results),
         ),
-      shouldRunTestSuite: async testSuiteInfo =>
-        Promise.all(
+      shouldRunTestSuite: async testSuiteInfo => {
+        const result = await Promise.all(
           this._listeners.shouldRunTestSuite.map(listener =>
             listener(testSuiteInfo),
           ),
-        ).then(result =>
-          result.every(shouldRunTestSuite => shouldRunTestSuite),
-        ),
+        );
+
+        return result.every(shouldRunTestSuite => shouldRunTestSuite);
+      },
     };
   }
 }

packages/jest-watcher/src/JestHooks.js renamed to packages/jest-watcher/src/JestHooks.ts

@@ -3,16 +3,11 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
-'use strict';
-
-import type {ScrollOptions} from 'types/Watch';
-
 import chalk from 'chalk';
 import ansiEscapes from 'ansi-escapes';
+// @ts-ignore: Not yet migrated
 import {specialChars} from 'jest-util';
 import Prompt from './lib/Prompt';
 
@@ -28,18 +23,20 @@ const usage = (entity: string) =>
 const usageRows = usage('').split('\n').length;
 
 export default class PatternPrompt {
-  _pipe: stream$Writable | tty$WriteStream;
+  _pipe: NodeJS.WritableStream;
   _prompt: Prompt;
   _entityName: string;
   _currentUsageRows: number;
 
-  constructor(pipe: stream$Writable | tty$WriteStream, prompt: Prompt) {
+  constructor(pipe: NodeJS.WritableStream, prompt: Prompt) {
+    // TODO: Should come in the constructor
+    this._entityName = '';
     this._pipe = pipe;
     this._prompt = prompt;
     this._currentUsageRows = usageRows;
   }
 
-  run(onSuccess: Function, onCancel: Function, options?: {header: string}) {
+  run(onSuccess: () => void, onCancel: () => void, options?: {header: string}) {
     this._pipe.write(ansiEscapes.cursorHide);
     this._pipe.write(CLEAR);
 
@@ -56,7 +53,7 @@ export default class PatternPrompt {
     this._prompt.enter(this._onChange.bind(this), onSuccess, onCancel);
   }
 
-  _onChange(pattern: string, options: ScrollOptions) {
+  protected _onChange() {
     this._pipe.write(ansiEscapes.eraseLine);
     this._pipe.write(ansiEscapes.cursorLeft);
   }

packages/jest-watcher/src/PatternPrompt.js renamed to packages/jest-watcher/src/PatternPrompt.ts

@@ -3,8 +3,6 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
 const isWindows = process.platform === 'win32';

packages/jest-watcher/src/constants.js renamed to packages/jest-watcher/src/constants.ts

@@ -3,8 +3,6 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
 export {default as BaseWatchPlugin} from './BaseWatchPlugin';

packages/jest-watcher/src/index.js renamed to packages/jest-watcher/src/index.ts

@@ -3,36 +3,44 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
-import type {ScrollOptions} from 'types/Watch';
-
+import {ScrollOptions} from '../types';
 import {KEYS} from '../constants';
 
 export default class Prompt {
   _entering: boolean;
   _value: string;
-  _onChange: Function;
-  _onSuccess: Function;
-  _onCancel: Function;
+  _onChange: () => void;
+  _onSuccess: (value?: string) => void;
+  _onCancel: (value?: string) => void;
   _offset: number;
   _promptLength: number;
   _selection: string | null;
 
   constructor() {
-    (this: any)._onResize = this._onResize.bind(this);
+    // Copied from `enter` to satisfy TS
+    this._entering = true;
+    this._value = '';
+    this._selection = null;
+    this._offset = -1;
+    this._promptLength = 0;
+
+    this._onChange = () => {};
+    this._onSuccess = () => {};
+    this._onCancel = () => {};
+
+    this._onResize = this._onResize.bind(this);
   }
 
-  _onResize() {
-    this._onChange(this._value);
+  private _onResize() {
+    this._onChange();
   }
 
   enter(
     onChange: (pattern: string, options: ScrollOptions) => void,
-    onSuccess: Function,
-    onCancel: Function,
+    onSuccess: () => void,
+    onCancel: () => void,
   ) {
     this._entering = true;
     this._value = '';

packages/jest-watcher/src/lib/Prompt.js renamed to packages/jest-watcher/src/lib/Prompt.ts

@@ -3,12 +3,8 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
-'use strict';
-
 import formatTestNameByPattern from '../formatTestNameByPattern';
 
 describe('for multiline test name returns', () => {

packages/jest-watcher/src/lib/__tests__/__snapshots__/formatTestNameByPattern.test.js.snap renamed to packages/jest-watcher/src/lib/__tests__/__snapshots__/formatTestNameByPattern.test.ts.snap

@@ -6,8 +6,6 @@
  *
  */
 
-'use strict';
-
 import Prompt from '../Prompt';
 import {KEYS} from '../../constants';
 

packages/jest-watcher/src/lib/__tests__/formatTestNameByPattern.test.js renamed to packages/jest-watcher/src/lib/__tests__/formatTestNameByPattern.test.ts

@@ -3,8 +3,6 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
 import chalk from 'chalk';

packages/jest-watcher/src/lib/__tests__/prompt.test.js renamed to packages/jest-watcher/src/lib/__tests__/prompt.test.ts

@@ -3,8 +3,6 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
 import chalk from 'chalk';
@@ -31,7 +29,7 @@ export default (testName: string, pattern: string, width: number) => {
     return chalk.dim(inlineTestName);
   }
 
-  const startPatternIndex = Math.max(match.index, 0);
+  const startPatternIndex = Math.max(match.index || 0, 0);
   const endPatternIndex = startPatternIndex + match[0].length;
 
   if (inlineTestName.length <= width) {

packages/jest-watcher/src/lib/__tests__/scroll.test.js renamed to packages/jest-watcher/src/lib/__tests__/scroll.test.ts

@@ -3,19 +3,15 @@
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
- *
- * @flow
  */
 
-'use strict';
-
 import chalk from 'chalk';
 import ansiEscapes from 'ansi-escapes';
 import stringLength from 'string-length';
 
 export const printPatternCaret = (
   pattern: string,
-  pipe: stream$Writable | tty$WriteStream,
+  pipe: NodeJS.WritableStream,
 ) => {
   const inputText = `${chalk.dim(' pattern \u203A')} ${pattern}`;
 
@@ -27,7 +23,7 @@ export const printPatternCaret = (
 export const printRestoredPatternCaret = (
   pattern: string,
   currentUsageRows: number,
-  pipe: stream$Writable | tty$WriteStream,
+  pipe: NodeJS.WritableStream,
 ) => {
   const inputText = `${chalk.dim(' pattern \u203A')} ${pattern}`;