@angular-builders/jest

What is @angular-builders/jest?

@angular-builders/jest is an Angular builder that allows you to use Jest as a test runner for Angular projects. It integrates seamlessly with Angular CLI, enabling you to run Jest tests with Angular's build system.

What are @angular-builders/jest's main functionalities?

Running Jest Tests

This configuration allows you to run Jest tests using Angular CLI. By setting the builder to '@angular-builders/jest:run', you can execute Jest tests with the 'ng test' command.

json
{
  "architect": {
    "test": {
      "builder": "@angular-builders/jest:run",
      "options": {}
    }
  }
}

Custom Jest Configuration

You can customize your Jest configuration by adding a 'jest' section in your Angular project's configuration file. This allows you to specify presets, setup files, and other Jest options.

json
{
  "jest": {
    "preset": "jest-preset-angular",
    "setupFilesAfterEnv": ["<rootDir>/src/setup-jest.ts"]
  }
}

Code Coverage

Enabling code coverage is straightforward with @angular-builders/jest. By setting the 'codeCoverage' option to true, you can generate code coverage reports for your Angular project.

json
{
  "architect": {
    "test": {
      "builder": "@angular-builders/jest:run",
      "options": {
        "codeCoverage": true
      }
    }
  }
}

Other packages similar to @angular-builders/jest

jest-preset-angular

jest-preset-angular is a preset that makes it easier to use Jest in Angular projects. It provides a set of configurations and utilities specifically designed for Angular applications. While @angular-builders/jest integrates Jest with Angular CLI, jest-preset-angular focuses on providing a Jest configuration tailored for Angular.

karma

Karma is a test runner that is commonly used with Angular projects. It is the default test runner for Angular CLI. Unlike @angular-builders/jest, which uses Jest, Karma uses a different approach and is often paired with Jasmine for testing.

angular-jest

angular-jest is another package that integrates Jest with Angular. It provides similar functionalities to @angular-builders/jest, such as running Jest tests and generating code coverage. However, it may have different configuration options and integrations.

README

Jest builder for Angular build facade

Allows running ng test with Jest instead of Karma & Jasmine.
The builder comes to provide zero configuration setup for Jest while keeping the workspace clear of boilerplate code.

This documentation is for the latest major version only

Previous versions

Click to expand

• Version 17
• Version 16
• Version 15
• Version 14
• Version 13
• Version 12
• Version 11
• Version 10
• Version 9
• Version 8
• Version 7

Quick guide

Prerequisites

• Angular CLI 18
• Jest 29

Installation

1. Remove Karma related libraries and files:

   $ npm remove karma karma-chrome-launcher karma-coverage-istanbul-reporter karma-jasmine karma-jasmine-html-reporter
   $ rm ./karma.conf.js ./src/test.ts
   

2. Install the builder (and jest if you still haven't):

   $ npm i -D jest @types/jest @angular-builders/jest
   

Updating Typescript configurations

1. In tsconfig.spec.json (root directory, used by Jest):

   • Replace jasmine in types array with jest
     You want your tests to be type-checked against Jest typings and not Jasmine.
   • Remove test.ts entry from files array
     This file was responsible for Karma setup, you don't need it here anymore.

2. In tsconfig.json (root directory, used by IDE):

   • Add jest to types array
     Although you run your unit tests with Jest, Protractor (e2e tests) still has to use Jasmine. Due to this fact it’s possible that you favorite IDE will get confused with the typings and will propose you Jasmine types in unit tests.
     tsconfig.json is the config file that your IDE uses so you have to instruct it explicitly to use Jest typings.
     Bear in mind that the other side of the coin is that your IDE will propose you Jest types in your e2e tests.

Running with Angular CLI

• In your angular.json:

  "projects": {
    "[your-project]": {
      "architect": {
        "test": {
          "builder": "@angular-builders/jest:run",
          "options": {
            // see below
          }
        }
      }
    }
  }
  

• Run the tests: ng test

Multi-projects workspace support

The builder supports multi-project workspaces out of the box, the only thing required is editing tsconfig.spec.json in the relevant project directory as described above.

Builder options

• configPath - path to jest config file, relative to project root (or src/ directory in case of non-project app), defaults to jest.config.js. Other extensions are also supported. The Jest configuration might be written is TypeScript, but you should explicitly specify the path to the jest.config.ts. The configuration is merged on top of the default configuration, so there is no need to specify the whole jest configuration in this file. Just specify the changes you'd like to make to the default configuration. The way the configurations are merged is as following:

  1. Take the default configuration from the library
  2. Add on top of it default project specific config (that is dynamic due to different root directories). Used to scope single project test runs.
  3. Add on top of it package.json jest config if exists (for all projects) or jest.config.js from workspace root directory if exists
  4. Add on top of it project specific config if it is specified inside angular.json or jest.config.js from project directory (or src/ directory in case of non-project app) if exists.

  Thus, if you don't provide configPath in options, and you'd like to customize the configuration of a single project in your workspace, you only have to add jest.config.js in this project's root directory and specify the configuration delta in this file.
  Or, if you'd like the same custom configuration to be applied to all the projects in the workspace, you just specify it in package.json. Another option in such a case is creating a single config file in the workspace root and specifying it in angular.json for each project.

• tsConfig - path to tsconfig file. If the path is relative then it is evaluated relative to the project root. Defaults to tsconfig.spec.json that is located in project root.

• globalMocks - there are 4 global mocks available: ["getComputedStyle", "doctype", "styleTransform", "matchMedia"].
  The mocks implementation can be found here.

  styleTransform and matchMedia are not implemented in jsdom, therefore these are enabled by default.

  getComputedStyle and doctype are implemented but do not support 100% of cases.

  If you want to disable/enable one or more of these mocks just pass an updated list in options.
  For example:

  "options": {
    "globalMocks": ["styleTransform", "matchMedia", "getComputedStyle"]
  }
  

• [jest-cli-option] - any option from Jest CLI options. For example, to run unit tests without caching and with junit-reporter use:

  "options": {
    "no-cache": true,
    "reporters": "jest-junit"
  }
  

  These options can also be provided directly to ng test command. For example, to run a single test from this suite:

  describe('My cool suite', () => {
    it('Should do one thing', () => {
      // do something...
    });
  
    it('Should do another thing', () => {
      // do something...
    });
  });
  

  Use the following command: ng test --test-name-pattern="My cool suite Should do one thing"

  Notice that for array-like arguments you should use , delimiter instead of space delimiter. These are limitations of Angular CLI.
  Thus, if you want to provide multiple arguments to find-related-tests option you should be passing it like this:

  $ ng test --find-related-tests file1,file2
  

Migrating existing tests to Jest

Use this for automatic migration of your Jasmine tests to Jest framework.

Troubleshooting

Please find below a selection of potential issues you might face when using this builder. Refer to jest-preset-angular Troubleshooting for jest-preset-angular specific issues.

Unexpected token [import|export|other]

This means that the library you're using doesn't use commonjs module format (which jest expects to see). You will need to implement the recommendations mentioned in jest-preset-angular Troubleshooting Guide.

One of the recommendations might require you to transpile js files through babel-jest.
In this case make sure you add allowSyntheticDefaultImports to the ts-jest configuration (see here for an explanation of this setting).

transform: {
  '^.+\\.tsx?$': [
    'ts-jest',
    {
      allowSyntheticDefaultImports: true,
    },
  ],
}

Your final jest.config.js file should look something like this:

const esModules = ['[thir-party-lib]'].join('|');

module.exports = {
  transformIgnorePatterns: [`<rootDir>/node_modules/(?!${esModules})`],
  transform: {
    '^.+\\.tsx?$': [
      'ts-jest',
      {
        allowSyntheticDefaultImports: true,
      },
    ],
    '^.+\\.js$': 'babel-jest',
  },
};