fix: jest 25 type definitions

AndrewLeedham · AndrewLeedham · commit ba82a9e88280 · 2020-01-28T10:17:34.000Z
A lot of the Jest typings were moved into the core repo rather than the `@types/jest` definitions. See DefinitelyTyped/DefinitelyTyped@ef7406a
diff --git a/e2e/__helpers__/test-case/processed-file-io.ts b/e2e/__helpers__/test-case/processed-file-io.ts
@@ -1,12 +1,15 @@
+import { TransformOptions, TransformedSource } from '@jest/transform/build/types'
+import { Config } from '@jest/types'
+
 import ProcessedSource from '../../../src/__helpers__/processed-source'
 
 // tslint:disable-next-line:no-default-export
 export default class ProcessedFileIo extends ProcessedSource {
   constructor(
     cwd: string,
     filename: string,
-    readonly input: [string, jest.Path, jest.ProjectConfig, jest.TransformOptions],
-    output: string | jest.TransformedSource,
+    readonly input: [string, Config.Path, Config.ProjectConfig, TransformOptions],
+    output: string | TransformedSource,
   ) {
     super(typeof output === 'string' ? output : output.code, filename, cwd)
   }
diff --git a/e2e/__helpers__/test-case/run-result.ts b/e2e/__helpers__/test-case/run-result.ts
@@ -1,3 +1,4 @@
+import { Config } from '@jest/types'
 import { LogMessage } from 'bs-logger'
 import { SpawnSyncReturns } from 'child_process'
 import { readFileSync, realpathSync } from 'fs'
@@ -19,7 +20,7 @@ export default class RunResult {
       cmd: string
       args: string[]
       env: { [key: string]: string }
-      config: jest.InitialOptions
+      config: Config.InitialOptions
       digest: string
     }>,
   ) {}
diff --git a/e2e/__helpers__/test-case/runtime.ts b/e2e/__helpers__/test-case/runtime.ts
@@ -1,3 +1,4 @@
+import { Config } from '@jest/types'
 import { sync as spawnSync } from 'cross-spawn'
 import { createHash } from 'crypto'
 import stringifyJson = require('fast-json-stable-stringify')
@@ -64,10 +65,10 @@ export function run(name: string, options: RunTestOptions = {}): RunResult {
   const jestConfigPath = (path: string = dir) => resolve(path, configFile)
 
   // grab base configuration
-  let baseConfig: jest.InitialOptions = require(jestConfigPath())
+  let baseConfig: Config.InitialOptions = require(jestConfigPath())
   if (configFile === 'package.json') baseConfig = (baseConfig as any).jest
 
-  const extraConfig = {} as jest.InitialOptions
+  const extraConfig = {} as Config.InitialOptions
 
   let shortCmd: string
   let cmdArgs: string[] = []
diff --git a/e2e/__helpers__/test-case/types.ts b/e2e/__helpers__/test-case/types.ts
@@ -1,3 +1,5 @@
+import { Config } from '@jest/types'
+
 import { TsJestConfig } from '../../../src/types'
 
 import RunResult from './run-result'
@@ -7,7 +9,7 @@ export interface RunTestOptions {
   env?: {}
   inject?: (() => any) | string
   writeIo?: boolean
-  jestConfig?: jest.ProjectConfig | any
+  jestConfig?: Config.ProjectConfig | any
   tsJestConfig?: TsJestConfig | any
   noCache?: boolean
   jestConfigPath?: string
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -82,11 +82,13 @@
   "devDependencies": {
     "@commitlint/cli": "8.x",
     "@commitlint/config-conventional": "7.x",
+    "@jest/transform": "25.x",
+    "@jest/types": "25.x",
     "@types/babel__core": "7.x",
     "@types/buffer-from": "latest",
     "@types/cross-spawn": "latest",
     "@types/fs-extra": "latest",
-    "@types/jest": "23.x",
+    "@types/jest": "25.x",
     "@types/js-yaml": "latest",
     "@types/json5": "latest",
     "@types/lodash.memoize": "4.x",
diff --git a/src/__helpers__/fakers.ts b/src/__helpers__/fakers.ts
@@ -1,3 +1,4 @@
+import { Config } from '@jest/types'
 import { resolve } from 'path'
 
 import { BabelConfig, TsJestConfig, TsJestGlobalOptions } from '../types'
@@ -67,8 +68,8 @@ export function tsJestConfig(options?: Partial<TsJestConfig>): TsJestConfig {
   }
 }
 
-export function jestConfig<T extends jest.ProjectConfig>(
-  options?: Partial<jest.InitialOptions | jest.ProjectConfig>,
+export function jestConfig<T extends Config.ProjectConfig>(
+  options?: Partial<Config.InitialOptions | Config.ProjectConfig>,
   tsJestOptions?: TsJestGlobalOptions,
 ): T {
   const res = {
diff --git a/src/cli/config/migrate.ts b/src/cli/config/migrate.ts
@@ -1,3 +1,4 @@
+import { Config } from '@jest/types'
 import { createLogger } from 'bs-logger'
 import * as stringifyJson from 'fast-json-stable-stringify'
 import { existsSync } from 'fs'
@@ -25,7 +26,7 @@ export const run: CliCommand = async (args: Arguments /*, logger: Logger*/) => {
   if (!/\.(js|json)$/.test(name)) {
     throw new TypeError(`Configuration file ${file} must be a JavaScript or JSON file.`)
   }
-  let actualConfig: jest.InitialOptions = require(filePath)
+  let actualConfig: Config.InitialOptions = require(filePath)
   if (isPackage) {
     actualConfig = (actualConfig as any).jest
   }
@@ -173,7 +174,7 @@ ${footNotes.join('\n')}
   }
 }
 
-function cleanupConfig(config: jest.InitialOptions): void {
+function cleanupConfig(config: Config.InitialOptions): void {
   if (config.globals) {
     if ((config as any).globals['ts-jest'] && Object.keys((config as any).globals['ts-jest']).length === 0) {
       delete (config as any).globals['ts-jest']
diff --git a/src/compiler.spec.ts b/src/compiler.spec.ts
@@ -1,4 +1,5 @@
 // tslint:disable:max-line-length
+import { Config } from '@jest/types'
 import { LogLevels } from 'bs-logger'
 import { removeSync, writeFileSync } from 'fs-extra'
 
@@ -18,7 +19,7 @@ function makeCompiler({
   tsJestConfig,
   parentConfig,
 }: {
-  jestConfig?: Partial<jest.ProjectConfig>
+  jestConfig?: Partial<Config.ProjectConfig>
   tsJestConfig?: TsJestGlobalOptions
   parentConfig?: TsJestGlobalOptions
 } = {}) {
diff --git a/src/config/config-set.spec.ts b/src/config/config-set.spec.ts
@@ -1,3 +1,5 @@
+import { Transformer } from '@jest/transform/build/types'
+import { Config } from '@jest/types'
 import { testing } from 'bs-logger'
 import { resolve } from 'path'
 import { Diagnostic, DiagnosticCategory, ModuleKind, ParsedCommandLine, ScriptTarget } from 'typescript'
@@ -35,7 +37,7 @@ function createConfigSet({
   resolve = defaultResolve,
   ...others
 }: {
-  jestConfig?: jest.ProjectConfig
+  jestConfig?: Config.ProjectConfig
   tsJestConfig?: TsJestGlobalOptions
   parentConfig?: TsJestGlobalOptions
   resolve?: ((path: string) => string) | null
@@ -543,7 +545,7 @@ describe('babelJestTransformer', () => {
     let cs = createConfigSet({ tsJestConfig: { tsConfig: false } as any })
     expect(cs.babelJestTransformer).toBeUndefined()
     cs = createConfigSet({ tsJestConfig: { tsConfig: false, babelConfig: {} } as any })
-    const babelJest = cs.babelJestTransformer as jest.Transformer
+    const babelJest = cs.babelJestTransformer as Transformer
     expect(babelJest.canInstrument).toBe(true)
     expect(babelJest.createTransformer).toBeUndefined()
     expect(typeof babelJest.getCacheKey).toBe('function')
diff --git a/src/config/config-set.ts b/src/config/config-set.ts
@@ -8,6 +8,7 @@
  * version of the `jest.ProjectConfig`, and then later it calls `process()`
  * with the complete, object version of it.
  */
+import { Config } from '@jest/types'
 import { LogContexts, Logger } from 'bs-logger'
 import { existsSync, readFileSync, realpathSync } from 'fs'
 import json5 = require('json5')
@@ -165,7 +166,7 @@ export class ConfigSet {
   }
 
   @Memoize()
-  get jest(): jest.ProjectConfig {
+  get jest(): Config.ProjectConfig {
     const config = backportJestConfig(this.logger, this._jestConfig)
     if (this.parentOptions) {
       const globals: any = config.globals || (config.globals = {})
@@ -622,9 +623,9 @@ export class ConfigSet {
   /**
    * @internal
    */
-  private readonly _jestConfig: jest.ProjectConfig
+  private readonly _jestConfig: Config.ProjectConfig
 
-  constructor(jestConfig: jest.ProjectConfig, readonly parentOptions?: TsJestGlobalOptions, parentLogger?: Logger) {
+  constructor(jestConfig: Config.ProjectConfig, readonly parentOptions?: TsJestGlobalOptions, parentLogger?: Logger) {
     this._jestConfig = jestConfig
     this.logger = parentLogger ? parentLogger.child({ [LogContexts.namespace]: 'config' }) : logger
   }
diff --git a/src/config/create-jest-preset.ts b/src/config/create-jest-preset.ts
@@ -1,9 +1,11 @@
+import { Config } from '@jest/types'
+
 import { rootLogger } from '../util/logger'
 
 const logger = rootLogger.child({ namespace: 'jest-preset' })
 
 export interface TsJestPresets {
-  transform: Record<string, string>
+  transform: Config.InitialOptions['transform']
   testMatch?: string[]
   moduleFileExtensions?: string[]
 }
@@ -14,7 +16,7 @@ export interface CreateJestPresetOptions {
 
 export function createJestPreset(
   { allowJs = false }: CreateJestPresetOptions = {},
-  from: jest.InitialOptions = {},
+  from: Config.InitialOptions = {},
 ): TsJestPresets {
   logger.debug({ allowJs }, 'creating jest presets', allowJs ? 'handling' : 'not handling', 'JavaScript files')
   return {
diff --git a/src/config/paths-to-module-name-mapper.ts b/src/config/paths-to-module-name-mapper.ts
@@ -1,11 +1,12 @@
+import { Config } from '@jest/types'
 import { LogContexts } from 'bs-logger'
 import { CompilerOptions } from 'typescript'
 
 import { rootLogger } from '../util/logger'
 import { Errors, interpolate } from '../util/messages'
 
 type TsPathMapping = Exclude<CompilerOptions['paths'], undefined>
-type JestPathMapping = jest.InitialOptions['moduleNameMapper']
+type JestPathMapping = Config.InitialOptions['moduleNameMapper']
 
 // we don't need to escape all chars, so commented out is the real one
 // const escapeRegex = (str: string) => str.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&')
diff --git a/src/ts-jest-transformer.spec.ts b/src/ts-jest-transformer.spec.ts
@@ -1,3 +1,4 @@
+import { Config } from '@jest/types'
 import stringify = require('fast-json-stable-stringify')
 import { sep } from 'path'
 import { ParsedCommandLine } from 'typescript'
@@ -50,7 +51,7 @@ describe('process', () => {
   }
   const INPUT = 'export default "foo"'
   const FILE = '/foo/bar.ts'
-  const JEST_CONFIG = {} as jest.ProjectConfig
+  const JEST_CONFIG = {} as Config.ProjectConfig
   const OPTIONS = { instrument: false }
   const process = () => tr.process(...args)
   beforeEach(() => {
diff --git a/src/ts-jest-transformer.ts b/src/ts-jest-transformer.ts
@@ -1,3 +1,5 @@
+import { TransformOptions, TransformedSource, Transformer } from '@jest/transform/build/types'
+import { Config } from '@jest/types'
 import { Logger } from 'bs-logger'
 import { inspect } from 'util'
 
@@ -16,10 +18,10 @@ export const INSPECT_CUSTOM = inspect.custom || 'inspect'
 
 interface ConfigSetIndexItem {
   configSet: ConfigSet
-  jestConfig: JsonableValue<jest.ProjectConfig>
+  jestConfig: JsonableValue<Config.ProjectConfig>
 }
 
-export class TsJestTransformer implements jest.Transformer {
+export class TsJestTransformer implements Transformer {
   /**
    * @internal
    */
@@ -60,9 +62,9 @@ export class TsJestTransformer implements jest.Transformer {
     return `[object TsJestTransformer<#${this.id}>]`
   }
 
-  configsFor(jestConfig: jest.ProjectConfig | string) {
+  configsFor(jestConfig: Config.ProjectConfig | string) {
     let csi: ConfigSetIndexItem | undefined
-    let jestConfigObj: jest.ProjectConfig
+    let jestConfigObj: Config.ProjectConfig
     if (typeof jestConfig === 'string') {
       csi = TsJestTransformer._configSetsIndex.find(cs => cs.jestConfig.serialized === jestConfig)
       if (csi) return csi.configSet
@@ -95,12 +97,12 @@ export class TsJestTransformer implements jest.Transformer {
 
   process(
     input: string,
-    filePath: jest.Path,
-    jestConfig: jest.ProjectConfig,
-    transformOptions?: jest.TransformOptions,
-  ): jest.TransformedSource | string {
+    filePath: Config.Path,
+    jestConfig: Config.ProjectConfig,
+    transformOptions?: TransformOptions,
+  ): TransformedSource | string {
     this.logger.debug({ fileName: filePath, transformOptions }, 'processing', filePath)
-    let result: string | jest.TransformedSource
+    let result: string | TransformedSource
     const source: string = input
 
     const configs = this.configsFor(jestConfig)
diff --git a/src/types.ts b/src/types.ts
@@ -1,3 +1,4 @@
+import { TransformedSource, Transformer } from '@jest/transform/build/types'
 import * as _babel from 'babel__core'
 import { CompilerOptions, SourceFile, TransformerFactory } from 'typescript'
 // tslint:disable-next-line:no-duplicate-imports
@@ -7,9 +8,9 @@ import { ConfigSet } from './config/config-set'
 
 export type TBabelCore = typeof _babel
 export type TTypeScript = typeof _ts
-export type TBabelJest = Required<jest.Transformer>
+export type TBabelJest = Required<Transformer>
 export type BabelJestTransformer = {
-  [K in Exclude<keyof jest.Transformer, 'createTransformer'>]: Exclude<jest.Transformer[K], undefined>
+  [K in Exclude<keyof Transformer, 'createTransformer'>]: Exclude<Transformer[K], undefined>
 }
 export type BabelConfig = _babel.TransformOptions
 
@@ -128,7 +129,7 @@ export interface TsJestConfig {
 }
 
 export interface TsJestHooksMap {
-  afterProcess?(args: any[], result: string | jest.TransformedSource): string | jest.TransformedSource | void
+  afterProcess?(args: any[], result: string | TransformedSource): string | TransformedSource | void
 }
 
 /**
diff --git a/src/util/backports.ts b/src/util/backports.ts
@@ -1,3 +1,4 @@
+import { Config } from '@jest/types'
 import { LogContexts, Logger } from 'bs-logger'
 
 import { Deprecateds, Helps, interpolate } from './messages'
@@ -7,7 +8,7 @@ const context = { [LogContexts.namespace]: 'backports' }
 /**
  * @internal
  */
-export const backportJestConfig = <T extends jest.InitialOptions | jest.ProjectConfig>(
+export const backportJestConfig = <T extends Config.InitialOptions | Config.ProjectConfig>(
   logger: Logger,
   config: T,
 ): T => {

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { Config } from '@jest/types'`
`1`	`2`	`import { resolve } from 'path'`
`2`	`3`
`3`	`4`	`import { BabelConfig, TsJestConfig, TsJestGlobalOptions } from '../types'`
`@@ -67,8 +68,8 @@ export function tsJestConfig(options?: Partial<TsJestConfig>): TsJestConfig {`
`67`	`68`	`}`
`68`	`69`	`}`
`69`	`70`
`70`		`-export function jestConfig<T extends jest.ProjectConfig>(`
`71`		`- options?: Partial<jest.InitialOptions \| jest.ProjectConfig>,`
	`71`	`+export function jestConfig<T extends Config.ProjectConfig>(`
	`72`	`+ options?: Partial<Config.InitialOptions \| Config.ProjectConfig>,`
`72`	`73`	`tsJestOptions?: TsJestGlobalOptions,`
`73`	`74`	`): T {`
`74`	`75`	`const res = {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { Config } from '@jest/types'`
`1`	`2`	`import { createLogger } from 'bs-logger'`
`2`	`3`	`import * as stringifyJson from 'fast-json-stable-stringify'`
`3`	`4`	`import { existsSync } from 'fs'`
`@@ -25,7 +26,7 @@ export const run: CliCommand = async (args: Arguments /, logger: Logger/) => {`
`25`	`26`	`if (!/\.(js\|json)$/.test(name)) {`
`26`	`27`	throw new TypeError(`Configuration file ${file} must be a JavaScript or JSON file.`)
`27`	`28`	`}`
`28`		`- let actualConfig: jest.InitialOptions = require(filePath)`
	`29`	`+ let actualConfig: Config.InitialOptions = require(filePath)`
`29`	`30`	`if (isPackage) {`
`30`	`31`	`actualConfig = (actualConfig as any).jest`
`31`	`32`	`}`
`@@ -173,7 +174,7 @@ ${footNotes.join('\n')}`
`173`	`174`	`}`
`174`	`175`	`}`
`175`	`176`
`176`		`-function cleanupConfig(config: jest.InitialOptions): void {`
	`177`	`+function cleanupConfig(config: Config.InitialOptions): void {`
`177`	`178`	`if (config.globals) {`
`178`	`179`	`if ((config as any).globals['ts-jest'] && Object.keys((config as any).globals['ts-jest']).length === 0) {`
`179`	`180`	`delete (config as any).globals['ts-jest']`