fix(core): handle package manager workspaces configuration in move generator (#30268)

## Current Behavior

Moving a project included in the package manager workspaces setup to a
new destination that's not matched by that configuration results in the
project not included in the package manager workspaces setup.

## Expected Behavior

Moving a project included in the package manager workspaces setup to a
new destination that's not matched by that configuration should result
in the new destination included in the workspaces setup.

## Related Issue(s)

Fixes #

Author: leosvelperez

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

@@ -60,7 +60,7 @@ export async function detoxApplicationGeneratorInternal(
   );
 
   if (options.isUsingTsSolutionConfig) {
-    addProjectToTsSolutionWorkspace(host, options.e2eProjectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.e2eProjectRoot);
   }
 
   sortPackageJsonFields(host, options.e2eProjectRoot);

packages/expo/src/generators/application/application.ts

@@ -65,7 +65,7 @@ export async function expoApplicationGeneratorInternal(
   // 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.isTsSolutionSetup) {
-    addProjectToTsSolutionWorkspace(host, options.appProjectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.appProjectRoot);
   }
 
   const lintTask = await addLinting(host, {

packages/expo/src/generators/library/library.ts

@@ -70,7 +70,7 @@ export async function expoLibraryGeneratorInternal(
   }
 
   if (options.isUsingTsSolutionConfig) {
-    addProjectToTsSolutionWorkspace(host, options.projectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.projectRoot);
   }
 
   const initTask = await init(host, { ...options, skipFormat: true });

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

@@ -2303,6 +2303,28 @@ describe('lib', () => {
       );
     });
 
+    it('should add the project root to the package manager workspaces config when a more generic pattern would match other projects that were not previously included', async () => {
+      tree.write(
+        'not-included-dir/some-other-project-not-included/package.json',
+        '{}'
+      );
+
+      await libraryGenerator(tree, {
+        ...defaultOptions,
+        directory: 'not-included-dir/my-lib',
+        bundler: 'tsc',
+        unitTestRunner: 'none',
+        linter: 'none',
+      });
+
+      expect(readJson(tree, 'package.json').workspaces).toContain(
+        'not-included-dir/my-lib'
+      );
+      expect(readJson(tree, 'package.json').workspaces).not.toContain(
+        'not-included-dir/*'
+      );
+    });
+
     it('should not add a pattern for a project that already matches an existing pattern', async () => {
       updateJson(tree, 'package.json', (json) => {
         json.workspaces = ['packages/**'];

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

@@ -100,12 +100,6 @@ export async function libraryGeneratorInternal(
   );
   const options = await normalizeOptions(tree, 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.projectRoot);
-  }
-
   createFiles(tree, options);
 
   await configureProject(tree, options);
@@ -114,6 +108,12 @@ export async function libraryGeneratorInternal(
     tasks.push(addProjectDependencies(tree, options));
   }
 
+  // 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) {
+    await addProjectToTsSolutionWorkspace(tree, options.projectRoot);
+  }
+
   if (options.bundler === 'rollup') {
     const { configurationGenerator } = ensurePackage('@nx/rollup', nxVersion);
     await configurationGenerator(tree, {

packages/js/src/utils/package-manager-workspaces.ts

@@ -25,7 +25,16 @@ export function getProjectPackageManagerWorkspaceState(
     return 'no-workspaces';
   }
 
-  const patterns = getGlobPatternsFromPackageManagerWorkspaces(
+  const patterns = getPackageManagerWorkspacesPatterns(tree);
+  const isIncluded = patterns.some((p) =>
+    picomatch(p)(join(projectRoot, 'package.json'))
+  );
+
+  return isIncluded ? 'included' : 'excluded';
+}
+
+export function getPackageManagerWorkspacesPatterns(tree: Tree): string[] {
+  return getGlobPatternsFromPackageManagerWorkspaces(
     tree.root,
     (path) => readJson(tree, path, { expectComments: true }),
     (path) => {
@@ -35,11 +44,6 @@ export function getProjectPackageManagerWorkspaceState(
     },
     (path) => tree.exists(path)
   );
-  const isIncluded = patterns.some((p) =>
-    picomatch(p)(join(projectRoot, 'package.json'))
-  );
-
-  return isIncluded ? 'included' : 'excluded';
 }
 
 export function isUsingPackageManagerWorkspaces(tree: Tree): boolean {

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

@@ -1,4 +1,5 @@
 import {
+  globAsync,
   joinPathFragments,
   offsetFromRoot,
   output,
@@ -11,6 +12,7 @@ import {
 import { basename, dirname, join } from 'node:path/posix';
 import { FsTree } from 'nx/src/generators/tree';
 import {
+  getPackageManagerWorkspacesPatterns,
   getProjectPackageManagerWorkspaceState,
   isUsingPackageManagerWorkspaces,
 } from '../package-manager-workspaces';
@@ -211,7 +213,7 @@ export function updateTsconfigFiles(
   }
 }
 
-export function addProjectToTsSolutionWorkspace(
+export async function addProjectToTsSolutionWorkspace(
   tree: Tree,
   projectDir: string
 ) {
@@ -220,11 +222,26 @@ export function addProjectToTsSolutionWorkspace(
     return;
   }
 
-  // If dir is "libs/foo" then use "libs/*" so we don't need so many entries in the workspace file.
-  // If dir is nested like "libs/shared/foo" then we add "libs/shared/*".
-  // If the dir is just "foo" then we have to add it as is.
+  // If dir is "libs/foo", we try to use "libs/*" but we only do it if it's
+  // safe to do so. So, we first check if adding that pattern doesn't result
+  // in extra projects being matched. If extra projects are matched, or the
+  // dir is just "foo" then we add it as is.
   const baseDir = dirname(projectDir);
-  const pattern = baseDir === '.' ? projectDir : `${baseDir}/*`;
+  let pattern = projectDir;
+  if (baseDir !== '.') {
+    const patterns = getPackageManagerWorkspacesPatterns(tree);
+    const projectsBefore = await globAsync(tree, patterns);
+    patterns.push(`${baseDir}/*/package.json`);
+    const projectsAfter = await globAsync(tree, patterns);
+
+    if (projectsBefore.length + 1 === projectsAfter.length) {
+      // Adding the pattern to the parent directory only results in one extra
+      // project being matched, which is the project we're adding. It's safe
+      // to add the pattern to the parent directory.
+      pattern = `${baseDir}/*`;
+    }
+  }
+
   if (tree.exists('pnpm-workspace.yaml')) {
     const { load, dump } = require('@zkochan/js-yaml');
     const workspaceFile = tree.read('pnpm-workspace.yaml', 'utf-8');

packages/next/src/generators/application/application.ts

@@ -73,7 +73,7 @@ export async function applicationGeneratorInternal(host: 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.isTsSolutionSetup) {
-    addProjectToTsSolutionWorkspace(host, options.appProjectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.appProjectRoot);
   }
 
   const e2eTask = await addE2e(host, options);

packages/next/src/generators/library/library.ts

@@ -168,7 +168,7 @@ export async function libraryGeneratorInternal(host: Tree, rawOptions: Schema) {
   );
 
   if (options.isUsingTsSolutionConfig) {
-    addProjectToTsSolutionWorkspace(host, options.projectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.projectRoot);
   }
 
   sortPackageJsonFields(host, options.projectRoot);

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

@@ -516,7 +516,7 @@ 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);
+    await addProjectToTsSolutionWorkspace(tree, options.appProjectRoot);
   }
 
   updateTsConfigOptions(tree, options);

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

@@ -259,7 +259,7 @@ 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);
+    await addProjectToTsSolutionWorkspace(host, options.e2eProjectRoot);
   }
 
   if (!options.skipFormat) {

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

@@ -57,7 +57,7 @@ export async function libraryGeneratorInternal(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.projectRoot);
+    await addProjectToTsSolutionWorkspace(tree, options.projectRoot);
   }
 
   const tasks: GeneratorCallback[] = [];

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

@@ -151,7 +151,7 @@ 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);
+    await addProjectToTsSolutionWorkspace(tree, options.appProjectRoot);
   }
 
   tasks.push(

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

@@ -258,7 +258,7 @@ export async function e2eProjectGeneratorInternal(host: 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.isTsSolutionSetup) {
-    addProjectToTsSolutionWorkspace(host, options.projectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.projectRoot);
   }
 
   if (!options.skipFormat) {

packages/react-native/src/generators/application/application.ts

@@ -69,7 +69,7 @@ export async function reactNativeApplicationGeneratorInternal(
   // 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.isTsSolutionSetup) {
-    addProjectToTsSolutionWorkspace(host, options.appProjectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.appProjectRoot);
   }
 
   const lintTask = await addLinting(host, {

packages/react-native/src/generators/library/library.ts

@@ -88,7 +88,7 @@ export async function reactNativeLibraryGeneratorInternal(
   }
 
   if (options.isUsingTsSolutionConfig) {
-    addProjectToTsSolutionWorkspace(host, options.projectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.projectRoot);
   }
 
   const lintTask = await addLinting(host, {

packages/react/src/generators/application/application.ts

@@ -72,12 +72,6 @@ export async function applicationGeneratorInternal(
 
   const options = await normalizeOptions(tree, 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);
-  }
-
   showPossibleWarnings(tree, options);
 
   const initTask = await reactInitGenerator(tree, {
@@ -115,6 +109,12 @@ export async function applicationGeneratorInternal(
   await createApplicationFiles(tree, options);
   addProject(tree, options);
 
+  // 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) {
+    await addProjectToTsSolutionWorkspace(tree, options.appProjectRoot);
+  }
+
   if (options.style === 'tailwind') {
     const twTask = await setupTailwindGenerator(tree, {
       project: options.projectName,

packages/react/src/generators/library/library.ts

@@ -62,7 +62,7 @@ export async function libraryGeneratorInternal(host: Tree, schema: Schema) {
   const options = await normalizeOptions(host, schema);
 
   if (options.isUsingTsSolutionConfig) {
-    addProjectToTsSolutionWorkspace(host, options.projectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.projectRoot);
   }
 
   if (options.publishable === true && !schema.importPath) {

packages/remix/src/generators/application/application.impl.ts

@@ -85,7 +85,7 @@ export async function remixApplicationGeneratorInternal(
   // 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);
+    await addProjectToTsSolutionWorkspace(tree, options.projectRoot);
   }
 
   if (!options.isUsingTsSolutionConfig) {

packages/remix/src/generators/library/library.impl.ts

@@ -30,7 +30,7 @@ export async function remixLibraryGeneratorInternal(
   const options = await normalizeOptions(tree, schema);
 
   if (options.isUsingTsSolutionConfig) {
-    addProjectToTsSolutionWorkspace(tree, options.projectRoot);
+    await addProjectToTsSolutionWorkspace(tree, options.projectRoot);
   }
 
   const jsInitTask = await jsInitGenerator(tree, {

packages/vue/src/generators/application/application.ts

@@ -56,7 +56,7 @@ export async function applicationGeneratorInternal(
   // 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);
+    await addProjectToTsSolutionWorkspace(tree, options.appProjectRoot);
   }
 
   const nxJson = readNxJson(tree);

packages/vue/src/generators/library/library.ts

@@ -56,7 +56,7 @@ export async function libraryGeneratorInternal(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.projectRoot);
+    await addProjectToTsSolutionWorkspace(tree, options.projectRoot);
   }
 
   if (options.isUsingTsSolutionConfig) {

packages/web/src/generators/application/application.ts

@@ -301,7 +301,7 @@ export async function applicationGeneratorInternal(host: Tree, schema: Schema) {
   const options = await normalizeOptions(host, schema);
 
   if (options.isUsingTsSolutionConfig) {
-    addProjectToTsSolutionWorkspace(host, options.appProjectRoot);
+    await addProjectToTsSolutionWorkspace(host, options.appProjectRoot);
   }
 
   const tasks: GeneratorCallback[] = [];

packages/workspace/package.json

@@ -39,8 +39,10 @@
   },
   "dependencies": {
     "@nx/devkit": "file:../devkit",
+    "@zkochan/js-yaml": "0.0.7",
     "chalk": "^4.1.0",
     "enquirer": "~2.3.6",
+    "picomatch": "4.0.2",
     "tslib": "^2.3.0",
     "yargs-parser": "21.1.1"
   },