@nx/jest 20.3.0 → 20.4.0-beta.0

package/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2024 Narwhal Technologies Inc.
+Copyright (c) 2017-2025 Narwhal Technologies Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/jest",
-  "version": "20.3.0",
+  "version": "20.4.0-beta.0",
   "private": false,
   "description": "The Nx Plugin for Jest contains executors and generators allowing your workspace to use the powerful Jest testing capabilities.",
   "repository": {
@@ -37,15 +37,15 @@
   "dependencies": {
     "@jest/reporters": "^29.4.1",
     "@jest/test-result": "^29.4.1",
-    "@nx/devkit": "20.3.0",
-    "@nx/js": "20.3.0",
+    "@nx/devkit": "20.4.0-beta.0",
+    "@nx/js": "20.4.0-beta.0",
     "@phenomnomnominal/tsquery": "~5.0.1",
-    "chalk": "^4.1.0",
     "identity-obj-proxy": "3.0.0",
     "jest-config": "^29.4.1",
     "jest-resolve": "^29.4.1",
     "jest-util": "^29.4.1",
     "minimatch": "9.0.3",
+    "picocolors": "^1.1.0",
     "resolve.exports": "2.0.3",
     "semver": "^7.5.3",
     "tslib": "^2.3.0",

package/src/executors/jest/summary.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getSummary = void 0;
 const jest_util_1 = require("jest-util");
-const chalk = require("chalk");
+const pc = require("picocolors");
 /**
  * Copied from the jest repo because these utility functions are not exposed through the package
  * https://github.com/facebook/jest/blob/7a64ede2163eba4ecc725f448cd92102cd8c14aa/packages/jest-reporters/src/utils.ts
@@ -46,9 +46,9 @@ const getValuesCurrentTestCases = (currentTestCases = []) => {
 const renderTime = (runTime, estimatedTime, width) => {
     // If we are more than one second over the estimated time, highlight it.
     const renderedTime = estimatedTime && runTime >= estimatedTime + 1
-        ? chalk.bold.yellow((0, jest_util_1.formatTime)(runTime, 0))
+        ? pc.bold(pc.yellow((0, jest_util_1.formatTime)(runTime, 0)))
         : (0, jest_util_1.formatTime)(runTime, 0);
-    let time = chalk.bold(`Time:`) + `        ${renderedTime}`;
+    let time = pc.bold(`Time:`) + `        ${renderedTime}`;
     if (runTime < estimatedTime) {
         time += `, estimated ${(0, jest_util_1.formatTime)(estimatedTime, 0)}`;
     }
@@ -60,8 +60,8 @@ const renderTime = (runTime, estimatedTime, width) => {
         if (availableWidth >= 2) {
             time +=
                 '\n' +
-                    chalk.green('█').repeat(length) +
-                    chalk.white('█').repeat(availableWidth - length);
+                    pc.green('█').repeat(length) +
+                    pc.white('█').repeat(availableWidth - length);
         }
     }
     return time;
@@ -93,12 +93,12 @@ const getSummary = (aggregatedResults, options) => {
     const testsTodo = aggregatedResults.numTodoTests;
     const testsTotal = aggregatedResults.numTotalTests;
     const width = options?.width || 0;
-    const suites = chalk.bold('Test Suites: ') +
-        (suitesFailed ? chalk.bold.red(`${suitesFailed} failed`) + ', ' : '') +
+    const suites = pc.bold('Test Suites: ') +
+        (suitesFailed ? pc.bold(pc.red(`${suitesFailed} failed`)) + ', ' : '') +
         (suitesPending
-            ? chalk.bold.yellow(`${suitesPending} skipped`) + ', '
+            ? pc.bold(pc.yellow(`${suitesPending} skipped`)) + ', '
             : '') +
-        (suitesPassed ? chalk.bold.green(`${suitesPassed} passed`) + ', ' : '') +
+        (suitesPassed ? pc.bold(pc.green(`${suitesPassed} passed`)) + ', ' : '') +
         (suitesRun !== suitesTotal
             ? suitesRun + ' of ' + suitesTotal
             : suitesTotal) +
@@ -108,44 +108,44 @@ const getSummary = (aggregatedResults, options) => {
     const updatedTestsTodo = testsTodo + numTodoTests;
     const updatedTestsPassed = testsPassed + numPassingTests;
     const updatedTestsTotal = testsTotal + numTotalTests;
-    const tests = chalk.bold('Tests:       ') +
+    const tests = pc.bold('Tests:       ') +
         (updatedTestsFailed > 0
-            ? chalk.bold.red(`${updatedTestsFailed} failed`) + ', '
+            ? pc.bold(pc.red(`${updatedTestsFailed} failed`)) + ', '
             : '') +
         (updatedTestsPending > 0
-            ? chalk.bold.yellow(`${updatedTestsPending} skipped`) + ', '
+            ? pc.bold(pc.yellow(`${updatedTestsPending} skipped`)) + ', '
             : '') +
         (updatedTestsTodo > 0
-            ? chalk.bold.magenta(`${updatedTestsTodo} todo`) + ', '
+            ? pc.bold(pc.magenta(`${updatedTestsTodo} todo`)) + ', '
             : '') +
         (updatedTestsPassed > 0
-            ? chalk.bold.green(`${updatedTestsPassed} passed`) + ', '
+            ? pc.bold(pc.green(`${updatedTestsPassed} passed`)) + ', '
             : '') +
         `${updatedTestsTotal} total`;
-    const snapshots = chalk.bold('Snapshots:   ') +
+    const snapshots = pc.bold('Snapshots:   ') +
         (snapshotsFailed
-            ? chalk.bold.red(`${snapshotsFailed} failed`) + ', '
+            ? pc.bold(pc.red(`${snapshotsFailed} failed`)) + ', '
             : '') +
         (snapshotsOutdated && !snapshotsDidUpdate
-            ? chalk.bold.yellow(`${snapshotsOutdated} obsolete`) + ', '
+            ? pc.bold(pc.yellow(`${snapshotsOutdated} obsolete`)) + ', '
             : '') +
         (snapshotsOutdated && snapshotsDidUpdate
-            ? chalk.bold.green(`${snapshotsOutdated} removed`) + ', '
+            ? pc.bold(pc.green(`${snapshotsOutdated} removed`)) + ', '
             : '') +
         (snapshotsFilesRemoved && !snapshotsDidUpdate
-            ? chalk.bold.yellow((0, jest_util_1.pluralize)('file', snapshotsFilesRemoved) + ' obsolete') + ', '
+            ? pc.bold(pc.yellow((0, jest_util_1.pluralize)('file', snapshotsFilesRemoved) + ' obsolete')) + ', '
             : '') +
         (snapshotsFilesRemoved && snapshotsDidUpdate
-            ? chalk.bold.green((0, jest_util_1.pluralize)('file', snapshotsFilesRemoved) + ' removed') + ', '
+            ? pc.bold(pc.green((0, jest_util_1.pluralize)('file', snapshotsFilesRemoved) + ' removed')) + ', '
             : '') +
         (snapshotsUpdated
-            ? chalk.bold.green(`${snapshotsUpdated} updated`) + ', '
+            ? pc.bold(pc.green(`${snapshotsUpdated} updated`)) + ', '
             : '') +
         (snapshotsAdded
-            ? chalk.bold.green(`${snapshotsAdded} written`) + ', '
+            ? pc.bold(pc.green(`${snapshotsAdded} written`)) + ', '
             : '') +
         (snapshotsPassed
-            ? chalk.bold.green(`${snapshotsPassed} passed`) + ', '
+            ? pc.bold(pc.green(`${snapshotsPassed} passed`)) + ', '
             : '') +
         `${snapshotsTotal} total`;
     const time = renderTime(runTime, estimatedTime, width);

package/src/generators/configuration/lib/create-files.js

@@ -49,7 +49,7 @@ function createFiles(tree, options, presetExt) {
             ? `${rootOffset}tsconfig.base.json`
             : './tsconfig.json',
         outDir: isTsSolutionSetup ? `./out-tsc/jest` : `${rootOffset}dist/out-tsc`,
-        module: !isTsSolutionSetup ? 'commonjs' : undefined,
+        module: !isTsSolutionSetup || transformer === 'ts-jest' ? 'commonjs' : undefined,
     });
     if (options.setupFile === 'none') {
         tree.delete((0, path_1.join)(projectConfig.root, './src/test-setup.ts'));

package/src/plugins/plugin.d.ts

@@ -2,6 +2,10 @@ import { CreateNodes, CreateNodesV2 } from '@nx/devkit';
 export interface JestPluginOptions {
     targetName?: string;
     ciTargetName?: string;
+    /**
+     * The name that should be used to group atomized tasks on CI
+     */
+    ciGroupName?: string;
     /**
      *  Whether to use jest-config and jest-runtime to load Jest configuration and context.
      *  Disabling this is much faster but could be less correct since we are using our own config loader

package/src/plugins/plugin.js

@@ -119,7 +119,7 @@ async function buildJestTargets(configFilePath, projectRoot, options, context, p
     const cache = (target.cache = true);
     const inputs = (target.inputs = getInputs(namedInputs, rawConfig.preset, projectRoot, context.workspaceRoot, options.disableJestRuntime));
     let metadata;
-    const groupName = 'E2E (CI)';
+    const groupName = options?.ciGroupName ?? deductGroupNameFromTarget(options?.ciTargetName);
     if (options.disableJestRuntime) {
         const outputs = (target.outputs = getOutputs(projectRoot, rawConfig.coverageDirectory
             ? (0, path_1.join)(context.workspaceRoot, projectRoot, rawConfig.coverageDirectory)
@@ -452,3 +452,24 @@ async function getJestOption(rawConfig, absConfigFilePath, optionName, presetCac
     }
     return undefined;
 }
+/**
+ * Helper that tries to deduct the name of the CI group, based on the related target name.
+ *
+ * This will work well, when the CI target name follows the documented naming convention or similar (for e.g `test-ci`, `e2e-ci`, `ny-e2e-ci`, etc).
+ *
+ * For example, `test-ci` => `TEST (CI)`,  `e2e-ci` => `E2E (CI)`,  `my-e2e-ci` => `MY E2E (CI)`
+ *
+ *
+ * @param ciTargetName name of the CI target
+ * @returns the deducted group name or `${ciTargetName.toUpperCase()} (CI)` if cannot be deducted automatically
+ */
+function deductGroupNameFromTarget(ciTargetName) {
+    if (!ciTargetName) {
+        return null;
+    }
+    const parts = ciTargetName.split('-').map((v) => v.toUpperCase());
+    if (parts.length > 1) {
+        return `${parts.slice(0, -1).join(' ')} (${parts[parts.length - 1]})`;
+    }
+    return `${parts[0]} (CI)`; // default group name when there is a single segment
+}