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?

Édouard Lopez · Accepted Answer · 2021-03-10 09:26:21Z

85

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, 2021 at 9:26

Édouard Lopez

43.7k30 gold badges134 silver badges190 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Abner Over a year ago

It helped me a lot in my case my ts path was "@data/*": ["src/data/*"] then in my jest config i added: '@data/(.*)': '<rootDir>/src/data/$1',

kodmanyagha Over a year ago

If you set rootDir to src then you don't need to remove src from here.

user2976753 · Accepted Answer · 2024-12-16 00:00:01Z

44

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, { prefix: "<rootDir>" }),
  modulePaths: ['<rootDir>'],
  coverageDirectory: '../coverage',
  moduleFileExtensions: ['js', 'json', 'ts'],
  testRegex: '.*\\.spec\\.ts$',
  transform: { '^.+\\.(t|j)s$': 'ts-jest' },
  collectCoverageFrom: ['**/*.(t|j)s'],
};

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

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

edited Dec 16, 2024 at 0:00

user2976753

96811 silver badges25 bronze badges

answered Jun 15, 2021 at 17:16

FranSanchis

1,70916 silver badges16 bronze badges

7 Comments

Shivam Sahil Over a year ago

what is ts-jest/utils?

BryceCicada Over a year ago

const { pathsToModuleNameMapper } = require('ts-jest'). See kulshekhar.github.io/ts-jest/docs/getting-started/paths-mapping/…

Kevin Beal Over a year ago

No longer works

Elias Rabl Over a year ago

I had to add the prefix parameter to get it to work: pathsToModuleNameMapper(compilerOptions.paths, { prefix: "<rootDir>" }).

Kirill Glazunov Over a year ago

A baseUrl should be took in account: { prefix: `<rootDir>${compilerOptions.baseUrl}` }

|

0Valt · Accepted Answer · 2022-05-01 22:13:25Z

32

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 1, 2022 at 22:13

0Valt

10.5k9 gold badges41 silver badges66 bronze badges

answered Oct 17, 2018 at 18:53

OJ Kwon

4,6911 gold badge25 silver badges26 bronze badges

1 Comment

Novaterata Over a year ago

Link only answers are discouraged

Aran Tamool · Accepted Answer · 2023-02-16 03:20:28Z

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/*"]
    }

sudo-rm-rf · Accepted Answer · 2024-03-19 19:49:40Z

4

tsconfig.json

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

package.json (for unit test)

"jest": {
  "rootDir": ".",
  "testRegex": "/test/.*\\.spec\\.ts$",
  "moduleNameMapper": {
    "@/(.*)": "<rootDir>/src/$1"
  }
}

jest-e2e.json (for e2e test)

{
  "rootDir": "../",
  "testRegex": "/test/.*\\.e2e-spec\\.ts$",
  "moduleNameMapper": {
    "@/(.*)": "<rootDir>/src/$1"
  }
}

answered Mar 19, 2024 at 19:49

sudo-rm-rf

412 bronze badges

1 Comment

Community Over a year ago

As it’s currently written, your answer is unclear. Please edit to add additional details that will help others understand how this addresses the question asked. You can find more information on how to write good answers in the help center.

Juri Sinitson · Accepted Answer · 2024-11-22 12:16:07Z

For me Jest complained that it can't find the module e.g. project/feature-1 in an angular 18 project.

I needed to do the mapping 3 times to make it work:

In the tsconfig.json
In the tsconfig.spec.json
In the jest.config.ts

Here's what worked for me: tsconfig.json and tsconfig.spec.json:

"paths": {                                          
  "project/*": ["./packages/project/src/*/public_api"],
},

jest.config.ts:

import type { Config } from 'jest';

const config: Config = {
    preset: 'jest-preset-angular',
    moduleNameMapper: {
        '^project/(.*)': '<rootDir>/packages/project/src/$1/public_api'
    },
    setupFilesAfterEnv: ['<rootDir>/setup-jest.ts']
};

export default config;

For the sake of completeness also the setup-jest.ts:

import { setupZoneTestEnv } from 'jest-preset-angular/setup-env/zone';

setupZoneTestEnv();

Collectives™ on Stack Overflow

Typescript paths not resolving when running jest?

6 Answers 6

tsconfig.json

jest config

2 Comments

7 Comments

1 Comment

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

6 Answers 6

tsconfig.json

jest config

2 Comments

7 Comments

1 Comment

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related