docs(testing): add deprecation messages for Jest/Cypress (nrwl#14137)

halilertekin · Jan 4, 2023 · 8c014f0 · 8c014f0
1 parent 9193d1a
commit 8c014f0
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 24 deletions.
diff --git a/docs/generated/packages/cypress/executors/cypress.json b/docs/generated/packages/cypress/executors/cypress.json
@@ -48,9 +48,9 @@
       },
       "headless": {
         "type": "boolean",
-        "description": "Hide the browser instead of running headed (default for cypress run).",
+        "description": "Hide the browser instead of running headed.",
         "default": false,
-        "x-deprecated": true
+        "x-deprecated": "Cypress runs headless by default. Use the --watch flag to control head/headless behavior instead."
       },
       "exit": {
         "type": "boolean",
@@ -90,7 +90,7 @@
       "copyFiles": {
         "type": "string",
         "description": "A regex string that is used to choose what additional integration files to copy to the dist folder.",
-        "x-deprecated": true
+        "x-deprecated": "No longer used since cypress supports typescript out of the box. If specified, it will be ignored."
       },
       "ciBuildId": {
         "oneOf": [{ "type": "string" }, { "type": "number" }],

diff --git a/docs/generated/packages/jest/executors/jest.json b/docs/generated/packages/jest/executors/jest.json
@@ -54,14 +54,14 @@
         "type": "string"
       },
       "tsConfig": {
-        "description": "The name of the Typescript configuration file. Set the tsconfig option in the jest config file. ",
+        "description": "The name of the Typescript configuration file.",
         "type": "string",
-        "x-deprecated": true
+        "x-deprecated": "Use the ts-jest configuration options in the jest config file instead."
       },
       "setupFile": {
-        "description": "The name of a setup file used by Jest. (use Jest config file https://jestjs.io/docs/en/configuration#setupfilesafterenv-array)",
+        "description": "The name of a setup file used by Jest.",
         "type": "string",
-        "x-deprecated": true
+        "x-deprecated": "Use the setupFilesAfterEnv option in the jest config file. https://jestjs.io/docs/en/configuration#setupfilesafterenv-array"
       },
       "bail": {
         "alias": "b",

diff --git a/docs/generated/packages/jest/generators/jest-project.json b/docs/generated/packages/jest/generators/jest-project.json
@@ -16,9 +16,9 @@
       },
       "skipSetupFile": {
         "type": "boolean",
-        "description": "[Deprecated]: Skips the setup file required for angular. (Use `--setup-file`)",
+        "description": "Skips the setup file required for angular.",
         "default": false,
-        "x-deprecated": true
+        "x-deprecated": "Use `--setup-file` instead."
       },
       "setupFile": {
         "type": "string",
@@ -51,8 +51,8 @@
       "babelJest": {
         "type": "boolean",
         "alias": "babel-jest",
-        "description": "Use `babel-jest` instead of `ts-jest` (Deprecated: Use `--compiler=babel` instead).",
-        "x-deprecated": true,
+        "description": "Use `babel-jest` instead of `ts-jest`.",
+        "x-deprecated": "Use `--compiler=babel` instead.",
         "default": false
       },
       "skipFormat": {

diff --git a/packages/cypress/src/executors/cypress/cypress.impl.ts b/packages/cypress/src/executors/cypress/cypress.impl.ts
@@ -22,6 +22,9 @@ export interface CypressExecutorOptions extends Json {
   tsConfig?: string;
   devServerTarget?: string;
   headed?: boolean;
+  /**
+   * @deprecated use watch instead
+   **/
   headless?: boolean;
   exit?: boolean;
   key?: string;
@@ -31,6 +34,9 @@ export interface CypressExecutorOptions extends Json {
   browser?: string;
   env?: Record<string, string>;
   spec?: string;
+  /**
+   * @deprecated no longer used since cypress supports typescript out of the box
+   **/
   copyFiles?: string;
   ciBuildId?: string | number;
   group?: string;

diff --git a/packages/cypress/src/executors/cypress/schema.json b/packages/cypress/src/executors/cypress/schema.json
@@ -48,9 +48,9 @@
     },
     "headless": {
       "type": "boolean",
-      "description": "Hide the browser instead of running headed (default for cypress run).",
+      "description": "Hide the browser instead of running headed.",
       "default": false,
-      "x-deprecated": true
+      "x-deprecated": "Cypress runs headless by default. Use the --watch flag to control head/headless behavior instead."
     },
     "exit": {
       "type": "boolean",
@@ -90,7 +90,7 @@
     "copyFiles": {
       "type": "string",
       "description": "A regex string that is used to choose what additional integration files to copy to the dist folder.",
-      "x-deprecated": true
+      "x-deprecated": "No longer used since cypress supports typescript out of the box. If specified, it will be ignored."
     },
     "ciBuildId": {
       "oneOf": [

diff --git a/packages/jest/src/executors/jest/schema.d.ts b/packages/jest/src/executors/jest/schema.d.ts
@@ -6,6 +6,9 @@ export interface JestExecutorOptions {
   detectLeaks?: boolean;
   jestConfig: string;
   testFile?: string;
+  /**
+   * @deprecated set in the jest config file instead
+   **/
   setupFile?: string;
   bail?: boolean | number;
   ci?: boolean;

diff --git a/packages/jest/src/executors/jest/schema.json b/packages/jest/src/executors/jest/schema.json
@@ -56,14 +56,14 @@
       "type": "string"
     },
     "tsConfig": {
-      "description": "The name of the Typescript configuration file. Set the tsconfig option in the jest config file. ",
+      "description": "The name of the Typescript configuration file.",
       "type": "string",
-      "x-deprecated": true
+      "x-deprecated": "Use the ts-jest configuration options in the jest config file instead."
     },
     "setupFile": {
-      "description": "The name of a setup file used by Jest. (use Jest config file https://jestjs.io/docs/en/configuration#setupfilesafterenv-array)",
+      "description": "The name of a setup file used by Jest.",
       "type": "string",
-      "x-deprecated": true
+      "x-deprecated": "Use the setupFilesAfterEnv option in the jest config file. https://jestjs.io/docs/en/configuration#setupfilesafterenv-array"
     },
     "bail": {
       "alias": "b",

diff --git a/packages/jest/src/generators/jest-project/schema.d.ts b/packages/jest/src/generators/jest-project/schema.d.ts
@@ -2,14 +2,14 @@ export interface JestProjectSchema {
   project: string;
   supportTsx?: boolean;
   /**
-   * @deprecated
+   * @deprecated use setupFile instead
    */
   skipSetupFile?: boolean;
   setupFile?: 'angular' | 'web-components' | 'none';
   skipSerializers?: boolean;
   testEnvironment?: 'node' | 'jsdom' | '';
   /**
-   * @deprecated
+   * @deprecated use compiler: "babel" instead
    */
   babelJest?: boolean;
   skipFormat?: boolean;

diff --git a/packages/jest/src/generators/jest-project/schema.json b/packages/jest/src/generators/jest-project/schema.json
@@ -15,9 +15,9 @@
     },
     "skipSetupFile": {
       "type": "boolean",
-      "description": "[Deprecated]: Skips the setup file required for angular. (Use `--setup-file`)",
+      "description": "Skips the setup file required for angular.",
       "default": false,
-      "x-deprecated": true
+      "x-deprecated": "Use `--setup-file` instead."
     },
     "setupFile": {
       "type": "string",
@@ -50,8 +50,8 @@
     "babelJest": {
       "type": "boolean",
       "alias": "babel-jest",
-      "description": "Use `babel-jest` instead of `ts-jest` (Deprecated: Use `--compiler=babel` instead).",
-      "x-deprecated": true,
+      "description": "Use `babel-jest` instead of `ts-jest`.",
+      "x-deprecated": "Use `--compiler=babel` instead.",
       "default": false
     },
     "skipFormat": {