Merge pull request #652 from huafu/hotfix/babel-and-preprocess-bridges

[HOTFIX] babel and preprocess.js bridges

Author: kulshekhar

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-jest",
-  "version": "23.1.0",
+  "version": "23.1.1",
   "main": "dist/index.js",
   "types": "./dist/index.d.ts",
   "description": "A preprocessor with sourcemap support to help use Typescript with Jest",
@@ -81,16 +81,17 @@
     "@babel/core": "^7.0.0-beta.54",
     "@babel/preset-env": "^7.0.0-beta.54",
     "@types/babel-core": "^6.25.5",
+    "@types/babel__core": "^7.0.1",
     "@types/es6-shim": "0.31.37",
     "@types/fs-extra": "5.0.4",
     "@types/jest": "^23.3.0",
     "@types/lodash": "^4.14.109",
     "@types/node": "10.5.5",
     "@types/react": "16.4.7",
     "@types/yargs": "^11.0.0",
+    "babel-core": "^7.0.0-0",
     "babel-jest": "^23.4.0",
     "babel-preset-jest": "^23.2.0",
-    "babel-core": "^7.0.0-0",
     "cpx": "^1.5.0",
     "cross-spawn": "latest",
     "cross-spawn-with-kill": "latest",
@@ -118,5 +119,8 @@
       "prettier --write --single-quote --trailing-comma all",
       "git add"
     ]
+  },
+  "engines": {
+    "node": ">= 6"
   }
 }

package.json

@@ -0,0 +1,7 @@
+console.warn(
+  `[ts-jest][DEPRECATED] - replace any occurrences of "ts-jest/dist/preprocessor.js" or ` +
+    ` "<rootDir>/node_modules/ts-jest/preprocessor.js"` +
+    ` in the 'transform' section of your Jest config with just "ts-jest".`
+);
+
+module.exports = require('./dist');

preprocessor.js

@@ -39,6 +39,13 @@ function createIntegrationMock() {
       path.resolve(testCaseModuleFolder, 'package.json')
     );
 
+    // TODO: remove this in next major version as well as the test, and the preprocessor.js file in root
+    // Copy preprocessor.js
+    fs.copySync(
+      path.resolve(rootDir, 'preprocessor.js'),
+      path.resolve(testCaseModuleFolder, 'preprocessor.js')
+    );
+
     // Copy dist folder
     fs.copySync(
       path.resolve(rootDir, 'dist'),

scripts/tests.js

@@ -2,27 +2,32 @@
  * Postprocess step. Based on babel-jest: https://github.com/facebook/jest/blob/master/packages/babel-jest/src/index.js
  * https://github.com/facebook/jest/blob/9b157c3a7c325c3971b2aabbe4c8ab4ce0b0c56d/packages/babel-jest/src/index.js
  */
-import * as __types__babel from 'babel-core';
-import __types__istanbulPlugin from 'babel-plugin-istanbul';
-import * as __types__jestPreset from 'babel-preset-jest';
 import {
   BabelTransformOptions,
   PostProcessHook,
-  JestCacheKeyOptions,
+  TBabel,
+  TBabelPluginIstanbul,
+  TBabelPresetJest,
 } from './types';
 import { logOnce } from './utils/logger';
 import getTSJestConfig from './utils/get-ts-jest-config';
+import {
+  importBabelCore,
+  importBabelPluginIstanbul,
+  importBabelPresetJest,
+} from './utils/imports';
+import { TransformOptions } from '@babel/core';
 
-let babel: typeof __types__babel;
-let istanbulPlugin: typeof __types__istanbulPlugin;
-let jestPreset: typeof __types__jestPreset;
+let babel: TBabel;
+let istanbulPlugin: TBabelPluginIstanbul;
+let jestPreset: TBabelPresetJest;
 
 function importBabelDeps() {
   if (babel) return; // tslint:disable-line
   // we must use babel until we handle hoisting of jest.mock() internally
-  babel = require('@babel/core');
-  istanbulPlugin = require('babel-plugin-istanbul').default;
-  jestPreset = require('babel-preset-jest');
+  babel = importBabelCore();
+  istanbulPlugin = importBabelPluginIstanbul();
+  jestPreset = importBabelPresetJest();
 }
 
 // Function that takes the transpiled typescript and runs it through babel/whatever.
@@ -62,13 +67,17 @@ function createBabelTransformer(
     codeSourcemapPair: jest.TransformedSource,
     filename: string,
     config: jest.ProjectConfig,
-    transformOptions: JestCacheKeyOptions,
+    transformOptions: jest.TransformOptions,
   ): jest.TransformedSource => {
     const inputSourceMap =
       typeof codeSourcemapPair.map === 'string'
         ? JSON.parse(codeSourcemapPair.map)
         : codeSourcemapPair.map;
-    const theseOptions = { ...optionsBase, filename, inputSourceMap };
+    const theseOptions = {
+      ...optionsBase,
+      filename,
+      inputSourceMap,
+    } as TransformOptions;
     if (transformOptions && transformOptions.instrument) {
       theseOptions.auxiliaryCommentBefore = ' istanbul ignore next ';
       // Copied from jest-runtime transform.js

src/postprocess.ts

@@ -1,5 +1,15 @@
 import { TransformOptions as BabelTransformOpts } from 'babel-core';
 
+import * as _babel from '@babel/core';
+import * as _babelEnv from '@babel/preset-env';
+import * as _babelJest from 'babel-preset-jest';
+import _babelIstanbul from 'babel-plugin-istanbul';
+
+export type TBabel = typeof _babel;
+export type TBabelPluginIstanbul = typeof _babelIstanbul;
+export type TBabelPresetEnv = typeof _babelEnv;
+export type TBabelPresetJest = typeof _babelJest;
+
 export interface JestCacheKeyOptions {
   rootDir: string;
   instrument: boolean;

src/types.ts

@@ -109,7 +109,7 @@ function findTSConfigPath(
       `${jestConfig.rootDir}${sep}`,
     );
     // ensure the path is resolved
-    if (!tsConfigFile.startsWith('/')) {
+    if (!tsConfigFile.startsWith('/') && jestConfig.rootDir) {
       tsConfigFile = resolve(jestConfig.rootDir, tsConfigFile);
     } else {
       tsConfigFile = resolve(tsConfigFile);

src/utils/get-ts-config.ts

@@ -0,0 +1,57 @@
+import {
+  TBabel,
+  TBabelPresetEnv,
+  TBabelPluginIstanbul,
+  TBabelPresetJest,
+} from '../types';
+
+export function importBabelCore(): TBabel {
+  const mod = tryRequire('@babel/core') || tryRequire('babel-core');
+  if (!mod) {
+    throw new Error(
+      `[ts-jest] You must install the '@babel/core' or 'babel-core'` +
+        ` package (depending on the version you want to use).`,
+    );
+  }
+  return mod;
+}
+
+export function importBabelPresetEnv(): TBabelPresetEnv {
+  const mod = tryRequire('@babel/preset-env') || tryRequire('babel-preset-env');
+  if (!mod) {
+    throw new Error( // babel-jest has the env preset as a dep
+      `[ts-jest] You must install the 'babel-jest' package if you're using babel.`,
+    );
+  }
+  return mod;
+}
+
+export function importBabelPresetJest(): TBabelPresetJest {
+  const mod = tryRequire('babel-preset-jest');
+  if (!mod) {
+    throw new Error( // babel-jest has the jest preset as a dep
+      `[ts-jest] You must install the 'babel-jest' package if you're using babel.`,
+    );
+  }
+  return mod;
+}
+
+export function importBabelPluginIstanbul(): TBabelPluginIstanbul {
+  const mod = tryRequire('babel-plugin-istanbul');
+  if (!mod) {
+    throw new Error( // babel-jest has the istanbul plugin as a dep
+      `[ts-jest] You must install the 'babel-jest' package if you're using babel.`,
+    );
+  }
+  return mod.default;
+}
+
+function tryRequire<T = any>(packageName: string): T | void {
+  let mod: T;
+  try {
+    mod = require(packageName);
+  } catch (err) {
+    if (err.code !== 'ENOENT') throw err; // tslint:disable-line
+  }
+  return mod;
+}

src/utils/imports.ts

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Deprecated Jest transform value should log the depration message 1`] = `"[ts-jest][DEPRECATED] - replace any occurrences of \\"ts-jest/dist/preprocessor.js\\" or  \\"<rootDir>/node_modules/ts-jest/preprocessor.js\\" in the 'transform' section of your Jest config with just \\"ts-jest\\"."`;

tests/__tests__/__snapshots__/deprecated-transform.spec.ts.snap

@@ -0,0 +1,14 @@
+import runJest from '../__helpers__/runJest';
+
+describe('Deprecated Jest transform value', () => {
+  it('should log the depration message', () => {
+    const result = runJest('../deprecated-transform', ['--no-cache']);
+
+    const output = result.stderr;
+
+    // get only the line with deprecation message (we dont want the snapshot to contain any timing or test name)
+    const msg = output.split('\n').find(line => /deprecated/i.test(line));
+
+    expect(msg).toMatchSnapshot();
+  });
+});