chore: migrate jest-validate to TypeScript

CHANGELOG.md

@@ -62,6 +62,7 @@
 - `[jest-runner]`: Migrate to TypeScript ([#7968](https://github.com/facebook/jest/pull/7968))
 - `[jest-runtime]`: Migrate to TypeScript ([#7964](https://github.com/facebook/jest/pull/7964), [#7988](https://github.com/facebook/jest/pull/7988))
 - `[@jest/fake-timers]`: Extract FakeTimers class from `jest-util` into a new separate package ([#7987](https://github.com/facebook/jest/pull/7987))
+- `[jest-validate]`: Migrate to TypeScript ([#7991](https://github.com/facebook/jest/pull/7991))
 
 ### Performance
 

packages/jest-config/src/ReporterValidationErrors.ts

@@ -7,7 +7,6 @@
  */
 
 import {Config} from '@jest/types';
-// @ts-ignore: Not migrated to TS
 import {ValidationError} from 'jest-validate';
 import chalk from 'chalk';
 import getType from 'jest-get-type';
@@ -27,7 +26,7 @@ const ERROR = `${BULLET}Reporter Validation Error`;
 export function createReporterError(
   reporterIndex: number,
   reporterValue: Array<Config.ReporterConfig> | string,
-): ValidationError {
+) {
   const errorMessage =
     `  Reporter at index ${reporterIndex} must be of type:\n` +
     `    ${chalk.bold.green(validReporterTypes.join(' or '))}\n` +
@@ -44,7 +43,7 @@ export function createArrayReporterError(
   value: string | Object,
   expectedType: string,
   valueName: string,
-): ValidationError {
+) {
   const errorMessage =
     `  Unexpected value for ${valueName} ` +
     `at index ${valueIndex} of reporter at index ${reporterIndex}\n` +

packages/jest-config/src/ValidConfig.ts

@@ -7,14 +7,14 @@
 
 import {Config} from '@jest/types';
 import {replacePathSepForRegex} from 'jest-regex-util';
-// @ts-ignore: Not migrated to TS
 import {multipleValidOptions} from 'jest-validate';
 import {NODE_MODULES} from './constants';
 
 const NODE_MODULES_REGEXP = replacePathSepForRegex(NODE_MODULES);
 
 const initialOptions: Config.InitialOptions = {
   automock: false,
+  // @ts-ignore TODO: type this properly
   bail: multipleValidOptions(false, 0),
   browser: false,
   cache: true,

packages/jest-config/src/normalize.ts

@@ -9,7 +9,6 @@ import crypto from 'crypto';
 import path from 'path';
 import glob from 'glob';
 import {Config} from '@jest/types';
-// @ts-ignore: Not migrated to TS
 import {ValidationError, validate} from 'jest-validate';
 import {clearLine, replacePathSepForGlob} from 'jest-util';
 import chalk from 'chalk';

packages/jest-config/src/utils.ts

@@ -7,7 +7,6 @@
 
 import path from 'path';
 import {Config} from '@jest/types';
-// @ts-ignore: Not migrated to TS
 import {ValidationError} from 'jest-validate';
 import Resolver from 'jest-resolve';
 import chalk from 'chalk';

packages/jest-config/tsconfig.json

@@ -4,16 +4,16 @@
     "rootDir": "src",
     "outDir": "build"
   },
-  // TODO: This is missing `jest-validate`, in addition to
-  // `jest-environment-jsdom` and `jest-jasmine2`, but those are just
-  // `require.resolve`d, so no real use for their types
+  // TODO: This is missing jest-environment-jsdom` and `jest-jasmine2`,
+  // but those are just `require.resolve`d, so no real use for their types
   "references": [
     {"path": "../jest-environment-node"},
     {"path": "../jest-get-type"},
     {"path": "../jest-regex-util"},
     {"path": "../jest-resolve"},
     {"path": "../jest-types"},
     {"path": "../jest-util"},
+    {"path": "../jest-validate"},
     {"path": "../pretty-format"}
   ]
 }

packages/jest-runtime/src/cli/index.ts

@@ -13,7 +13,6 @@ import yargs from 'yargs';
 import {Config} from '@jest/types';
 import {JestEnvironment} from '@jest/environment';
 import {Console, setGlobal} from 'jest-util';
-// @ts-ignore: Not migrated to TS
 import {validateCLIOptions} from 'jest-validate';
 import {readConfig, deprecationEntries} from 'jest-config';
 import {VERSION} from '../version';
@@ -35,6 +34,7 @@ export function run(cliArgv?: Config.Argv, cliInfo?: Array<string>) {
       .version(false)
       .options(args.options).argv;
 
+    // @ts-ignore: fix this at some point
     validateCLIOptions(argv, {...args.options, deprecationEntries});
   }
 

packages/jest-runtime/tsconfig.json

@@ -4,7 +4,6 @@
     "rootDir": "src",
     "outDir": "build"
   },
-  // TODO: Missing `jest-validate`
   "references": [
     {"path": "../jest-config"},
     {"path": "../jest-environment"},
@@ -15,8 +14,9 @@
     {"path": "../jest-regex-util"},
     {"path": "../jest-resolve"},
     {"path": "../jest-snapshot"},
-    {"path": "../jest-util"},
     {"path": "../jest-types"},
+    {"path": "../jest-util"},
+    {"path": "../jest-validate"},
     {"path": "../pretty-format"}
   ]
 }

packages/jest-validate/package.json

@@ -8,7 +8,9 @@
   },
   "license": "MIT",
   "main": "build/index.js",
+  "types": "build/index.d.ts",
   "dependencies": {
+    "@jest/types": "^24.1.0",
     "camelcase": "^5.0.0",
     "chalk": "^2.0.1",
     "jest-get-type": "^24.0.0",

packages/jest-validate/src/__tests__/validateCLIOptions.test.js

@@ -6,8 +6,6 @@
  *
  */
 
-'use strict';
-
 import validateCLIOptions from '../validateCLIOptions';
 
 test('validates yargs special options', () => {

packages/jest-validate/src/condition.js → packages/jest-validate/src/condition.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 toString = Object.prototype.toString;
@@ -23,6 +21,7 @@ function validationConditionSingle(option: any, validOption: any): boolean {
 export function getValues(validOption: any) {
   if (
     Array.isArray(validOption) &&
+    // @ts-ignore
     validOption[MULTIPLE_VALID_OPTIONS_SYMBOL]
   ) {
     return validOption;
@@ -34,9 +33,11 @@ export function validationCondition(option: any, validOption: any): boolean {
   return getValues(validOption).some(e => validationConditionSingle(option, e));
 }
 
+// TODO: This should infer the types of its arguments, and return a union type of the types
+// See https://github.com/Microsoft/TypeScript/issues/5453
 export function multipleValidOptions(...args: Array<any>) {
   const options = [...args];
-  // $FlowFixMe
+  // @ts-ignore
   options[MULTIPLE_VALID_OPTIONS_SYMBOL] = true;
   return options;
 }

packages/jest-validate/src/defaultConfig.js → packages/jest-validate/src/defaultConfig.ts

@@ -3,19 +3,17 @@
  *
  * 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 {ValidationOptions} from './types';
+import {ValidationOptions} from './types';
 
 import {deprecationWarning} from './deprecated';
 import {unknownOptionWarning} from './warnings';
 import {errorMessage} from './errors';
 import {validationCondition} from './condition';
 import {ERROR, DEPRECATION, WARNING} from './utils';
 
-export default ({
+const validationOptions: ValidationOptions = {
   comment: '',
   condition: validationCondition,
   deprecate: deprecationWarning,
@@ -31,4 +29,6 @@ export default ({
     warning: WARNING,
   },
   unknown: unknownOptionWarning,
-}: ValidationOptions);
+};
+
+export default validationOptions;

packages/jest-validate/src/deprecated.js → packages/jest-validate/src/deprecated.ts

@@ -3,11 +3,9 @@
  *
  * 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 {ValidationOptions} from './types';
+import {DeprecatedOptions, ValidationOptions} from './types';
 
 import {logValidationWarning, DEPRECATION} from './utils';
 
@@ -19,9 +17,9 @@ const deprecationMessage = (message: string, options: ValidationOptions) => {
 };
 
 export const deprecationWarning = (
-  config: Object,
+  config: {[key: string]: any},
   option: string,
-  deprecatedOptions: Object,
+  deprecatedOptions: DeprecatedOptions,
   options: ValidationOptions,
 ): boolean => {
   if (option in deprecatedOptions) {

packages/jest-validate/src/errors.js → packages/jest-validate/src/errors.ts

@@ -3,16 +3,13 @@
  *
  * 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 {ValidationOptions} from './types';
-
 import chalk from 'chalk';
 import getType from 'jest-get-type';
 import {formatPrettyObject, ValidationError, ERROR} from './utils';
 import {getValues} from './condition';
+import {ValidationOptions} from './types';
 
 export const errorMessage = (
   option: string,

packages/jest-validate/src/exampleConfig.js → packages/jest-validate/src/exampleConfig.ts

@@ -3,20 +3,18 @@
  *
  * 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 {ValidationOptions} from './types';
+import {ValidationOptions} from './types';
 
 const config: ValidationOptions = {
   comment: '  A comment',
-  condition: (option, validOption) => true,
-  deprecate: (config, option, deprecatedOptions, options) => false,
+  condition: () => true,
+  deprecate: () => false,
   deprecatedConfig: {
-    key: config => {},
+    key: () => {},
   },
-  error: (option, received, defaultValue, options) => {},
+  error: () => {},
   exampleConfig: {key: 'value', test: 'case'},
   recursive: true,
   recursiveBlacklist: [],
@@ -25,7 +23,7 @@ const config: ValidationOptions = {
     error: 'Validation Error',
     warning: 'Validation Warning',
   },
-  unknown: (config, option, options) => {},
+  unknown: () => {},
 };
 
 export default config;

packages/jest-validate/src/index.js → packages/jest-validate/src/index.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 {
@@ -17,7 +15,7 @@ import validate from './validate';
 import validateCLIOptions from './validateCLIOptions';
 import {multipleValidOptions} from './condition';
 
-module.exports = {
+export = {
   ValidationError,
   createDidYouMeanMessage,
   format,

packages/jest-validate/src/types.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+
+type Title = {
+  deprecation?: string;
+  error?: string;
+  warning?: string;
+};
+
+export type DeprecatedOptions = Record<string, Function>;
+
+export type ValidationOptions = {
+  comment?: string;
+  condition?: (option: any, validOption: any) => boolean;
+  deprecate?: (
+    config: {[key: string]: any},
+    option: string,
+    deprecatedOptions: DeprecatedOptions,
+    options: ValidationOptions,
+  ) => boolean;
+  deprecatedConfig?: DeprecatedOptions;
+  error?: (
+    option: string,
+    received: any,
+    defaultValue: any,
+    options: ValidationOptions,
+    path?: Array<string>,
+  ) => void;
+  exampleConfig: {[key: string]: any};
+  recursive?: boolean;
+  recursiveBlacklist?: Array<string>;
+  title?: Title;
+  unknown?: (
+    config: {[key: string]: any},
+    exampleConfig: {[key: string]: any},
+    option: string,
+    options: ValidationOptions,
+    path?: Array<string>,
+  ) => void;
+};