fix: big refactor + fixes (mainly cache key + coverage)

Author: huafu

index.d.ts

@@ -1,18 +1,18 @@
 {
   "name": "ts-jest",
   "version": "23.0.1",
-  "main": "index.js",
+  "main": "dist/index.js",
   "types": "./dist/index.d.ts",
   "description": "A preprocessor with sourcemap support to help use Typescript with Jest",
   "scripts": {
-    "build": "cpx index.d.ts dist/ && tsc -p .",
-    "build:watch": "cpx index.d.ts dist/ && tsc -p . -w",
+    "build": "tsc -p tsconfig.build.json",
+    "build:watch": "tsc -p tsconfig.build.json -w",
     "test:nolint": "npm run clean-build && node scripts/tests.js",
-    "clean": "rimraf dist/**/* && rimraf tests/simple/coverage && rimraf tests/simple-async/coverage && rimraf tests/**/*/debug.txt && rimraf tests/**/node_modules",
+    "clean": "rimraf dist/**/* && rimraf tests/*/coverage && rimraf tests/*/debug.txt && rimraf tests/*/node_modules",
     "clean-build": "npm run clean && npm run build",
     "pretest": "npm run tslint && npm run clean-build",
     "test": "node scripts/tests.js",
-    "tslint": "tslint src/*.ts",
+    "tslint": "tslint src/**/*.ts",
     "doc": "doctoc .",
     "prepublish": "npm run clean-build",
     "precommit": "lint-staged",
@@ -38,7 +38,7 @@
   "homepage": "https://github.com/kulshekhar/ts-jest#readme",
   "jest": {
     "transform": {
-      "^.+\\.tsx?$": "<rootDir>/dist/preprocessor.js"
+      "^.+\\.tsx?$": "<rootDir>/dist/index.js"
     },
     "testRegex": "tests/__tests__/.*\\.spec\\.ts$",
     "testPathIgnorePatterns": [

index.js

@@ -25,16 +25,6 @@ function createIntegrationMock() {
     const rootDir = path.resolve('.');
     const testCaseModuleFolder = path.join(testCaseNodeModules, 'ts-jest');
 
-    // Copy javascript files
-    fs.copySync(
-      path.resolve(rootDir, 'index.js'),
-      path.resolve(testCaseModuleFolder, 'index.js')
-    );
-    fs.copySync(
-      path.resolve(rootDir, 'preprocessor.js'),
-      path.resolve(testCaseModuleFolder, 'preprocessor.js')
-    );
-
     // Copy package.json
     fs.copySync(
       path.resolve(rootDir, 'package.json'),

package.json

@@ -0,0 +1,35 @@
+// structure of this file heavilly inspired on:
+// https://github.com/facebook/jest/blob/master/packages/babel-jest/src/index.js
+
+import jestPreset from 'babel-preset-jest';
+import getCacheKeyForArgs from './utils/get-cache-key';
+import { TsJestContext, JestCacheKeyArguments } from './types';
+import preprocess from './preprocess';
+
+const createTransformer = (options?: any): jest.Transformer => {
+  const cache = Object.create(null);
+
+  options = Object.assign({}, options, {
+    compact: false,
+    plugins: (options && options.plugins) || [],
+    presets: ((options && options.presets) || []).concat([jestPreset]),
+    sourceMaps: 'both',
+  });
+  delete options.cacheDirectory;
+  delete options.filename;
+
+  const context: TsJestContext = { cache, options };
+
+  const getCacheKey = (...args: any[]) =>
+    getCacheKeyForArgs(args as JestCacheKeyArguments, context);
+
+  return {
+    canInstrument: true,
+    getCacheKey,
+    process: preprocess,
+    createTransformer: undefined as any,
+  };
+};
+
+export default createTransformer();
+export { createTransformer };

preprocessor.js

@@ -16,26 +16,24 @@ function importBabelDeps() {
   istanbulPlugin = require('babel-plugin-istanbul').default;
   jestPreset = require('babel-preset-jest');
 }
-import { CompilerOptions } from 'typescript/lib/typescript';
+import { CompilerOptions } from 'typescript';
 import {
   BabelTransformOptions,
-  CodeSourceMapPair,
-  JestConfig,
   PostProcessHook,
-  TransformOptions,
+  JestCacheKeyOptions,
   TsJestConfig,
-} from './jest-types';
-import { logOnce } from './logger';
+} from './types';
+import { logOnce } from './utils/logger';
 
 // Function that takes the transpiled typescript and runs it through babel/whatever.
 export function postProcessCode(
   compilerOptions: CompilerOptions,
-  jestConfig: JestConfig,
+  jestConfig: jest.ProjectConfig,
   tsJestConfig: TsJestConfig,
-  transformOptions: TransformOptions,
-  transpileOutput: CodeSourceMapPair,
+  transformOptions: jest.TransformOptions,
+  transpileOutput: jest.TransformedSource,
   filePath: string,
-): CodeSourceMapPair {
+): jest.TransformedSource {
   const postHook = getPostProcessHook(
     compilerOptions,
     jestConfig,
@@ -58,11 +56,11 @@ function createBabelTransformer(
   delete options.filename;
 
   return (
-    codeSourcemapPair: CodeSourceMapPair,
+    codeSourcemapPair: jest.TransformedSource,
     filename: string,
-    config: JestConfig,
-    transformOptions: TransformOptions,
-  ): CodeSourceMapPair => {
+    config: jest.ProjectConfig,
+    transformOptions: JestCacheKeyOptions,
+  ): jest.TransformedSource => {
     const theseOptions = Object.assign(
       { filename, inputSourceMap: codeSourcemapPair.map },
       options,
@@ -81,17 +79,18 @@ function createBabelTransformer(
         ],
       ]);
     }
-    // Babel has incorrect typings, where the map is an object instead of a string. So we have to typecast it here
-    return (babel.transform(
+
+    // we typecast here because babel returns a more complete object than the one expected by jest
+    return babel.transform(
       codeSourcemapPair.code,
       theseOptions,
-    ) as any) as CodeSourceMapPair;
+    ) as jest.TransformedSource;
   };
 }
 
 export const getPostProcessHook = (
   tsCompilerOptions: CompilerOptions,
-  jestConfig: JestConfig,
+  jestConfig: jest.ProjectConfig,
   tsJestConfig: TsJestConfig,
 ): PostProcessHook => {
   if (tsJestConfig.skipBabel) {

scripts/tests.js

@@ -1,22 +1,14 @@
-import * as crypto from 'crypto';
-import {
-  BabelTransformOptions,
-  CodeSourceMapPair,
-  JestConfig,
-  Path,
-  TransformOptions,
-} from './jest-types';
-import { flushLogs, logOnce } from './logger';
+import { flushLogs, logOnce } from './utils/logger';
 import { postProcessCode } from './postprocess';
 import { getTSConfig, getTSJestConfig, runTsDiagnostics } from './utils';
 import { transpileTypescript } from './transpiler';
 
-export function process(
+export default function preprocess(
   src: string,
-  filePath: Path,
-  jestConfig: JestConfig,
-  transformOptions: TransformOptions = { instrument: false },
-): CodeSourceMapPair | string {
+  filePath: jest.Path,
+  jestConfig: jest.ProjectConfig,
+  transformOptions: jest.TransformOptions,
+): jest.TransformedSource | string {
   // transformOptions.instrument is a proxy for collectCoverage
   // https://github.com/kulshekhar/ts-jest/issues/201#issuecomment-300572902
   const compilerOptions = getTSConfig(jestConfig.globals, jestConfig.rootDir);
@@ -28,7 +20,7 @@ export function process(
   const isHtmlFile = /\.html$/.test(filePath);
 
   // This is to support angular 2. See https://github.com/kulshekhar/ts-jest/pull/145
-  if (isHtmlFile && jestConfig.globals.__TRANSFORM_HTML__) {
+  if (isHtmlFile && (jestConfig.globals as any).__TRANSFORM_HTML__) {
     src = 'module.exports=' + JSON.stringify(src) + ';';
   }
 
@@ -76,24 +68,3 @@ export function process(
 
   return { code: outputText.code, map: outputText.map };
 }
-
-/**
- * This is the function Jest uses to check if it has the file already in cache
- */
-export function getCacheKey(
-  fileData: string,
-  filePath: Path,
-  jestConfigStr: string,
-  transformOptions: TransformOptions = { instrument: false },
-): string {
-  const jestConfig: JestConfig = JSON.parse(jestConfigStr);
-
-  const tsConfig = getTSConfig(jestConfig.globals, jestConfig.rootDir);
-
-  return crypto
-    .createHash('md5')
-    .update(JSON.stringify(tsConfig), 'utf8')
-    .update(JSON.stringify(transformOptions), 'utf8')
-    .update(fileData + filePath + jestConfigStr, 'utf8')
-    .digest('hex');
-}

src/index.ts

@@ -1,13 +1,12 @@
 import * as ts from 'typescript';
-import { logOnce } from './logger';
-import { CodeSourceMapPair } from './jest-types';
+import { logOnce } from './utils/logger';
 
 // Takes the typescript code and by whatever method configured, makes it into javascript code.
 export function transpileTypescript(
   filePath: string,
   fileSrc: string,
   compilerOptions: ts.CompilerOptions,
-): CodeSourceMapPair {
+): jest.TransformedSource {
   logOnce('Compiling via normal transpileModule call');
   const transpileOutput = transpileViaTranspileModule(
     filePath,