@nx/jest

What is @nx/jest?

@nx/jest is a package that integrates Jest testing framework with Nx, a set of extensible dev tools for monorepos. It allows you to run and manage Jest tests efficiently within an Nx workspace.

What are @nx/jest's main functionalities?

Running Jest Tests

This configuration allows you to run Jest tests for multiple projects within an Nx workspace. The 'projects' array specifies the paths to the projects you want to include.

module.exports = {
  projects: ['<rootDir>/apps/my-app', '<rootDir>/libs/my-lib'],
};

Custom Jest Configuration

This sample shows how to create a custom Jest configuration for a specific project within an Nx workspace. It includes settings for transforming files, module file extensions, and coverage directory.

module.exports = {
  displayName: 'my-app',
  preset: '../../jest.preset.js',
  transform: {
    '^.+\\.[tj]sx?$': 'babel-jest',
  },
  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx'],
  coverageDirectory: '../../coverage/apps/my-app',
};

Running Tests with Nx CLI

You can run tests for a specific project using the Nx CLI. This command runs the tests for the 'my-app' project.

nx test my-app

Other packages similar to @nx/jest

jest

Jest is a delightful JavaScript testing framework with a focus on simplicity. It works out of the box for most JavaScript projects. While @nx/jest integrates Jest with Nx, Jest itself is a standalone testing framework.

karma

Karma is a test runner developed by the AngularJS team. It allows you to run tests in multiple real browsers. Unlike @nx/jest, which is focused on Jest integration, Karma is more about running tests in different environments.

mocha

Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser. It makes asynchronous testing simple. Mocha is more flexible and less opinionated compared to Jest, which is more integrated and comes with more built-in features.

README

Nx: Smart Monorepos · Fast CI

Nx is a build system, optimized for monorepos, with plugins for popular frameworks and tools and advanced CI capabilities including caching and distribution.

This package is a Jest plugin for Nx.

Getting Started

Creating an Nx Workspace

Using npx

npx create-nx-workspace

Using npm init

npm init nx-workspace

Using yarn create

yarn create nx-workspace

Adding Nx to an Existing Repository

Run:

npx nx@latest init

Documentation & Resources

• Nx.Dev: Documentation, Guides, Tutorials
• Intro to Nx
• Official Nx YouTube Channel
• Blog Posts About Nx