fix(misc): ensure all project generators add project to workspaces config (#29582)

- Update project generators to add the project to the workspaces setup
in the new TS solution setup
- Update some library generators that were not running package
installation

<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

<!-- If this is a particularly complex change or feature addition, you
can request a dedicated Nx release for this pull request branch. Mention
someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they
will confirm if the PR warrants its own release for testing purposes,
and generate it for you if appropriate. -->

## Current Behavior
<!-- This is the behavior we have today -->

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #

Author: leosvelperez

e2e/node/src/node-ts-solution.test.ts

@@ -28,21 +28,6 @@ describe('Node Applications', () => {
       packages: ['@nx/node', '@nx/express', '@nx/nest', '@nx/webpack'],
       preset: 'ts',
     });
-    if (pm === 'pnpm') {
-      updateFile(
-        'pnpm-workspace.yaml',
-        `
-packages:
-  - 'apps/*'
-  - 'packages/*'
-`
-      );
-    } else {
-      updateJson('package.json', (json) => {
-        json.workspaces = ['apps/*', 'packages/*'];
-        return json;
-      });
-    }
   });
 
   afterAll(() => {

e2e/vue/src/vue-ts-solution.test.ts

@@ -18,21 +18,6 @@ describe('Vue Plugin', () => {
       packages: ['@nx/vue'],
       preset: 'ts',
     });
-    if (pm === 'pnpm') {
-      updateFile(
-        'pnpm-workspace.yaml',
-        `
-packages:
-  - 'apps/*'
-  - 'packages/*'
-`
-      );
-    } else {
-      updateJson('package.json', (json) => {
-        json.workspaces = ['apps/*', 'packages/*'];
-        return json;
-      });
-    }
   });
 
   afterAll(() => cleanupProject());

packages/js/src/generators/library/library.spec.ts

@@ -1633,6 +1633,50 @@ describe('lib', () => {
       });
     });
 
+    it.each`
+      directory                  | expected
+      ${'my-ts-lib'}             | ${'my-ts-lib'}
+      ${'libs/my-ts-lib'}        | ${'libs/*'}
+      ${'libs/shared/my-ts-lib'} | ${'libs/shared/*'}
+    `(
+      'should add "$expected" to the workspace when creating a library in "$directory" using pnpm',
+      async ({ directory, expected }) => {
+        tree.write('pnpm-workspace.yaml', '');
+
+        await libraryGenerator(tree, {
+          ...defaultOptions,
+          directory,
+        });
+
+        expect(tree.read('pnpm-workspace.yaml', 'utf-8'))
+          .toMatchInlineSnapshot(`
+        "packages:
+          - '${expected}'
+        "
+      `);
+      }
+    );
+
+    it.each`
+      directory                  | expected
+      ${'my-ts-lib'}             | ${'my-ts-lib'}
+      ${'libs/my-ts-lib'}        | ${'libs/*'}
+      ${'libs/shared/my-ts-lib'} | ${'libs/shared/*'}
+    `(
+      'should add "$expected" to the workspace when creating a library in "$directory" using npm or yarn',
+      async ({ directory, expected }) => {
+        // ensure there's no pnpm-workspace.yaml, so it uses the package.json workspaces
+        tree.delete('pnpm-workspace.yaml');
+
+        await libraryGenerator(tree, {
+          ...defaultOptions,
+          directory,
+        });
+
+        expect(readJson(tree, 'package.json').workspaces).toContain(expected);
+      }
+    );
+
     it('should map non-buildable libraries to source', async () => {
       await libraryGenerator(tree, {
         ...defaultOptions,

packages/js/src/generators/library/library.ts

@@ -36,10 +36,6 @@ import { join } from 'path';
 import type { CompilerOptions } from 'typescript';
 import { normalizeLinterOption } from '../../utils/generator-prompts';
 import { getUpdatedPackageJsonContent } from '../../utils/package-json/update-package-json';
-import {
-  getProjectPackageManagerWorkspaceState,
-  getProjectPackageManagerWorkspaceStateWarningTask,
-} from '../../utils/package-manager-workspaces';
 import { addSwcConfig } from '../../utils/swc/add-swc-config';
 import { getSwcDependencies } from '../../utils/swc/add-swc-dependencies';
 import { getNeededCompilerOptionOverrides } from '../../utils/typescript/configuration';
@@ -53,6 +49,7 @@ import {
   readTsConfigFromTree,
 } from '../../utils/typescript/ts-config';
 import {
+  addProjectToTsSolutionWorkspace,
   isUsingTsSolutionSetup,
   isUsingTypeScriptPlugin,
 } from '../../utils/typescript/ts-solution-setup';
@@ -218,21 +215,14 @@ export async function libraryGeneratorInternal(
     );
   }
 
-  if (!options.skipFormat) {
-    await formatFiles(tree);
+  // If we are using the new TS solution
+  // We need to update the workspace file (package.json or pnpm-workspaces.yaml) to include the new project
+  if (options.isUsingTsSolutionConfig) {
+    addProjectToTsSolutionWorkspace(tree, options.projectRoot);
   }
 
-  if (
-    !options.skipWorkspacesWarning &&
-    options.isUsingTsSolutionConfig &&
-    options.projectPackageManagerWorkspaceState !== 'included'
-  ) {
-    tasks.push(
-      getProjectPackageManagerWorkspaceStateWarningTask(
-        options.projectPackageManagerWorkspaceState,
-        tree.root
-      )
-    );
+  if (!options.skipFormat) {
+    await formatFiles(tree);
   }
 
   if (options.publishable) {
@@ -872,9 +862,6 @@ async function normalizeOptions(
 
   options.minimal ??= false;
 
-  const projectPackageManagerWorkspaceState =
-    getProjectPackageManagerWorkspaceState(tree, projectRoot);
-
   // We default to generate a project.json file if the new setup is not being used
   options.useProjectJson ??= !isUsingTsSolutionConfig;
 
@@ -888,7 +875,6 @@ async function normalizeOptions(
     importPath,
     hasPlugin,
     isUsingTsSolutionConfig,
-    projectPackageManagerWorkspaceState,
   };
 }
 

packages/js/src/generators/library/schema.d.ts

@@ -33,7 +33,6 @@ export interface LibraryGeneratorSchema {
   simpleName?: boolean;
   addPlugin?: boolean;
   useProjectJson?: boolean;
-  skipWorkspacesWarning?: boolean;
   useTscExecutor?: boolean;
 }
 
@@ -47,5 +46,4 @@ export interface NormalizedLibraryGeneratorOptions
   importPath?: string;
   hasPlugin: boolean;
   isUsingTsSolutionConfig: boolean;
-  projectPackageManagerWorkspaceState: ProjectPackageManagerWorkspaceState;
 }

packages/js/src/utils/typescript/ts-solution-setup.ts

@@ -206,11 +206,8 @@ export function addProjectToTsSolutionWorkspace(
   if (tree.exists('pnpm-workspace.yaml')) {
     const { load, dump } = require('@zkochan/js-yaml');
     const workspaceFile = tree.read('pnpm-workspace.yaml', 'utf-8');
-    const yamlData = load(workspaceFile);
-
-    if (!yamlData?.packages) {
-      yamlData.packages = [];
-    }
+    const yamlData = load(workspaceFile) ?? {};
+    yamlData.packages ??= [];
 
     if (!yamlData.packages.includes(pattern)) {
       yamlData.packages.push(pattern);

packages/nest/src/generators/library/library.ts

@@ -30,7 +30,10 @@ export async function libraryGeneratorInternal(
   rawOptions: LibraryGeneratorOptions
 ): Promise<GeneratorCallback> {
   const options = await normalizeOptions(tree, rawOptions);
-  await jsLibraryGenerator(tree, toJsLibraryGeneratorOptions(options));
+  const jsLibraryTask = await jsLibraryGenerator(
+    tree,
+    toJsLibraryGeneratorOptions(options)
+  );
   const initTask = await initGenerator(tree, rawOptions);
   const depsTask = ensureDependencies(tree);
   deleteFiles(tree, options);
@@ -45,6 +48,7 @@ export async function libraryGeneratorInternal(
 
   return runTasksInSerial(
     ...[
+      jsLibraryTask,
       initTask,
       depsTask,
       () => {

packages/node/src/generators/application/application.ts

@@ -56,6 +56,7 @@ import { hasWebpackPlugin } from '../../utils/has-webpack-plugin';
 import { addBuildTargetDefaults } from '@nx/devkit/src/generators/target-defaults-utils';
 import { logShowProjectCommand } from '@nx/devkit/src/utils/log-show-project-command';
 import {
+  addProjectToTsSolutionWorkspace,
   isUsingTsSolutionSetup,
   updateTsconfigFiles,
 } from '@nx/js/src/utils/typescript/ts-solution-setup';
@@ -572,10 +573,6 @@ export async function applicationGeneratorInternal(tree: Tree, schema: Schema) {
     tasks.push(dockerTask);
   }
 
-  if (!options.skipFormat) {
-    await formatFiles(tree);
-  }
-
   if (options.isUsingTsSolutionConfig) {
     updateTsconfigFiles(
       tree,
@@ -591,6 +588,16 @@ export async function applicationGeneratorInternal(tree: Tree, schema: Schema) {
     );
   }
 
+  // If we are using the new TS solution
+  // We need to update the workspace file (package.json or pnpm-workspaces.yaml) to include the new project
+  if (options.isUsingTsSolutionConfig) {
+    addProjectToTsSolutionWorkspace(tree, options.appProjectRoot);
+  }
+
+  if (!options.skipFormat) {
+    await formatFiles(tree);
+  }
+
   tasks.push(() => {
     logShowProjectCommand(options.name);
   });

packages/node/src/generators/e2e-project/e2e-project.ts

@@ -30,7 +30,10 @@ import {
 } from '@nx/eslint/src/generators/utils/eslint-file';
 import { logShowProjectCommand } from '@nx/devkit/src/utils/log-show-project-command';
 import { findRootJestPreset } from '@nx/jest/src/utils/config/config-file';
-import { isUsingTsSolutionSetup } from '@nx/js/src/utils/typescript/ts-solution-setup';
+import {
+  addProjectToTsSolutionWorkspace,
+  isUsingTsSolutionSetup,
+} from '@nx/js/src/utils/typescript/ts-solution-setup';
 import { getImportPath } from '@nx/js/src/utils/get-import-path';
 import { relative } from 'node:path/posix';
 
@@ -230,10 +233,6 @@ export async function e2eProjectGeneratorInternal(
     }
   }
 
-  if (!options.skipFormat) {
-    await formatFiles(host);
-  }
-
   if (isUsingTsSolutionConfig) {
     updateJson(host, 'tsconfig.json', (json) => {
       json.references ??= [];
@@ -245,6 +244,16 @@ export async function e2eProjectGeneratorInternal(
     });
   }
 
+  // If we are using the new TS solution
+  // We need to update the workspace file (package.json or pnpm-workspaces.yaml) to include the new project
+  if (isUsingTsSolutionConfig) {
+    addProjectToTsSolutionWorkspace(host, options.e2eProjectRoot);
+  }
+
+  if (!options.skipFormat) {
+    await formatFiles(host);
+  }
+
   tasks.push(() => {
     logShowProjectCommand(options.e2eProjectName);
   });

packages/node/src/generators/library/library.ts

@@ -29,7 +29,10 @@ import { tslibVersion, typesNodeVersion } from '../../utils/versions';
 import { initGenerator } from '../init/init';
 import { Schema } from './schema';
 import { addBuildTargetDefaults } from '@nx/devkit/src/generators/target-defaults-utils';
-import { isUsingTsSolutionSetup } from '@nx/js/src/utils/typescript/ts-solution-setup';
+import {
+  addProjectToTsSolutionWorkspace,
+  isUsingTsSolutionSetup,
+} from '@nx/js/src/utils/typescript/ts-solution-setup';
 import { getImportPath } from '@nx/js/src/utils/get-import-path';
 
 export interface NormalizedSchema extends Schema {
@@ -108,6 +111,12 @@ export async function libraryGeneratorInternal(tree: Tree, schema: Schema) {
     tasks.push(() => installPackagesTask(tree, true));
   }
 
+  // If we are using the new TS solution
+  // We need to update the workspace file (package.json or pnpm-workspaces.yaml) to include the new project
+  if (options.isUsingTsSolutionConfig) {
+    addProjectToTsSolutionWorkspace(tree, options.projectRoot);
+  }
+
   if (!schema.skipFormat) {
     await formatFiles(tree);
   }

packages/nuxt/src/generators/application/application.ts

@@ -33,7 +33,10 @@ import {
   createNxCloudOnboardingURLForWelcomeApp,
 } from 'nx/src/nx-cloud/utilities/onboarding';
 import { getImportPath } from '@nx/js/src/utils/get-import-path';
-import { updateTsconfigFiles } from '@nx/js/src/utils/typescript/ts-solution-setup';
+import {
+  addProjectToTsSolutionWorkspace,
+  updateTsconfigFiles,
+} from '@nx/js/src/utils/typescript/ts-solution-setup';
 
 export async function applicationGenerator(tree: Tree, schema: Schema) {
   const tasks: GeneratorCallback[] = [];
@@ -170,22 +173,6 @@ export async function applicationGenerator(tree: Tree, schema: Schema) {
 
   if (options.js) toJS(tree);
 
-  if (!options.skipFormat) await formatFiles(tree);
-
-  tasks.push(() => {
-    try {
-      execSync(`npx -y nuxi prepare`, {
-        cwd: options.appProjectRoot,
-
-        windowsHide: false,
-      });
-    } catch (e) {
-      console.error(
-        `Failed to run \`nuxi prepare\` in "${options.appProjectRoot}". Please run the command manually.`
-      );
-    }
-  });
-
   if (options.isUsingTsSolutionConfig) {
     updateTsconfigFiles(
       tree,
@@ -204,6 +191,28 @@ export async function applicationGenerator(tree: Tree, schema: Schema) {
     );
   }
 
+  // If we are using the new TS solution
+  // We need to update the workspace file (package.json or pnpm-workspaces.yaml) to include the new project
+  if (options.isUsingTsSolutionConfig) {
+    addProjectToTsSolutionWorkspace(tree, options.appProjectRoot);
+  }
+
+  if (!options.skipFormat) await formatFiles(tree);
+
+  tasks.push(() => {
+    try {
+      execSync(`npx -y nuxi prepare`, {
+        cwd: options.appProjectRoot,
+
+        windowsHide: false,
+      });
+    } catch (e) {
+      console.error(
+        `Failed to run \`nuxi prepare\` in "${options.appProjectRoot}". Please run the command manually.`
+      );
+    }
+  });
+
   tasks.push(() => {
     logShowProjectCommand(options.projectName);
   });