feat(misc): add useProjectJson flag to project generators (#30319)

Add a `useProjectJson` option to project generators to allow users to
opt in/out of generating the Nx configuration in a `project.json` file.

## Current Behavior

## Expected Behavior

## Related Issue(s)

Fixes #

Author: leosvelperez

docs/generated/packages/detox/generators/application.json

@@ -58,6 +58,10 @@
         "type": "boolean",
         "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["e2eDirectory", "appProject", "framework"],

docs/generated/packages/expo/generators/application.json

@@ -86,6 +86,10 @@
         "type": "boolean",
         "description": "Do not add dependencies to `package.json`.",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/expo/generators/library.json

@@ -89,6 +89,10 @@
         "type": "boolean",
         "description": "Do not add dependencies to `package.json`.",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/express/generators/application.json

@@ -73,6 +73,10 @@
         "type": "boolean",
         "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/nest/generators/application.json

@@ -78,6 +78,10 @@
         "type": "boolean",
         "description": "Adds strictNullChecks, noImplicitAny, strictBindCallApply, forceConsistentCasingInFileNames and noFallthroughCasesInSwitch to tsconfig.",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "additionalProperties": false,

docs/generated/packages/nest/generators/library.json

@@ -133,6 +133,10 @@
         "description": "Don't include the directory in the name of the module of the library.",
         "type": "boolean",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "additionalProperties": false,

docs/generated/packages/next/generators/application.json

@@ -138,6 +138,10 @@
         "default": false,
         "hidden": true,
         "x-priority": "internal"
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/next/generators/library.json

@@ -152,6 +152,10 @@
         "default": false,
         "description": "Do not add dependencies to `package.json`.",
         "x-priority": "internal"
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/node/generators/application.json

@@ -123,6 +123,10 @@
       "docker": {
         "type": "boolean",
         "description": "Add a docker build target"
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/node/generators/library.json

@@ -123,6 +123,10 @@
         "type": "boolean",
         "description": "Whether or not to configure the ESLint `parserOptions.project`. We do not do this by default for lint performance reasons.",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/nuxt/generators/application.json

@@ -1,6 +1,6 @@
 {
   "name": "application",
-  "factory": "./src/generators/application/application",
+  "factory": "./src/generators/application/application#applicationGeneratorInternal",
   "schema": {
     "$schema": "https://json-schema.org/schema",
     "cli": "nx",
@@ -100,6 +100,10 @@
         "type": "boolean",
         "description": "Whether or not to configure the ESLint `parserOptions.project` option. We do not do this by default for lint performance reasons.",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],
@@ -108,7 +112,7 @@
   },
   "aliases": ["app"],
   "description": "Create a Nuxt application.",
-  "implementation": "/packages/nuxt/src/generators/application/application.ts",
+  "implementation": "/packages/nuxt/src/generators/application/application#applicationGeneratorInternal.ts",
   "hidden": false,
   "path": "/packages/nuxt/src/generators/application/schema.json",
   "type": "generator"

docs/generated/packages/react-native/generators/application.json

@@ -95,6 +95,10 @@
         "x-prompt": "Which bundler do you want to use to build the application?",
         "default": "vite",
         "x-priority": "important"
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/react-native/generators/library.json

@@ -93,6 +93,10 @@
         "type": "boolean",
         "default": false,
         "x-priority": "internal"
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/react/generators/application.json

@@ -181,6 +181,10 @@
         "description": "Generate a React app with a minimal setup, no separate test files.",
         "type": "boolean",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/react/generators/library.json

@@ -184,6 +184,10 @@
         "description": "Don't include the directory in the name of the module of the library.",
         "type": "boolean",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/remix/generators/application.json

@@ -57,6 +57,10 @@
         "type": "boolean",
         "x-priority": "internal",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/remix/generators/library.json

@@ -81,6 +81,10 @@
         "default": false,
         "description": "Generate a buildable library that uses rollup to bundle.",
         "x-deprecated": "Use the `bundler` option for greater control (none, vite, rollup)."
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/vue/generators/application.json

@@ -133,6 +133,10 @@
         "type": "boolean",
         "default": false,
         "hidden": true
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/vue/generators/library.json

@@ -125,6 +125,10 @@
         "description": "Create a Vue library with a minimal setup, no separate test files.",
         "type": "boolean",
         "default": false
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

docs/generated/packages/web/generators/application.json

@@ -101,6 +101,10 @@
         "type": "boolean",
         "description": "Creates an application with strict mode and strict type checking.",
         "default": true
+      },
+      "useProjectJson": {
+        "type": "boolean",
+        "description": "Use a `project.json` configuration file instead of inlining the Nx configuration in the `package.json` file."
       }
     },
     "required": ["directory"],

packages/detox/src/generators/application/application.spec.ts

@@ -531,6 +531,7 @@ describe('detox application generator', () => {
         linter: Linter.None,
         framework: 'react-native',
         addPlugin: true,
+        useProjectJson: false,
       });
 
       expect(tree.read('tsconfig.json', 'utf-8')).toMatchInlineSnapshot(`
@@ -592,6 +593,7 @@ describe('detox application generator', () => {
         framework: 'react-native',
         addPlugin: true,
         skipFormat: true,
+        useProjectJson: false,
       });
 
       expect(tree.exists('apps/my-app-e2e/test-setup.ts')).toBeTruthy();
@@ -672,6 +674,7 @@ describe('detox application generator', () => {
         framework: 'react-native',
         addPlugin: true,
         skipFormat: true,
+        useProjectJson: false,
       });
 
       const packageJson = readJson(tree, 'apps/my-app-e2e/package.json');
@@ -687,5 +690,38 @@ describe('detox application generator', () => {
         ]
       `);
     });
+
+    it('should generate project.json if useProjectJson is true', async () => {
+      writeJson(tree, 'apps/my-app/package.json', { name: 'my-app' });
+
+      await detoxApplicationGenerator(tree, {
+        e2eDirectory: 'apps/my-app-e2e',
+        appProject: 'my-app',
+        e2eName: 'my-app-e2e',
+        linter: Linter.None,
+        framework: 'react-native',
+        addPlugin: true,
+        skipFormat: true,
+        useProjectJson: true,
+      });
+
+      expect(tree.exists('apps/my-app-e2e/project.json')).toBeTruthy();
+      expect(readProjectConfiguration(tree, 'my-app-e2e'))
+        .toMatchInlineSnapshot(`
+        {
+          "$schema": "../../node_modules/nx/schemas/project-schema.json",
+          "implicitDependencies": [
+            "my-app",
+          ],
+          "name": "my-app-e2e",
+          "projectType": "application",
+          "root": "apps/my-app-e2e",
+          "sourceRoot": "apps/my-app-e2e/src",
+          "tags": [],
+          "targets": {},
+        }
+      `);
+      expect(readJson(tree, 'apps/my-app-e2e/package.json').nx).toBeUndefined();
+    });
   });
 });

packages/detox/src/generators/application/application.ts

@@ -18,6 +18,7 @@ import { sortPackageJsonFields } from '@nx/js/src/utils/package-json/sort-fields
 export async function detoxApplicationGenerator(host: Tree, schema: Schema) {
   return await detoxApplicationGeneratorInternal(host, {
     addPlugin: false,
+    useProjectJson: true,
     ...schema,
   });
 }

packages/detox/src/generators/application/lib/add-project.spec.ts

@@ -41,6 +41,7 @@ describe('Add Project', () => {
         appRoot: 'apps/my-app',
         linter: Linter.EsLint,
         framework: 'react-native',
+        useProjectJson: true,
       });
     });
 
@@ -91,6 +92,7 @@ describe('Add Project', () => {
         appRoot: 'apps/my-dir/my-app',
         linter: Linter.EsLint,
         framework: 'react-native',
+        useProjectJson: true,
       });
     });
 

packages/detox/src/generators/application/lib/add-project.ts

@@ -13,7 +13,7 @@ import {
   reactNativeTestTarget,
 } from './get-targets';
 import { NormalizedSchema } from './normalize-options';
-import { isUsingTsSolutionSetup } from '@nx/js/src/utils/typescript/ts-solution-setup';
+import type { PackageJson } from 'nx/src/utils/package-json';
 
 export function addProject(host: Tree, options: NormalizedSchema) {
   const nxJson = readNxJson(host);
@@ -23,20 +23,21 @@ export function addProject(host: Tree, options: NormalizedSchema) {
       : p.plugin === '@nx/detox/plugin'
   );
 
-  if (isUsingTsSolutionSetup(host)) {
-    writeJson(host, joinPathFragments(options.e2eProjectRoot, 'package.json'), {
-      name: options.importPath,
-      version: '0.0.1',
-      private: true,
-      nx: {
-        name:
-          options.e2eProjectName !== options.importPath
-            ? options.e2eProjectName
-            : undefined,
-        targets: hasPlugin ? undefined : getTargets(options),
-        implicitDependencies: [options.appProject],
-      },
-    });
+  const packageJson: PackageJson = {
+    name: options.importPath,
+    version: '0.0.1',
+    private: true,
+  };
+
+  if (!options.useProjectJson) {
+    packageJson.nx = {
+      name:
+        options.e2eProjectName !== options.importPath
+          ? options.e2eProjectName
+          : undefined,
+      targets: hasPlugin ? undefined : getTargets(options),
+      implicitDependencies: [options.appProject],
+    };
   } else {
     addProjectConfiguration(host, options.e2eProjectName, {
       root: options.e2eProjectRoot,
@@ -47,6 +48,14 @@ export function addProject(host: Tree, options: NormalizedSchema) {
       implicitDependencies: [options.appProject],
     });
   }
+
+  if (!options.useProjectJson || options.isUsingTsSolutionConfig) {
+    writeJson(
+      host,
+      joinPathFragments(options.e2eProjectRoot, 'package.json'),
+      packageJson
+    );
+  }
 }
 
 function getTargets(options: NormalizedSchema) {