From 72e2a3ba50d4c5b4725785407db9c6d97d29bdf4 Mon Sep 17 00:00:00 2001 From: Katerina Skroumpelou Date: Mon, 16 Oct 2023 18:12:47 +0300 Subject: [PATCH] docs(storybook): deprecate cypress spec generation option (#19633) --- .../angular/generators/storybook-configuration.json | 9 ++++++--- .../react/generators/storybook-configuration.json | 9 ++++++--- .../src/generators/storybook-configuration/schema.json | 9 ++++++--- .../src/generators/storybook-configuration/schema.json | 9 ++++++--- 4 files changed, 24 insertions(+), 12 deletions(-) diff --git a/docs/generated/packages/angular/generators/storybook-configuration.json b/docs/generated/packages/angular/generators/storybook-configuration.json index 3682f68e33942..8571bd3d3c13c 100644 --- 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 index 7c49f78c30c37..b3e981082abcc 100644 --- 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 index 54e4879f7ffd0..dad6077a37717 100644 --- 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 index d36eb1fe6ab81..56e52eb072df4 100644 --- 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",