refactor: deprecate RawCompilerOptions interface

DEPRECATIONS

`RawCompilerOptions` is deprecated in favor of `TsConfigJson.CompilerOptions` from `type-fest`

Author: ahnpnl

package-lock.json

@@ -25,8 +25,7 @@
     "prepare": "npm run build",
     "prepublishOnly": "npm run test",
     "preversion": "npm run test",
-    "version": "npm run changelog && git add CHANGELOG.md",
-    "raw:options": "node scripts/generate-raw-compiler-options.js"
+    "version": "npm run changelog && git add CHANGELOG.md"
   },
   "repository": {
     "type": "git",
@@ -59,6 +58,7 @@
     "lodash.memoize": "^4.1.2",
     "make-error": "^1.3.6",
     "semver": "^7.7.1",
+    "type-fest": "^4.37.0",
     "yargs-parser": "^21.1.1"
   },
   "peerDependencies": {
@@ -127,7 +127,6 @@
     "husky": "^9.1.7",
     "jest": "^29.7.0",
     "js-yaml": "^4.1.0",
-    "json-schema-to-typescript": "^13.1.2",
     "lint-staged": "^15.5.0",
     "prettier": "^2.8.8",
     "rimraf": "^5.0.10",

package.json

@@ -1,16 +1,3 @@
-const execa = require('execa')
-
 const { computePackageDigest } = require('./lib/bundle')
-const { generatedPath, rawCompilerOptionsFileName } = require('./lib/paths')
 
-try {
-  execa.sync('git', ['--version'])
-  if (execa.sync('git', ['diff-index', '--name-only', 'HEAD']).stdout.includes(rawCompilerOptionsFileName)) {
-    throw new Error(
-      `Tsconfig options have changed. Please check the modified generated ${generatedPath} and commit the change`
-    )
-  }
-} catch {
-  console.log('git command is not available. Skip checking generated types')
-}
 computePackageDigest()

scripts/generate-raw-compiler-options.js

@@ -1 +1,2 @@
 export * from './paths-to-module-name-mapper'
+export * from './types'

scripts/post-build.js

@@ -0,0 +1,3 @@
+import type { TsConfigJson } from 'type-fest'
+
+export type TsConfigCompilerOptionsJson = TsConfigJson.CompilerOptions

src/config/index.ts

@@ -17,6 +17,7 @@ import { globsToMatcher } from 'jest-util'
 import json5 from 'json5'
 import type * as ts from 'typescript'
 
+import type { TsConfigCompilerOptionsJson } from '../../config/types'
 import { DEFAULT_JEST_TEST_MATCH, JS_JSX_EXTENSIONS } from '../../constants'
 import type { RawCompilerOptions } from '../../raw-compiler-options'
 import * as hoistJestTransformer from '../../transformers/hoist-jest'
@@ -470,7 +471,7 @@ export class ConfigSet {
    * @internal
    */
   private _getAndResolveTsConfig(
-    compilerOptions?: RawCompilerOptions,
+    compilerOptions?: RawCompilerOptions | TsConfigCompilerOptionsJson,
     resolvedConfigFile?: string,
   ): ts.ParsedCommandLine {
     const result = this._resolveTsConfig(compilerOptions, resolvedConfigFile) as ts.ParsedCommandLine
@@ -566,10 +567,15 @@ export class ConfigSet {
    * Load TypeScript configuration. Returns the parsed TypeScript config and any `tsconfig` options specified in ts-jest
    * Subclasses which extend `ConfigSet` can override the default behavior
    */
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  protected _resolveTsConfig(compilerOptions?: RawCompilerOptions, resolvedConfigFile?: string): Record<string, any>
-
-  protected _resolveTsConfig(compilerOptions?: RawCompilerOptions, resolvedConfigFile?: string): ts.ParsedCommandLine {
+  protected _resolveTsConfig(
+    compilerOptions?: RawCompilerOptions | TsConfigCompilerOptionsJson,
+    resolvedConfigFile?: string,
+  ): // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Record<string, any>
+  protected _resolveTsConfig(
+    compilerOptions?: RawCompilerOptions | TsConfigCompilerOptionsJson,
+    resolvedConfigFile?: string,
+  ): ts.ParsedCommandLine {
     let config = { compilerOptions: Object.create(null) }
     let basePath = normalizeSlashes(this.rootDir)
     const ts = this.compilerModule

src/config/types.ts

@@ -1,3 +1,9 @@
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import type { TsConfigJson } from 'type-fest'
+
+/**
+ * @deprecated This interface will be replaced with {@link TsConfigJson.CompilerOptions} in the next major release.
+ */
 export interface RawCompilerOptions {
   /**
    * Enable importing files with any extension, provided a declaration file is present.

src/legacy/config/config-set.ts

@@ -4,6 +4,7 @@ import type * as babelJest from 'babel-jest'
 import type * as _babel from 'babel__core'
 import type * as _ts from 'typescript'
 
+import type { TsConfigCompilerOptionsJson } from './config/types'
 import {
   ESM_JS_TRANSFORM_PATTERN,
   ESM_TS_JS_TRANSFORM_PATTERN,
@@ -57,7 +58,7 @@ export interface ConfigCustomTransformer {
 }
 
 /**
- * @deprecated use `TsJestTransformerOptions` instead
+ * @deprecated use {@link TsJestTransformerOptions} instead
  */
 export interface TsJestGlobalOptions {
   /**
@@ -67,23 +68,27 @@ export interface TsJestGlobalOptions {
    * - `path/to/tsconfig.json`: path to a specific tsconfig file (<rootDir> can be used)
    * - `{...}`: an object with inline compiler options
    *
-   * @default undefined uses the default tsconfig file
+   * @default `undefined` (the default config file will be used if it exists)
+   *
+   * @remarks
+   *
+   * {@link RawCompilerOptions} will be replaced with {@link TsConfigCompilerOptionsJson} in the next major release
    */
-  tsconfig?: boolean | string | RawCompilerOptions
+  tsconfig?: boolean | string | RawCompilerOptions | TsConfigCompilerOptionsJson
 
   /**
-   * @deprecated use `isolatedModules` in `tsconfig` instead
+   * @deprecated use {@link TsConfigCompilerOptionsJson.isolatedModules} instead
    *
    * Compiles files as isolated modules (disables some features)
    *
-   * @default undefined (disabled)
+   * @default `undefined` (disables transpiling files with {@link _ts.transpileModule})
    */
   isolatedModules?: boolean
 
   /**
    * Compiler to use
    *
-   * @default 'typescript'
+   * @default `typescript`
    */
   compiler?: 'typescript' | 'ttypescript' | string
 
@@ -98,23 +103,23 @@ export interface TsJestGlobalOptions {
    * - `false`: hide diagnostics of all files (kind of useless)
    * - `{...}`: an inline object with fine grained settings
    *
-   * @default undefined shows all diagnostics
+   * @default `undefined`
    */
   diagnostics?:
     | boolean
     | {
         /**
          * Enables colorful and pretty output of errors
          *
-         * @default undefined (enabled)
+         * @default `undefined` (enables formatting errors)
          */
         pretty?: boolean
         /**
          * List of TypeScript diagnostic error codes to ignore
          * [here](https://github.com/Microsoft/TypeScript/blob/master/src/compiler/diagnosticMessages.json).
          *
          * @see https://github.com/Microsoft/TypeScript/blob/master/src/compiler/diagnosticMessages.json
-         * @default [6059,18002,18003]
+         * @default `[6059,18002,18003]`
          */
         ignoreCodes?: number | string | Array<number | string>
         /**
@@ -124,7 +129,7 @@ export interface TsJestGlobalOptions {
         /**
          * Logs TypeScript errors to stderr instead of throwing exceptions
          *
-         * @default undefined (disabled)
+         * @default `undefined` (TypeScript errors will be thrown as exceptions)
          */
         warnOnly?: boolean
       }
@@ -136,7 +141,7 @@ export interface TsJestGlobalOptions {
    * - `path/to/.babelrc`: path to a babelrc file (<rootDir> can be used)
    * - `{...}`: an object with inline babel options
    *
-   * @default undefined does NOT use babel
+   * @default `undefined` (not using `Babel`)
    */
   babelConfig?: boolean | string | BabelConfig