Troubleshooting

During your development with ts-jest, you may encounter various issues. Use this guide to resolve them.

Please also check Jest troubleshooting guide if your issue is related to jest.

Running ts-jest on CI tools

PROBLEM

Cannot find module "" from ""

SOLUTION

• Check if rootDir is referenced correctly. If not add this on your existing jest configuration.

module.exports = {
  ...
   roots: ["<rootDir>"]
}

• Check if module directories are included on your jest configuration. If not add this on your existing jest configuration.

module.exports = {
  ...
  moduleDirectories: ["node_modules","<module-directory>"],
  modulePaths: ["<path-of-module>"],
}

• Check if module name is properly mapped and can be referenced by jest. If not, you can define moduleNameMapper for your jest configuration.

module.exports = {
  ...
  moduleNameMapper: {
    "<import-path>": "<rootDir>/<real-physical-path>",
  },
}

• Check github folder names if its identical to you local folder names. Sometimes github never updates your folder names even if you rename it locally. If this happens rename your folders via github or use this command git mv <source> <destination> and commit changes.

Transform (node)-module explicitly

PROBLEM

SyntaxError: Cannot use import statement outside a module

SOLUTION

One of the node modules hasn't the correct syntax for Jests execution step. It needs to be transformed first.

There is a good chance that the error message shows which module is affected:

    SyntaxError: Cannot use import statement outside a module
    > 22 | import Component from "../../node_modules/some-module/lib";
         | ^

In this case some-module is the problem and needs to be transformed. By adding the following line to the configuration file it will tell Jest which modules shouldnt be ignored during the transformation step:

module.exports = {
  ...
  transformIgnorePatterns: ["node_modules/(?!(some-module|another-module))"]
};

some-module and another-module will be transformed.

For more information see here and here.

Tests gets stuck when importing a dependency

PROBLEM

Without cache, jest takes an extremely long time to process files and appears to be stuck.

SOLUTION

ts-jest internally uses TypeScript compiler API to transform ts/js file into js file. The recommendation is to only transform what is needed.

A possible cause for that issue is that you may have enabled ts-jest to process javascript files in addition to TypeScript files. This leads to the result that more files are loaded which can, in some cases, blow up the machine.

• In your tsconfig file, check if compilerOptions.allowJs is unset or set to false.

{
  "compilerOptions": {
    "allowJs": false,
  }
}

• In your jest configuration, check if the transform property includes only .ts files for ts-jest. If not, change the regular expression to exclude js files. You can also add the attribute isolatedModules: true for ts-jest to disable type checking for tests.

module.exports = {
  ...
  'transform': {
-    '^.+\\.(t|j)s$': ['ts-jest', {}],
+    '^.+\\.ts$': ['ts-jest', { isolatedModules: true }],
  },
};

For more information see here