From 7b807a9c5d21c187d08ed38ac74b51f7b1a2ab88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leosvel=20P=C3=A9rez=20Espinosa?= Date: Thu, 8 Feb 2024 17:27:14 +0100 Subject: [PATCH] docs(testing): fix example in cypress overview for configuration generator (#21717) --- docs/generated/packages/cypress/documents/overview.md | 10 +++++----- docs/shared/packages/cypress/cypress-plugin.md | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/generated/packages/cypress/documents/overview.md b/docs/generated/packages/cypress/documents/overview.md index e43633272a..3e2bbb4aa4 100644 --- a/docs/generated/packages/cypress/documents/overview.md +++ b/docs/generated/packages/cypress/documents/overview.md @@ -95,18 +95,18 @@ By default, when creating a new frontend application, Nx will use Cypress to cre nx g @nx/web:app frontend ``` -### Creating a Cypress E2E project for an existing project +### Configure Cypress for an existing project -To generate an E2E project based on an existing project, run the following generator +To configure Cypress for an existing project, run the following generator ```shell -nx g @nx/cypress:configuration your-app-name-e2e --project=your-app-name +nx g @nx/cypress:configuration --project=your-app-name ``` -Optionally, you can use the `--baseUrl` option if you don't want cypress plugin to serve `your-app-name`. +Optionally, you can use the `--baseUrl` option if you don't want the Cypress plugin to serve `your-app-name`. ```shell -nx g @nx/cypress:configuration your-app-name-e2e --baseUrl=http://localhost:4200 +nx g @nx/cypress:configuration --project=your-app-name --baseUrl=http://localhost:4200 ``` Replace `your-app-name` with the app's name as defined in your `tsconfig.base.json` file or the `name` property of your `package.json`. diff --git a/docs/shared/packages/cypress/cypress-plugin.md b/docs/shared/packages/cypress/cypress-plugin.md index e43633272a..3e2bbb4aa4 100644 --- a/docs/shared/packages/cypress/cypress-plugin.md +++ b/docs/shared/packages/cypress/cypress-plugin.md @@ -95,18 +95,18 @@ By default, when creating a new frontend application, Nx will use Cypress to cre nx g @nx/web:app frontend ``` -### Creating a Cypress E2E project for an existing project +### Configure Cypress for an existing project -To generate an E2E project based on an existing project, run the following generator +To configure Cypress for an existing project, run the following generator ```shell -nx g @nx/cypress:configuration your-app-name-e2e --project=your-app-name +nx g @nx/cypress:configuration --project=your-app-name ``` -Optionally, you can use the `--baseUrl` option if you don't want cypress plugin to serve `your-app-name`. +Optionally, you can use the `--baseUrl` option if you don't want the Cypress plugin to serve `your-app-name`. ```shell -nx g @nx/cypress:configuration your-app-name-e2e --baseUrl=http://localhost:4200 +nx g @nx/cypress:configuration --project=your-app-name --baseUrl=http://localhost:4200 ``` Replace `your-app-name` with the app's name as defined in your `tsconfig.base.json` file or the `name` property of your `package.json`.