feat(config): support typed config options for jest config typescript (#2335)

Author: ahnpnl

e2e/__cases__/typings/jest-config-typings.spec.ts

@@ -0,0 +1,14 @@
+import type {InitialOptionsTsJest} from 'ts-jest/dist/types'
+
+test('Typings for jest config to support full TypeScript mode', () => {
+  const config: InitialOptionsTsJest = {
+    globals: {
+      'ts-jest': {
+        isolatedModules: true,
+      }
+    },
+    verbose: true,
+  };
+
+  expect(config).toBeTruthy()
+})

e2e/__tests__/ts-jest-typings.test.ts

@@ -0,0 +1,13 @@
+import { PackageSets } from '../__helpers__/templates'
+import { configureTestCase } from '../__helpers__/test-case'
+
+describe('ts-jest utils', () => {
+  const testCase = configureTestCase('typings')
+
+  testCase.runWithTemplates([PackageSets.default], 0, (runTest, { testLabel }) => {
+    it(testLabel, () => {
+      const result = runTest()
+      expect(result.status).toBe(0)
+    })
+  })
+})

src/types.ts

@@ -139,6 +139,14 @@ export interface TsJestGlobalOptions {
   useESM?: boolean
 }
 
+export interface GlobalConfigTsJest extends Config.ConfigGlobals {
+  'ts-jest': TsJestGlobalOptions
+}
+
+export interface InitialOptionsTsJest extends Config.InitialOptions {
+  globals?: GlobalConfigTsJest
+}
+
 interface TsJestConfig$tsConfig$file {
   kind: 'file'
   value: string | undefined
@@ -189,6 +197,7 @@ export interface TransformOptionsTsJest extends TransformOptions {
 }
 
 export type ResolvedModulesMap = Map<string, _ts.ResolvedModuleFull | undefined> | undefined
+
 /**
  * @internal
  */

website/docs/getting-started/installation.md

@@ -29,7 +29,7 @@ Tip: If you get an error with the following `npm` commands such as `npx: command
 
 #### Creating
 
-By default Jest can run without any config files, but it will not compile `.ts` files.
+By default, Jest can run without any config files, but it will not compile `.ts` files.
 To make it transpile TypeScript with `ts-jest`, we will need to create a configuration file that will tell Jest to use a `ts-jest` preset.
 
 `ts-jest` can create the configuration file for you automatically:

website/docs/getting-started/options.md

@@ -5,22 +5,11 @@ title: Options
 
 ### Introduction
 
-All `ts-jest` specific options are located under the `globals.ts-jest` path of your Jest config:
-
-```js
-// jest.config.js
-module.exports = {
-  // [...]
-  globals: {
-    'ts-jest': {
-      // ts-jest configuration goes here
-    },
-  },
-}
-```
+All `ts-jest` specific options are located under the `globals` of Jest config object in the `package.json` file of your project,
+or through a `jest.config.js`, or `jest.config.ts` file.
 
 ```json
-// OR package.json
+// package.json
 {
   // [...]
   "jest": {
@@ -33,23 +22,50 @@ module.exports = {
 }
 ```
 
-#### IDE `ts-jest` config suggestion
+Or through JavaScript:
+
+```js
+// jest.config.js
+module.exports = {
+  // [...]
+  globals: {
+    'ts-jest': {
+      // ts-jest configuration goes here
+    },
+  },
+}
+```
+
+:::tip
 
 To utilize IDE suggestions, you can use `JSDoc` comments to provide suggested `ts-jest` configs for your Jest config:
 
 ```js
-/** @typedef {import('ts-jest/dist/types')} */
-/** @type {import('@jest/types').Config.InitialOptions} */
-const config = {
+/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = config = {
   // [...]
   globals: {
     'ts-jest': {
       // ts-jest configuration goes here and your IDE will suggest which configs when typing
     },
   },
 }
+```
+
+:::
+
+Or through TypeScript (if `ts-node` is installed):
 
-module.exports = config
+```ts
+// jest.config.ts
+import type { InitialOptionsTsJest } from 'ts-jest/dist/types'
+
+const config: InitialOptionsTsJests = {
+  'ts-jest': {
+    // ts-jest configuration goes here
+  },
+}
+export default config
 ```
 
 ### Options

website/src/pages/index.js

@@ -19,7 +19,7 @@ const features = [
   },
   {
     title: 'Babel support',
-    description: <>Working seamlessly with Babel</>,
+    description: <>Support working in combination with Babel</>,
   },
 ]
 

website/versioned_docs/version-26.5/getting-started/options.md

@@ -5,22 +5,11 @@ title: Options
 
 ### Introduction
 
-All `ts-jest` specific options are located under the `globals.ts-jest` path of your Jest config:
-
-```js
-// jest.config.js
-module.exports = {
-  // [...]
-  globals: {
-    'ts-jest': {
-      // ts-jest configuration goes here
-    },
-  },
-}
-```
+All `ts-jest` specific options are located under the `globals` of Jest config object in the `package.json` file of your project,
+or through a `jest.config.js`, or `jest.config.ts` file.
 
 ```json
-// OR package.json
+// package.json
 {
   // [...]
   "jest": {
@@ -33,25 +22,39 @@ module.exports = {
 }
 ```
 
-#### IDE `ts-jest` config suggestion
+Or through JavaScript:
+
+```js
+// jest.config.js
+module.exports = {
+  // [...]
+  globals: {
+    'ts-jest': {
+      // ts-jest configuration goes here
+    },
+  },
+}
+```
+
+:::tip
 
 To utilize IDE suggestions, you can use `JSDoc` comments to provide suggested `ts-jest` configs for your Jest config:
 
 ```js
 /** @typedef {import('ts-jest/dist/types')} */
 /** @type {import('@jest/types').Config.InitialOptions} */
-const config = {
+module.exports = config = {
   // [...]
   globals: {
     'ts-jest': {
       // ts-jest configuration goes here and your IDE will suggest which configs when typing
     },
   },
 }
-
-module.exports = config
 ```
 
+:::
+
 ### Options
 
 All options have default values which should fit most of the projects. Click on the option's name to see details and example(s).

website/versioned_docs/version-26.5/guides/esm-support.md

@@ -5,6 +5,6 @@ title: ESM Support
 
 :::important
 
-ESM support is only available in **v27**
+ESM support is only available in **v27++**
 
 :::