@nx/cypress 17.2.4 → 17.2.5

package/README.md

@@ -1,4 +1,9 @@
-<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx.png" width="600" alt="Nx - Smart, Fast and Extensible Build System"></p>
+<p style="text-align: center;">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-dark.svg">
+    <img alt="Nx - Smart Monorepos · Fast CI" src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-light.svg" width="100%">
+  </picture>
+</p>
 
 <div style="text-align: center;">
 
@@ -15,9 +20,9 @@
 
 <hr>
 
-# Nx: Smart, Fast and Extensible Build System
+# Nx: Smart Monorepos · Fast CI
 
-Nx is a next generation build system with first class monorepo support and powerful integrations.
+Nx is a build system with built-in tooling and advanced CI capabilities. It helps you maintain and scale monorepos, both locally and on CI.
 
 This package is a [Cypress plugin for Nx](https://nx.dev/cypress/overview).
 
@@ -59,5 +64,5 @@ npx nx@latest init
 - [Blog Posts About Nx](https://blog.nrwl.io/nx/home)
 
 <p style="text-align: center;"><a href="https://nx.dev/#learning-materials" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-courses-and-videos.svg" 
-width="100%" alt="Nx - Smart, Fast and Extensible Build System"></a></p>
+width="100%" alt="Nx - Smart Monorepos · Fast CI"></a></p>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/cypress",
-  "version": "17.2.4",
+  "version": "v17.2.5",
   "private": false,
   "description": "The Nx Plugin for Cypress contains executors and generators allowing your workspace to use the powerful Cypress integration testing capabilities.",
   "repository": {
@@ -34,14 +34,14 @@
     "migrations": "./migrations.json"
   },
   "dependencies": {
-    "@nx/devkit": "17.2.4",
-    "@nx/eslint": "17.2.4",
-    "@nx/js": "17.2.4",
+    "@nx/devkit": "v17.2.5",
+    "@nx/eslint": "v17.2.5",
+    "@nx/js": "v17.2.5",
     "@phenomnomnominal/tsquery": "~5.0.1",
     "detect-port": "^1.5.1",
     "semver": "7.5.3",
     "tslib": "^2.3.0",
-    "@nrwl/cypress": "17.2.4"
+    "@nrwl/cypress": "v17.2.5"
   },
   "peerDependencies": {
     "cypress": ">= 3 < 14"

package/plugins/cypress-preset.d.ts

@@ -51,8 +51,18 @@ export type NxCypressE2EPresetOptions = {
      * default is 'src'
      **/
     cypressDir?: string;
+    /**
+     * A map of commandName -> command to start the web server for testing.
+     * Currently only default is read.
+     */
     webServerCommands?: Record<string, string>;
+    /**
+     * A command to start the web server - used for e2e tests distributed by Nx.
+     */
     ciWebServerCommand?: string;
+    /**
+     * Configures how the web server command is started and monitored.
+     */
     webServerConfig?: WebServerConfig;
 };
 export {};

package/plugins/cypress-preset.js

@@ -5,6 +5,7 @@ const devkit_1 = require("@nx/devkit");
 const path_1 = require("path");
 const fs_1 = require("fs");
 const preprocessor_vite_1 = require("../src/plugins/preprocessor-vite");
+const symbols_1 = require("../src/utils/symbols");
 const child_process_1 = require("child_process");
 const http_1 = require("http");
 const https_1 = require("https");
@@ -55,25 +56,28 @@ function startWebServer(webServerCommand) {
  */
 function nxE2EPreset(pathToConfig, options) {
     const basePath = options?.cypressDir || 'src';
-    const baseConfig /** Cypress.EndToEndConfigOptions */ = {
+    const baseConfig /*Cypress.EndToEndConfigOptions & {
+      [NX_PLUGIN_OPTIONS]: unknown;
+    }*/ = {
         ...nxBaseCypressPreset(pathToConfig),
         fileServerFolder: '.',
         supportFile: `${basePath}/support/e2e.ts`,
         specPattern: `${basePath}/**/*.cy.{js,jsx,ts,tsx}`,
         fixturesFolder: `${basePath}/fixtures`,
-        env: {
+        [symbols_1.NX_PLUGIN_OPTIONS]: {
             webServerCommand: options?.webServerCommands?.default,
             webServerCommands: options?.webServerCommands,
             ciWebServerCommand: options?.ciWebServerCommand,
         },
         async setupNodeEvents(on, config) {
+            const webServerCommands = config.env?.webServerCommands ?? options?.webServerCommands;
+            const webServerCommand = config.env?.webServerCommand ?? webServerCommands?.default;
             if (options?.bundler === 'vite') {
                 on('file:preprocessor', (0, preprocessor_vite_1.default)());
             }
-            if (!config.env.webServerCommands) {
+            if (!options?.webServerCommands) {
                 return;
             }
-            const webServerCommand = config.env.webServerCommand;
             if (!webServerCommand) {
                 return;
             }

package/src/plugins/plugin.js

@@ -10,6 +10,7 @@ const fs_1 = require("fs");
 const workspace_context_1 = require("nx/src/utils/workspace-context");
 const calculate_hash_for_create_nodes_1 = require("@nx/devkit/src/utils/calculate-hash-for-create-nodes");
 const cache_directory_1 = require("nx/src/utils/cache-directory");
+const symbols_1 = require("../utils/symbols");
 const cachePath = (0, path_1.join)(cache_directory_1.projectGraphCacheDirectory, 'cypress.hash');
 const targetsCache = (0, fs_1.existsSync)(cachePath) ? readTargetsCache() : {};
 const calculatedTargets = {};
@@ -93,11 +94,12 @@ function getOutputs(projectRoot, cypressConfig, testingType) {
 }
 function buildCypressTargets(configFilePath, projectRoot, options, context) {
     const cypressConfig = getCypressConfig(configFilePath, context);
-    const cypressEnv = {
+    const pluginPresetOptions = {
+        ...cypressConfig.e2e?.[symbols_1.NX_PLUGIN_OPTIONS],
         ...cypressConfig.env,
         ...cypressConfig.e2e?.env,
     };
-    const webServerCommands = cypressEnv?.webServerCommands;
+    const webServerCommands = pluginPresetOptions?.webServerCommands;
     const relativeConfigPath = (0, path_1.relative)(projectRoot, configFilePath);
     const namedInputs = (0, get_named_inputs_1.getNamedInputs)(projectRoot, context);
     const targets = {};
@@ -120,7 +122,7 @@ function buildCypressTargets(configFilePath, projectRoot, options, context) {
                 };
             }
         }
-        const ciWebServerCommand = cypressEnv?.ciWebServerCommand;
+        const ciWebServerCommand = pluginPresetOptions?.ciWebServerCommand;
         if (ciWebServerCommand) {
             const specPatterns = Array.isArray(cypressConfig.e2e.specPattern)
                 ? cypressConfig.e2e.specPattern.map((p) => (0, path_1.join)(projectRoot, p))

package/src/utils/symbols.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Key used to store options used by the nx plugin for @nx/cypress.
+ */
+export declare const NX_PLUGIN_OPTIONS: unique symbol;

package/src/utils/symbols.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NX_PLUGIN_OPTIONS = void 0;
+/**
+ * Key used to store options used by the nx plugin for @nx/cypress.
+ */
+exports.NX_PLUGIN_OPTIONS = Symbol('Nx Plugin Options');