docs(storybook): deprecate cypress spec generation option (#19633)

nrwl · Oct 16, 2023 · 72e2a3b · 72e2a3b
1 parent 01847b1
commit 72e2a3b
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 12 deletions.
diff --git a/docs/generated/packages/angular/generators/storybook-configuration.json b/docs/generated/packages/angular/generators/storybook-configuration.json
@@ -28,7 +28,8 @@
       },
       "configureCypress": {
         "type": "boolean",
-        "description": "Specifies whether to configure Cypress or not."
+        "description": "Specifies whether to configure Cypress or not.",
+        "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
       },
       "generateStories": {
         "type": "boolean",
@@ -39,7 +40,8 @@
       },
       "generateCypressSpecs": {
         "type": "boolean",
-        "description": "Specifies whether to automatically generate test files in the generated Cypress e2e app."
+        "description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
+        "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
       },
       "configureStaticServe": {
         "type": "boolean",
@@ -50,7 +52,8 @@
       },
       "cypressDirectory": {
         "type": "string",
-        "description": "A directory where the Cypress project will be placed. Placed at the root by default."
+        "description": "A directory where the Cypress project will be placed. Placed at the root by default.",
+        "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
       },
       "linter": {
         "description": "The tool to use for running lint checks.",

diff --git a/docs/generated/packages/react/generators/storybook-configuration.json b/docs/generated/packages/react/generators/storybook-configuration.json
@@ -28,7 +28,8 @@
       },
       "configureCypress": {
         "type": "boolean",
-        "description": "Run the cypress-configure generator."
+        "description": "Run the cypress-configure generator.",
+        "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
       },
       "generateStories": {
         "type": "boolean",
@@ -39,7 +40,8 @@
       },
       "generateCypressSpecs": {
         "type": "boolean",
-        "description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator."
+        "description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
+        "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
       },
       "configureStaticServe": {
         "type": "boolean",
@@ -50,7 +52,8 @@
       },
       "cypressDirectory": {
         "type": "string",
-        "description": "A directory where the Cypress project will be placed. Placed at the root by default."
+        "description": "A directory where the Cypress project will be placed. Placed at the root by default.",
+        "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
       },
       "js": {
         "type": "boolean",

diff --git a/packages/angular/src/generators/storybook-configuration/schema.json b/packages/angular/src/generators/storybook-configuration/schema.json
@@ -28,7 +28,8 @@
     },
     "configureCypress": {
       "type": "boolean",
-      "description": "Specifies whether to configure Cypress or not."
+      "description": "Specifies whether to configure Cypress or not.",
+      "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
     },
     "generateStories": {
       "type": "boolean",
@@ -39,7 +40,8 @@
     },
     "generateCypressSpecs": {
       "type": "boolean",
-      "description": "Specifies whether to automatically generate test files in the generated Cypress e2e app."
+      "description": "Specifies whether to automatically generate test files in the generated Cypress e2e app.",
+      "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
     },
     "configureStaticServe": {
       "type": "boolean",
@@ -50,7 +52,8 @@
     },
     "cypressDirectory": {
       "type": "string",
-      "description": "A directory where the Cypress project will be placed. Placed at the root by default."
+      "description": "A directory where the Cypress project will be placed. Placed at the root by default.",
+      "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
     },
     "linter": {
       "description": "The tool to use for running lint checks.",

diff --git a/packages/react/src/generators/storybook-configuration/schema.json b/packages/react/src/generators/storybook-configuration/schema.json
@@ -28,7 +28,8 @@
     },
     "configureCypress": {
       "type": "boolean",
-      "description": "Run the cypress-configure generator."
+      "description": "Run the cypress-configure generator.",
+      "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
     },
     "generateStories": {
       "type": "boolean",
@@ -39,7 +40,8 @@
     },
     "generateCypressSpecs": {
       "type": "boolean",
-      "description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator."
+      "description": "Automatically generate test files in the Cypress E2E app generated by the `cypress-configure` generator.",
+      "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
     },
     "configureStaticServe": {
       "type": "boolean",
@@ -50,7 +52,8 @@
     },
     "cypressDirectory": {
       "type": "string",
-      "description": "A directory where the Cypress project will be placed. Placed at the root by default."
+      "description": "A directory where the Cypress project will be placed. Placed at the root by default.",
+      "x-deprecated": "Use interactionTests instead. This option will be removed in v18."
     },
     "js": {
       "type": "boolean",