feat(misc): optionally update package.json scripts in init generators (…

…#21204)
nrwl · Jan 22, 2024 · e475835 · e475835 · vercel · Jan 22, 2024
1 parent c1238aa
commit e475835
Show file tree

Hide file tree

Showing 69 changed files with 865 additions and 44 deletions.
diff --git a/docs/generated/cli/add.md b/docs/generated/cli/add.md
@@ -49,6 +49,12 @@ Type: `string`
 
 The package name and optional version (e.g. `@nx/react` or `@nx/react@latest`) to install and initialize. If the version is not specified it will install the same version as the `nx` package for Nx core plugins or the latest version for other packages
 
+### updatePackageScripts
+
+Type: `boolean`
+
+Update `package.json` scripts with inferred targets. Defaults to `true` when `NX_PCV3=true` and the package is a core Nx plugin
+
 ### verbose
 
 Type: `boolean`

diff --git a/docs/generated/packages/angular/generators/init.json b/docs/generated/packages/angular/generators/init.json
@@ -34,7 +34,6 @@
         "default": false
       }
     },
-    "additionalProperties": false,
     "presets": []
   },
   "description": "Initializes the `@nrwl/angular` plugin.",

diff --git a/docs/generated/packages/cypress/generators/init.json b/docs/generated/packages/cypress/generators/init.json
@@ -26,6 +26,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "presets": []

diff --git a/docs/generated/packages/detox/generators/init.json b/docs/generated/packages/detox/generators/init.json
@@ -24,6 +24,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/eslint/generators/init.json b/docs/generated/packages/eslint/generators/init.json
@@ -19,6 +19,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/expo/generators/init.json b/docs/generated/packages/expo/generators/init.json
@@ -24,6 +24,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/jest/generators/init.json b/docs/generated/packages/jest/generators/init.json
@@ -26,6 +26,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/nest/generators/init.json b/docs/generated/packages/nest/generators/init.json
@@ -27,7 +27,6 @@
         "default": false
       }
     },
-    "additionalProperties": false,
     "required": [],
     "presets": []
   },

diff --git a/docs/generated/packages/next/generators/init.json b/docs/generated/packages/next/generators/init.json
@@ -25,6 +25,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/nuxt/generators/init.json b/docs/generated/packages/nuxt/generators/init.json
@@ -24,6 +24,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/nx/documents/add.md b/docs/generated/packages/nx/documents/add.md
@@ -49,6 +49,12 @@ Type: `string`
 
 The package name and optional version (e.g. `@nx/react` or `@nx/react@latest`) to install and initialize. If the version is not specified it will install the same version as the `nx` package for Nx core plugins or the latest version for other packages
 
+### updatePackageScripts
+
+Type: `boolean`
+
+Update `package.json` scripts with inferred targets. Defaults to `true` when `NX_PCV3=true` and the package is a core Nx plugin
+
 ### verbose
 
 Type: `boolean`

diff --git a/docs/generated/packages/playwright/generators/init.json b/docs/generated/packages/playwright/generators/init.json
@@ -25,6 +25,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/react-native/generators/init.json b/docs/generated/packages/react-native/generators/init.json
@@ -26,6 +26,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/remix/generators/init.json b/docs/generated/packages/remix/generators/init.json
@@ -24,6 +24,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/docs/generated/packages/storybook/generators/init.json b/docs/generated/packages/storybook/generators/init.json
@@ -23,6 +23,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "presets": []

diff --git a/docs/generated/packages/vite/generators/init.json b/docs/generated/packages/vite/generators/init.json
@@ -23,6 +23,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "presets": []

diff --git a/docs/generated/packages/webpack/generators/init.json b/docs/generated/packages/webpack/generators/init.json
@@ -24,6 +24,12 @@
         "x-priority": "internal",
         "description": "Keep existing dependencies versions",
         "default": false
+      },
+      "updatePackageScripts": {
+        "type": "boolean",
+        "x-priority": "internal",
+        "description": "Update `package.json` scripts with inferred targets",
+        "default": false
       }
     },
     "required": [],

diff --git a/packages/angular/src/generators/init/schema.json b/packages/angular/src/generators/init/schema.json
@@ -30,6 +30,5 @@
       "description": "Keep existing dependencies versions",
       "default": false
     }
-  },
-  "additionalProperties": false
+  }
 }
diff --git a/packages/cypress/src/generators/init/init.ts b/packages/cypress/src/generators/init/init.ts
@@ -8,6 +8,8 @@ import {
   Tree,
   updateNxJson,
 } from '@nx/devkit';
+import { updatePackageScripts } from '@nx/devkit/src/utils/update-package-scripts';
+import { createNodes } from '../../plugins/plugin';
 import { cypressVersion, nxVersion } from '../../utils/versions';
 import { Schema } from './schema';
 import { CypressPluginOptions } from '../../plugins/plugin';
@@ -108,6 +110,10 @@ export async function cypressInitGenerator(tree: Tree, options: Schema) {
     installTask = updateDependencies(tree, options);
   }
 
+  if (options.updatePackageScripts) {
+    await updatePackageScripts(tree, createNodes);
+  }
+
   if (!options.skipFormat) {
     await formatFiles(tree);
   }

diff --git a/packages/cypress/src/generators/init/schema.d.ts b/packages/cypress/src/generators/init/schema.d.ts
@@ -2,4 +2,5 @@ export interface Schema {
   skipFormat?: boolean;
   skipPackageJson?: boolean;
   keepExistingVersions?: boolean;
+  updatePackageScripts?: boolean;
 }
diff --git a/packages/cypress/src/generators/init/schema.json b/packages/cypress/src/generators/init/schema.json
@@ -23,6 +23,12 @@
       "x-priority": "internal",
       "description": "Keep existing dependencies versions",
       "default": false
+    },
+    "updatePackageScripts": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Update `package.json` scripts with inferred targets",
+      "default": false
     }
   }
 }
diff --git a/packages/detox/src/generators/application/lib/add-linting.spec.ts b/packages/detox/src/generators/application/lib/add-linting.spec.ts
@@ -24,8 +24,8 @@ describe('Add Linting', () => {
     });
   });
 
-  it('should update configuration when eslint is passed', () => {
-    addLinting(tree, {
+  it('should update configuration when eslint is passed', async () => {
+    await addLinting(tree, {
       e2eName: 'my-app-e2e',
       e2eProjectName: 'my-app-e2e',
       e2eProjectRoot: 'apps/my-app-e2e',
@@ -45,7 +45,7 @@ describe('Add Linting', () => {
   });
 
   it('should not add lint target when "none" is passed', async () => {
-    addLinting(tree, {
+    await addLinting(tree, {
       e2eName: 'my-app-e2e',
       e2eProjectName: 'my-app-e2e',
       e2eProjectRoot: 'apps/my-app-e2e',

diff --git a/packages/detox/src/generators/init/init.ts b/packages/detox/src/generators/init/init.ts
@@ -8,7 +8,8 @@ import {
   Tree,
   updateNxJson,
 } from '@nx/devkit';
-import { DetoxPluginOptions } from '../../plugins/plugin';
+import { updatePackageScripts } from '@nx/devkit/src/utils/update-package-scripts';
+import { createNodes, DetoxPluginOptions } from '../../plugins/plugin';
 import { detoxVersion, nxVersion } from '../../utils/versions';
 import { Schema } from './schema';
 
@@ -24,6 +25,10 @@ export async function detoxInitGenerator(host: Tree, schema: Schema) {
     addPlugin(host);
   }
 
+  if (schema.updatePackageScripts) {
+    await updatePackageScripts(host, createNodes);
+  }
+
   if (!schema.skipFormat) {
     await formatFiles(host);
   }

diff --git a/packages/detox/src/generators/init/schema.d.ts b/packages/detox/src/generators/init/schema.d.ts
@@ -2,4 +2,5 @@ export interface Schema {
   skipFormat?: boolean;
   skipPackageJson?: boolean; //default is false
   keepExistingVersions?: boolean; //default is false
+  updatePackageScripts?: boolean;
 }
diff --git a/packages/detox/src/generators/init/schema.json b/packages/detox/src/generators/init/schema.json
@@ -21,6 +21,12 @@
       "x-priority": "internal",
       "description": "Keep existing dependencies versions",
       "default": false
+    },
+    "updatePackageScripts": {
+      "type": "boolean",
+      "x-priority": "internal",
+      "description": "Update `package.json` scripts with inferred targets",
+      "default": false
     }
   },
   "required": []

diff --git a/packages/devkit/package.json b/packages/devkit/package.json
@@ -33,7 +33,8 @@
     "ignore": "^5.0.4",
     "tmp": "~0.2.1",
     "tslib": "^2.3.0",
-    "semver": "7.5.3"
+    "semver": "7.5.3",
+    "yargs-parser": "21.1.1"
   },
   "peerDependencies": {
     "nx": ">= 16 <= 18"