choreØ eplace function types (#10436)

Co-authored-by: Simen Bekkhus <sbekkhus91@gmail.com>

packages/jest-circus/package.json

@@ -14,6 +14,7 @@
     "@jest/environment": "^26.3.0",
     "@jest/test-result": "^26.3.0",
     "@jest/types": "^26.3.0",
+    "@types/babel__traverse": "^7.0.4",
     "@types/node": "*",
     "chalk": "^4.0.0",
     "co": "^4.6.0",

packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapterInit.ts

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import type BabelTraverse from '@babel/traverse';
 import type {Circus, Config, Global} from '@jest/types';
 import type {JestEnvironment} from '@jest/environment';
 import {
@@ -51,7 +52,7 @@ export const initialize = async ({
   config: Config.ProjectConfig;
   environment: JestEnvironment;
   getPrettier: () => null | any;
-  getBabelTraverse: () => Function;
+  getBabelTraverse: () => typeof BabelTraverse;
   globalConfig: Config.GlobalConfig;
   localRequire: (path: Config.Path) => any;
   testPath: Config.Path;

packages/jest-config/src/Deprecated.ts

@@ -7,10 +7,11 @@
 
 import chalk = require('chalk');
 import prettyFormat = require('pretty-format');
+import type {DeprecatedOptions} from 'jest-validate';
 
 const format = (value: unknown) => prettyFormat(value, {min: true});
 
-export default {
+const deprecatedOptions: DeprecatedOptions = {
   browser: () => `  Option ${chalk.bold(
     '"browser"',
   )} has been deprecated. Please install "browser-resolve" and use the "resolver" option in Jest configuration as follows:
@@ -26,7 +27,7 @@ export default {
   Please update your configuration.`,
 
   preprocessorIgnorePatterns: (options: {
-    preprocessorIgnorePatterns: Array<string>;
+    preprocessorIgnorePatterns?: Array<string>;
   }) => `  Option ${chalk.bold(
     '"preprocessorIgnorePatterns"',
   )} was replaced by ${chalk.bold(
@@ -43,7 +44,7 @@ export default {
   Please update your configuration.`,
 
   scriptPreprocessor: (options: {
-    scriptPreprocessor: string;
+    scriptPreprocessor?: string;
   }) => `  Option ${chalk.bold(
     '"scriptPreprocessor"',
   )} was replaced by ${chalk.bold(
@@ -60,7 +61,7 @@ export default {
   Please update your configuration.`,
 
   setupTestFrameworkScriptFile: (_options: {
-    setupTestFrameworkScriptFile: Array<string>;
+    setupTestFrameworkScriptFile?: string;
   }) => `  Option ${chalk.bold(
     '"setupTestFrameworkScriptFile"',
   )} was replaced by configuration ${chalk.bold(
@@ -70,7 +71,7 @@ export default {
   Please update your configuration.`,
 
   testPathDirs: (options: {
-    testPathDirs: Array<string>;
+    testPathDirs?: Array<string>;
   }) => `  Option ${chalk.bold('"testPathDirs"')} was replaced by ${chalk.bold(
     '"roots"',
   )}.
@@ -82,4 +83,6 @@ export default {
 
   Please update your configuration.
   `,
-} as Record<string, Function>;
+};
+
+export default deprecatedOptions;

packages/jest-snapshot/package.json

@@ -12,6 +12,7 @@
   "dependencies": {
     "@babel/types": "^7.0.0",
     "@jest/types": "^26.3.0",
+    "@types/babel__traverse": "^7.0.4",
     "@types/prettier": "^2.0.0",
     "chalk": "^4.0.0",
     "expect": "^26.4.2",

packages/jest-snapshot/src/State.ts

@@ -20,12 +20,12 @@ import {
   testNameToKey,
 } from './utils';
 import {InlineSnapshot, saveInlineSnapshots} from './inline_snapshots';
-import type {SnapshotData} from './types';
+import type {BabelTraverse, Prettier, SnapshotData} from './types';
 
 export type SnapshotStateOptions = {
   updateSnapshot: Config.SnapshotUpdateState;
-  getPrettier: () => null | typeof import('prettier');
-  getBabelTraverse: () => Function;
+  getPrettier: () => null | Prettier;
+  getBabelTraverse: () => BabelTraverse;
   expand?: boolean;
 };
 
@@ -62,7 +62,7 @@ export default class SnapshotState {
   private _snapshotPath: Config.Path;
   private _inlineSnapshots: Array<InlineSnapshot>;
   private _uncheckedKeys: Set<string>;
-  private _getBabelTraverse: () => Function;
+  private _getBabelTraverse: () => BabelTraverse;
   private _getPrettier: () => null | typeof import('prettier');
 
   added: number;

packages/jest-snapshot/src/inline_snapshots.ts

@@ -15,8 +15,8 @@ import {
   templateLiteral,
 } from '@babel/types';
 import type {Frame} from 'jest-message-util';
-
 import type {Config} from '@jest/types';
+import type {BabelTraverse, Prettier} from './types';
 import {escapeBacktickString} from './utils';
 
 export type InlineSnapshot = {
@@ -26,8 +26,8 @@ export type InlineSnapshot = {
 
 export function saveInlineSnapshots(
   snapshots: Array<InlineSnapshot>,
-  prettier: typeof import('prettier') | null,
-  babelTraverse: Function,
+  prettier: Prettier | null,
+  babelTraverse: BabelTraverse,
 ): void {
   if (!prettier) {
     throw new Error(
@@ -60,7 +60,7 @@ const saveSnapshotsForFile = (
   snapshots: Array<InlineSnapshot>,
   sourceFilePath: Config.Path,
   prettier: any,
-  babelTraverse: Function,
+  babelTraverse: BabelTraverse,
 ) => {
   const sourceFile = fs.readFileSync(sourceFilePath, 'utf8');
 
@@ -181,7 +181,7 @@ const createInsertionParser = (
   snapshots: Array<InlineSnapshot>,
   snapshotMatcherNames: Array<string>,
   inferredParser: string,
-  babelTraverse: Function,
+  babelTraverse: BabelTraverse,
 ) => (
   text: string,
   parsers: Record<string, (text: string) => any>,
@@ -248,7 +248,7 @@ const createInsertionParser = (
 const createFormattingParser = (
   snapshotMatcherNames: Array<string>,
   inferredParser: string,
-  babelTraverse: Function,
+  babelTraverse: BabelTraverse,
 ) => (
   text: string,
   parsers: Record<string, (text: string) => any>,

packages/jest-snapshot/src/types.ts

@@ -29,3 +29,6 @@ export type ExpectationResult = {
   pass: boolean;
   message: () => string;
 };
+
+export type BabelTraverse = typeof import('@babel/traverse').default;
+export type Prettier = typeof import('prettier');

packages/jest-validate/src/exampleConfig.ts

@@ -12,8 +12,7 @@ const config: ValidationOptions = {
   condition: () => true,
   deprecate: () => false,
   deprecatedConfig: {
-    // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
-    key: () => {},
+    key: (): string => 'Deprecation message',
   },
   error: () => {},
   exampleConfig: {key: 'value', test: 'case'},

packages/jest-validate/src/index.ts

@@ -11,6 +11,7 @@ export {
   format,
   logValidationWarning,
 } from './utils';
+export type {DeprecatedOptions} from './types';
 export {default as validate} from './validate';
 export {default as validateCLIOptions} from './validateCLIOptions';
 export {multipleValidOptions} from './condition';

packages/jest-validate/src/types.ts

@@ -11,7 +11,9 @@ type Title = {
   warning?: string;
 };
 
-export type DeprecatedOptions = Record<string, Function>;
+export type DeprecatedOptionFunc = (arg: Record<string, any>) => string;
+
+export type DeprecatedOptions = Record<string, DeprecatedOptionFunc>;
 
 export type ValidationOptions = {
   comment?: string;

packages/jest-validate/src/validateCLIOptions.ts

@@ -12,7 +12,7 @@ import type {Options} from 'yargs';
 import {ValidationError, createDidYouMeanMessage, format} from './utils';
 import {deprecationWarning} from './deprecated';
 import defaultConfig from './defaultConfig';
-import type {DeprecatedOptions} from './types';
+import type {DeprecatedOptionFunc, DeprecatedOptions} from './types';
 
 const BULLET: string = chalk.bold('\u25cf');
 export const DOCUMENTATION_NOTE = `  ${chalk.bold('CLI Options Documentation:')}
@@ -88,7 +88,7 @@ export default function validateCLIOptions(
   }
 
   const CLIDeprecations = Object.keys(deprecationEntries).reduce<
-    Record<string, Function>
+    Record<string, DeprecatedOptionFunc>
   >((acc, entry) => {
     if (options[entry]) {
       acc[entry] = deprecationEntries[entry];

yarn.lock

@@ -11887,6 +11887,7 @@ fsevents@^1.2.7:
     "@babel/traverse": ^7.3.4
     "@babel/types": ^7.0.0
     "@jest/types": ^26.3.0
+    "@types/babel__traverse": ^7.0.4
     "@types/graceful-fs": ^4.1.3
     "@types/natural-compare": ^1.4.0
     "@types/prettier": ^2.0.0