feat: link jest config types on npx ts-jest:init (#2742)

kulshekhar · Jul 11, 2021 · f51ba05 · f51ba05
1 parent 48d105f
commit f51ba05
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/cli/cli.spec.ts b/src/cli/cli.spec.ts
@@ -135,7 +135,8 @@ Jest configuration written to "${normalize('/foo/bar/jest.config.js')}".
       expect(fs.writeFileSync.mock.calls).toEqual([
         [
           normalize('/foo/bar/jest.config.js'),
-          `module.exports = {
+          `/** @type {import('@ts-jest/dist/types').InitialOptionsTsJest} */
+module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
 };`,
@@ -158,6 +159,7 @@ Jest configuration written to "${normalize('/foo/bar/jest.config.foo.js')}".
           normalize('/foo/bar/jest.config.foo.js'),
           `const { jsWithTs: tsjPreset } = require('ts-jest/presets');
 
+/** @type {import('@ts-jest/dist/types').InitialOptionsTsJest} */
 module.exports = {
   ...tsjPreset,
   globals: {

diff --git a/src/cli/config/init.ts b/src/cli/config/init.ts
@@ -90,6 +90,7 @@ export const run: CliCommand = async (args: Arguments /* , logger: Logger */) =>
     if (!jestPreset) {
       content.push(`${preset.jsImport('tsjPreset')};`, '')
     }
+    content.push(`/** @type {import('@ts-jest/dist/types').InitialOptionsTsJest} */`)
     content.push('module.exports = {')
     if (jestPreset) {
       content.push(`  preset: '${preset.name}',`)