Typescript paths not resolving when running jest?

Question

Attempting to convert this project over to jest using these instructions. I have everything working except for the files that use the paths configuration:

"paths": {
      "@fs/*": ["./src/*"], 
      "@test/*": ["./test/*"]
    }

It looks as if when the tests are run the import statements do not resolve and this is logged:

Cannot find module '@fs/container/validation/ValidationContext' from 'Core.spec.ts'

  1 | import { ValidationOptions } from "@fs/container/validation/ValidationOptions";
> 2 | import { ValidationContext } from "@fs/container/validation/ValidationContext";
    | ^
  3 | import { ValidationContainer } from "@fs/container/validation/ValidationContainer";
  4 | 
  5 | import { Core1 } from "@test/core/Core1";

  at Resolver.resolveModule (node_modules/jest-resolve/build/index.js:221:17)
  at Object.<anonymous> (test/core/Core.spec.ts:2:1)

Is there a way to get jest/ts-jest include the @paths while resolving imports?

score 52 · Answer 1 · answered Mar 10 '21 at 09:26

52

I wanted to resolve modules paths starting with ~/ to my <baseUrl>/<moduleName>.

Thank to OJ Kwon link I solved it with (give him point).

tsconfig.json

see module-resolution path-mapping doc

{
  "compilerOptions": {
    "baseUrl": "src",
    "paths": {
      "~/*": ["*"]
    }
  },
}

jest config

Then we need to tell jest to resolve the paths too. It's done with the following config:

"moduleNameMapper": {
  "~/(.*)": "<rootDir>/src/$1"
},

answered Mar 10 '21 at 09:26

Édouard Lopez

40,270
28
126
178

7

It helped me a lot in my case my ts path was "@data/*": ["src/data/*"] then in my jest config i added: '@data/(.*)': '/src/data/$1', – Abner Feb 02 '22 at 00:53

score 25 · Answer 2 · edited Mar 31 '23 at 19:32

25

Add jest.config.js on root project folder with the content below.

const { pathsToModuleNameMapper } = require('ts-jest')
const { compilerOptions } = require('./tsconfig')
module.exports = {
    preset: 'ts-jest',
    testEnvironment: 'node',
    moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths),
    modulePaths: [
        '<rootDir>'
    ],
}

Also make sure that your tsconfig.json file has a paths field, like this:

{
  "compilerOptions": {
    ....
    "paths": {
      "src/*": ["src/*"]
    }
  },
}

edited Mar 31 '23 at 19:32

darcher

3,052
3
24
29

answered Jun 15 '21 at 17:16

FranSanchis

1,455
14
15

what is ts-jest/utils? – Shivam Sahil Mar 19 '22 at 13:37
2

`const { pathsToModuleNameMapper } = require('ts-jest')`. See https://kulshekhar.github.io/ts-jest/docs/getting-started/paths-mapping/#jest-config-with-helper – BryceCicada Jul 26 '22 at 19:00
This is the best solution to keep your `tsconfig` path resolvers in sync with your Jest config. – laszlo-horvath Sep 19 '22 at 10:24
No longer works – Kevin Beal Oct 20 '22 at 15:22
2

I had to add the `prefix` parameter to get it to work: `pathsToModuleNameMapper(compilerOptions.paths, { prefix: "" })`. – Elias Rabl May 13 '23 at 13:36
A `baseUrl` should be took in account: `{ prefix: \`${compilerOptions.baseUrl}\` }` – Kirill Glazunov Jul 31 '23 at 07:35

score 19 · Accepted Answer · edited May 01 '22 at 22:13

19

jest can't honor tsconfig's path mapping as it's ts compiler time, so jest configuration should have corresponding modulenamemapper to resolve aliased paths.

edited May 01 '22 at 22:13

Oleg Valter is with Ukraine

9,619
8
37
59

answered Oct 17 '18 at 18:53

OJ Kwon

4,385
1
20
24

score 2 · Answer 4 · answered Feb 16 '23 at 03:20

Answer By @FranSanchis did fix the issue for me, I have just done a lot bit of changes to meet with 2023 jest changes

in jest.config.js

const { pathsToModuleNameMapper } = require('ts-jest');
const { compilerOptions } = require('./tsconfig');

module.exports = {
  
  preset: 'ts-jest',
.
.
.
moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths),
  modulePaths: ['<rootDir>'],
}

And in tsconfig

"compilerOptions": {
    "target": "es6",
    "lib": ["dom", "dom.iterable", "esnext"],
    "allowJs": true,
    "skipLibCheck": true,
    "strict": true,
    "forceConsistentCasingInFileNames": true,
    "noEmit": true,
    "esModuleInterop": true,
    "module": "esnext",
    "moduleResolution": "node",
    "resolveJsonModule": true,
    "isolatedModules": true,
    "jsx": "preserve",
    "incremental": true,
    "baseUrl": ".",
    "paths": {
      "@/*": ["src/*"]
    }

Typescript paths not resolving when running jest?

4 Answers4

tsconfig.json

jest config

Linked