Merge pull request #787 from huafu/fix-testing-utils

Fix testing utils & cache digest & docs related to presets

Author: huafu

README.md

@@ -30,7 +30,7 @@ These instructions will get you setup to use `ts-jest` in your project. For more
 | | using npm | using yarn |
 |---:|---|---|
 | **Prerequisites** | `npm i -D jest typescript` | `yarn add --dev jest typescript` |
-| **Installing** | `npm i -D ts-jest` | `yarn add --dev ts-jest` |
+| **Installing** | `npm i -D ts-jest @types/jest` | `yarn add --dev ts-jest @types/jest` |
 | **Creating config** | `node_modules/.bin/ts-jest config:init` | `yarn ts-jest config:init` |
 | **Running tests** | `npm t` or `node_modules/.bin/jest` | `yarn test` or `yarn jest` |
 

docs/user/config/index.md

@@ -54,20 +54,18 @@ module.exports = {
 
 Any preset can also be used with other options.
 If you're already using another preset, you might want only some specific settings from the chosen `ts-jest` preset.
-In this case you'll need to use the JavaScript version of Jest config:
+In this case you'll need to use the JavaScript version of Jest config (comment/uncomment according to your use-case):
 
 ```js
 // jest.config.js
-const tsJestPresets = require('ts-jest/presets');
-
-const preset = tsJestPresets.defaults
-// const preset = tsJestPresets.jsWithTs
-// const preset = tsJestPresets.jsWithBabel
+const { defaults: tsjPreset } = require('ts-jest/presets');
+// const { jsWithTs: tsjPreset } = require('ts-jest/presets');
+// const { jsWithBabel: tsjPreset } = require('ts-jest/presets');
 
 module.exports = {
   // [...]
   transform: {
-    ...preset.transform,
+    ...tsjPreset.transform,
     // [...]
   }
 }
@@ -133,7 +131,7 @@ module.exports = {
 
 ```js
 // jest.config.js
-const { pathsToModuleNameMapper } = require('ts-jest');
+const { pathsToModuleNameMapper } = require('ts-jest/utils');
 // In the following statement, replace `./tsconfig` with the path to your `tsconfig` file
 // which contains the path mapping (ie the `compilerOptions.paths` option):
 const { compilerOptions } = require('./tsconfig');

docs/user/config/stringifyContentPathRegex.md

@@ -18,16 +18,17 @@ In the `jest.config.js` version, you could do as in the `package.json` version o
 
 ```js
 // jest.config.js
-const { jestPreset } = require('ts-jest');
+// Here `defaults` can be replaced with any other preset
+const { defaults: tsjPreset } = require('ts-jest/presets');
 
 module.exports = {
   // [...]
   moduleFileExtensions: [
-    ...jestPreset.moduleFileExtensions,
+    ...tsjPreset.moduleFileExtensions,
     'html'
   ],
   transform: {
-    ...jestPreset.transform,
+    ...tsjPreset.transform,
     '\\.html$': 'ts-jest'
   }
   globals: {

docs/user/install.md

@@ -13,15 +13,15 @@ You can install `ts-jest` and dependencies all at once with the following comman
 Using `npm`:
 
 ```sh
-npm install --save-dev jest typescript ts-jest
+npm install --save-dev jest typescript ts-jest @types/jest
 ```
 
 </div><div class="col-md-6" markdown="block">
 
 Using `yarn`:
 
 ```sh
-yarn add --dev jest typescript ts-jest
+yarn add --dev jest typescript ts-jest @types/jest
 ```
 
 </div></div>
@@ -55,7 +55,7 @@ yarn ts-jest config:init
 This will create a basic Jest configuration file which will make Jest know about your `.ts` files and handle them correctly.
 
 You can also use the `jest --init` command (prefixed with either `npx` or `yarn` depending on what you're using) to have more options related to Jest.
-However, answer `no` to the Jest question about whether or not to enable Typescript. Instead, add the line: `preset: "ts-jest"` to the the `jest.config.js` file afterwards.
+However, answer `no` to the Jest question about whether or not to enable Typescript. Instead, add the line: `preset: "ts-jest"` to the `jest.config.js` file afterwards.
 
 ### Customizing
 

docs/user/react-native/index.md

@@ -25,13 +25,13 @@ In the same way that you moved Babel config, move Jest config from `jest` key of
 
 ```js
 // jest.config.js
-const { jestPreset: tsJest } = require('ts-jest');
+const { defaults: tsjPreset } = require('ts-jest/presets');
 
 module.exports = {
-  ...tsJest,
+  ...tsjPreset,
   preset: 'react-native',
   transform: {
-    ...tsJest.transform,
+    ...tsjPreset.transform,
     '\\.js$': '<rootDir>/node_modules/react-native/jest/preprocessor.js',
   },
   globals: {

docs/user/test-helpers.md

@@ -27,7 +27,7 @@ export const foo = {
 
 ```ts
 // foo.spec.ts
-import { mocked } from 'ts-jest'
+import { mocked } from 'ts-jest/utils'
 import { foo } from './foo'
 jest.mock('./foo')
 

e2e/__cases__/deep/src/Tests/jest.config.js

@@ -1,7 +1,7 @@
 const cfg = {}
 
 if (require('jest/package.json').version.split('.').shift() === '22') {
-  Object.assign(cfg, require('ts-jest').jestPreset)
+  Object.assign(cfg, require('ts-jest/presets').defaults)
 } else {
   cfg.preset = 'ts-jest'
 }

e2e/__cases__/test-helpers/deprecated.spec.ts

@@ -0,0 +1,9 @@
+import { mocked } from 'ts-jest'
+import { foo } from './to-mock'
+jest.mock('./to-mock')
+
+test('foo', () => {
+  foo()
+  // it should log that the helper moved
+  expect(mocked(foo).mock.calls.length).toBe(1)
+})

e2e/__cases__/test-helpers/fail.spec.ts

@@ -1,4 +1,4 @@
-import { mocked } from 'ts-jest'
+import { mocked } from 'ts-jest/utils'
 import { foo, bar } from './to-mock'
 jest.mock('./to-mock')
 

e2e/__cases__/test-helpers/pass.spec.ts

@@ -1,4 +1,4 @@
-import { mocked } from 'ts-jest'
+import { mocked } from 'ts-jest/utils'
 import { foo, bar } from './to-mock'
 jest.mock('./to-mock')