fix: make esbuild as optional peer dependency (#3129)

Author: ahnpnl

e2e/__tests__/ast-transformers.test.ts

@@ -63,10 +63,14 @@ describe('hoist-jest', () => {
 })
 
 describe('transformer-in-ts', () => {
-  const TRANSFORMER_IN_TS_DIR_NAME = `${AST_TRANSFORMERS_DIR_NAME}/transformer-in-ts`
+  const DIR = path.join(__dirname, '..', AST_TRANSFORMERS_DIR_NAME, 'transformer-in-ts')
 
-  test(`successfully runs the tests inside ${TRANSFORMER_IN_TS_DIR_NAME}`, () => {
-    const { json } = runWithJson(TRANSFORMER_IN_TS_DIR_NAME)
+  beforeAll(() => {
+    runNpmInstall(DIR)
+  })
+
+  test(`successfully runs the tests inside ${DIR}`, () => {
+    const { json } = runWithJson(DIR)
 
     expect(json.success).toBe(true)
   })

e2e/ast-transformers/transformer-in-ts/package-lock.json

@@ -1,4 +1,7 @@
 {
+  "dependencies": {
+    "esbuild": "~0.14.2"
+  },
   "jest": {
     "globals": {
       "ts-jest": {

e2e/ast-transformers/transformer-in-ts/package.json

@@ -52,7 +52,6 @@
   "homepage": "https://kulshekhar.github.io/ts-jest",
   "dependencies": {
     "bs-logger": "0.x",
-    "esbuild": "~0.14.0",
     "fast-json-stable-stringify": "2.x",
     "jest-util": "^27.0.0",
     "json5": "2.x",
@@ -65,18 +64,22 @@
     "@babel/core": ">=7.0.0-beta.0 <8",
     "@types/jest": "^27.0.0",
     "babel-jest": ">=27.0.0 <28",
+    "esbuild": "~0.14.0",
     "jest": "^27.0.0",
     "typescript": ">=3.8 <5.0"
   },
   "peerDependenciesMeta": {
-    "babel-jest": {
-      "optional": true
-    },
     "@babel/core": {
       "optional": true
     },
     "@types/jest": {
       "optional": true
+    },
+    "babel-jest": {
+      "optional": true
+    },
+    "esbuild": {
+      "optional": true
     }
   },
   "husky": {
@@ -111,6 +114,7 @@
     "@typescript-eslint/parser": "^5.3.0",
     "conventional-changelog-cli": "2.x",
     "cross-spawn": "latest",
+    "esbuild": "~0.14.2",
     "eslint": "8.4.0",
     "eslint-config-prettier": "latest",
     "eslint-plugin-import": "latest",

package-lock.json

@@ -13,10 +13,9 @@ import Module from 'module'
 import { dirname, extname, isAbsolute, join, normalize, resolve } from 'path'
 
 import { LogContexts, Logger } from 'bs-logger'
-import { transformSync } from 'esbuild'
 import { globsToMatcher } from 'jest-util'
 import json5 from 'json5'
-import type { CompilerOptions, Diagnostic, FormatDiagnosticsHost, ParsedCommandLine } from 'typescript'
+import type * as ts from 'typescript'
 
 import { DEFAULT_JEST_TEST_MATCH, JS_JSX_EXTENSIONS } from '../constants'
 import type { RawCompilerOptions } from '../raw-compiler-options'
@@ -31,7 +30,8 @@ import type {
   TsJestGlobalOptions,
   TTypeScript,
 } from '../types'
-import { stringify, rootLogger } from '../utils'
+import { TsCompilerInstance } from '../types'
+import { rootLogger, stringify } from '../utils'
 import { backportJestConfig } from '../utils/backports'
 import { importer } from '../utils/importer'
 import { Errors, ImportReasons, interpolate } from '../utils/messages'
@@ -119,7 +119,7 @@ export class ConfigSet {
   cacheSuffix!: string
   tsCacheDir: string | undefined
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  parsedTsConfig!: ParsedCommandLine | Record<string, any>
+  parsedTsConfig!: ts.ParsedCommandLine | Record<string, any>
   resolvedTransformers: TsJestAstTransformer = {
     before: [],
     after: [],
@@ -161,7 +161,7 @@ export class ConfigSet {
   /**
    * @internal
    */
-  private readonly _overriddenCompilerOptions: Partial<CompilerOptions> = {
+  private readonly _overriddenCompilerOptions: Partial<ts.CompilerOptions> = {
     inlineSourceMap: false,
     // we don't want to create declaration files
     declaration: false,
@@ -316,13 +316,22 @@ export class ConfigSet {
     const { astTransformers } = options
     if (astTransformers) {
       const resolveTransformerFunc = (transformerPath: string) => {
-        let transformerFunc
+        let transformerFunc: {
+          version: number
+          name: string
+          factory: (
+            compilerInstance: TsCompilerInstance,
+            options?: Record<string, unknown>,
+          ) => (ctx: ts.TransformationContext) => ts.Transformer<ts.SourceFile>
+        }
         if (extname(transformerPath) === '.ts') {
-          const compiledTransformer = transformSync(readFileSync(transformerPath, 'utf-8'), {
-            loader: 'ts',
-            format: 'cjs',
-            target: 'es2015',
-          }).code
+          const compiledTransformer = importer
+            .esBuild(ImportReasons.EsBuild)
+            .transformSync(readFileSync(transformerPath, 'utf-8'), {
+              loader: 'ts',
+              format: 'cjs',
+              target: 'es2015',
+            }).code
           transformerFunc = requireFromString(compiledTransformer, transformerPath.replace('.ts', '.js'))
         } else {
           transformerFunc = require(transformerPath)
@@ -423,8 +432,11 @@ export class ConfigSet {
   /**
    * @internal
    */
-  private _getAndResolveTsConfig(compilerOptions?: RawCompilerOptions, resolvedConfigFile?: string): ParsedCommandLine {
-    const result = this._resolveTsConfig(compilerOptions, resolvedConfigFile) as ParsedCommandLine
+  private _getAndResolveTsConfig(
+    compilerOptions?: RawCompilerOptions,
+    resolvedConfigFile?: string,
+  ): ts.ParsedCommandLine {
+    const result = this._resolveTsConfig(compilerOptions, resolvedConfigFile) as ts.ParsedCommandLine
     const { _overriddenCompilerOptions: forcedOptions } = this
     const finalOptions = result.options
     // Target ES2015 output by default (instead of ES3).
@@ -519,7 +531,7 @@ export class ConfigSet {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   protected _resolveTsConfig(compilerOptions?: RawCompilerOptions, resolvedConfigFile?: string): Record<string, any>
   // eslint-disable-next-line no-dupe-class-members
-  protected _resolveTsConfig(compilerOptions?: RawCompilerOptions, resolvedConfigFile?: string): ParsedCommandLine {
+  protected _resolveTsConfig(compilerOptions?: RawCompilerOptions, resolvedConfigFile?: string): ts.ParsedCommandLine {
     let config = { compilerOptions: Object.create(null) }
     let basePath = normalizeSlashes(this.rootDir)
     const ts = this.compilerModule
@@ -559,7 +571,7 @@ export class ConfigSet {
     return this._stringifyContentRegExp ? this._stringifyContentRegExp.test(filePath) : false
   }
 
-  raiseDiagnostics(diagnostics: Diagnostic[], filePath?: string, logger?: Logger): void {
+  raiseDiagnostics(diagnostics: ts.Diagnostic[], filePath?: string, logger?: Logger): void {
     const { ignoreCodes } = this._diagnostics
     const { DiagnosticCategory } = this.compilerModule
     const filteredDiagnostics =
@@ -594,12 +606,12 @@ export class ConfigSet {
   /**
    * @internal
    */
-  private _createTsError(diagnostics: readonly Diagnostic[]): TSError {
+  private _createTsError(diagnostics: readonly ts.Diagnostic[]): TSError {
     const formatDiagnostics = this._diagnostics.pretty
       ? this.compilerModule.formatDiagnosticsWithColorAndContext
       : this.compilerModule.formatDiagnostics
     /* istanbul ignore next (not possible to cover) */
-    const diagnosticHost: FormatDiagnosticsHost = {
+    const diagnosticHost: ts.FormatDiagnosticsHost = {
       getNewLine: () => '\n',
       getCurrentDirectory: () => this.cwd,
       getCanonicalFileName: (path: string) => path,

package.json

@@ -1,6 +1,7 @@
 import type { Transformer, TransformOptions } from '@jest/transform'
 import type { Config } from '@jest/types'
 import type * as _babel from 'babel__core'
+import type * as _esbuild from 'esbuild'
 import type * as _ts from 'typescript'
 
 import type { ConfigSet } from './config'
@@ -26,6 +27,7 @@ declare module '@jest/types' {
  */
 export type TBabelCore = typeof _babel
 export type TTypeScript = typeof _ts
+export type TEsBuild = typeof _esbuild
 /**
  * @internal
  */

src/config/config-set.ts

@@ -1,4 +1,5 @@
 import type { TBabelCore, TBabelJest, TTypeScript } from '../types'
+import type { TEsBuild } from '../types'
 
 import { rootLogger } from './logger'
 import { Memoize } from './memoize'
@@ -59,6 +60,10 @@ export class Importer {
     return this._import(why, which)
   }
 
+  esBuild(why: ImportReasons): TEsBuild {
+    return this._import(why, 'esbuild')
+  }
+
   @Memoize((...args: string[]) => args.join(':'))
   tryThese(moduleName: string, ...fallbacks: string[]): RequireResult<true> | undefined {
     let name: string
@@ -119,12 +124,12 @@ export class Importer {
     return unpatched
   }
 
-  protected _import(
+  protected _import<T>(
     why: string,
     moduleName: string,
     { alternatives = [], installTip = moduleName }: ImportOptions = {},
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  ): any {
+  ): T {
     // try to load any of the alternative after trying main one
     const res = this.tryThese(moduleName, ...alternatives)
     // if we could load one, return it

src/types.ts

@@ -47,6 +47,7 @@ export const enum Deprecations {
 export const enum ImportReasons {
   TsJest = 'Using "ts-jest" requires this package to be installed.',
   BabelJest = 'Using "babel-jest" requires this package to be installed.',
+  EsBuild = 'Using "esbuild" requires this package to be installed.',
 }
 
 /**