@nx/workspace 20.5.0-rc.4 → 20.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/workspace",
-  "version": "20.5.0-rc.4",
+  "version": "20.5.1",
   "private": false,
   "description": "The Workspace plugin contains executors and generators that are useful for any Nx workspace. It should be present in every Nx workspace and other plugins build on it.",
   "repository": {
@@ -38,12 +38,14 @@
     }
   },
   "dependencies": {
-    "@nx/devkit": "20.5.0-rc.4",
+    "@nx/devkit": "20.5.1",
+    "@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",
-    "nx": "20.5.0-rc.4"
+    "nx": "20.5.1"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/move/move.d.ts

@@ -1,4 +1,4 @@
-import { Tree } from '@nx/devkit';
+import { type GeneratorCallback, type Tree } from '@nx/devkit';
 import { Schema } from './schema';
-export declare function moveGenerator(tree: Tree, rawSchema: Schema): Promise<void>;
+export declare function moveGenerator(tree: Tree, rawSchema: Schema): Promise<GeneratorCallback>;
 export default moveGenerator;

package/src/generators/move/move.js

@@ -2,8 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.moveGenerator = moveGenerator;
 const devkit_1 = require("@nx/devkit");
+const package_manager_workspaces_1 = require("../../utilities/package-manager-workspaces");
+const ts_solution_setup_1 = require("../../utilities/typescript/ts-solution-setup");
 const check_destination_1 = require("./lib/check-destination");
 const create_project_configuration_in_new_destination_1 = require("./lib/create-project-configuration-in-new-destination");
+const extract_base_configs_1 = require("./lib/extract-base-configs");
 const move_project_files_1 = require("./lib/move-project-files");
 const normalize_schema_1 = require("./lib/normalize-schema");
 const run_angular_plugin_1 = require("./lib/run-angular-plugin");
@@ -18,9 +21,9 @@ const update_package_json_1 = require("./lib/update-package-json");
 const update_project_root_files_1 = require("./lib/update-project-root-files");
 const update_readme_1 = require("./lib/update-readme");
 const update_storybook_config_1 = require("./lib/update-storybook-config");
-const extract_base_configs_1 = require("./lib/extract-base-configs");
 async function moveGenerator(tree, rawSchema) {
     let projectConfig = (0, devkit_1.readProjectConfiguration)(tree, rawSchema.projectName);
+    const wasIncludedInWorkspaces = (0, package_manager_workspaces_1.isProjectIncludedInPackageManagerWorkspaces)(tree, projectConfig.root);
     const schema = await (0, normalize_schema_1.normalizeSchema)(tree, rawSchema, projectConfig);
     (0, check_destination_1.checkDestination)(tree, schema, rawSchema.destination);
     if (projectConfig.root === '.') {
@@ -48,8 +51,23 @@ async function moveGenerator(tree, rawSchema) {
         (0, extract_base_configs_1.maybeMigrateEslintConfigIfRootProject)(tree, projectConfig);
     }
     await (0, run_angular_plugin_1.runAngularPlugin)(tree, schema);
+    let task;
+    if (wasIncludedInWorkspaces) {
+        // check if the new destination is included in the package manager workspaces
+        const isIncludedInWorkspaces = (0, package_manager_workspaces_1.isProjectIncludedInPackageManagerWorkspaces)(tree, schema.destination);
+        if (!isIncludedInWorkspaces) {
+            // the new destination is not included in the package manager workspaces
+            // so we need to add it and run a package install to ensure the symlink
+            // is created
+            await (0, ts_solution_setup_1.addProjectToTsSolutionWorkspace)(tree, schema.destination);
+            task = () => (0, devkit_1.installPackagesTask)(tree, true);
+        }
+    }
     if (!schema.skipFormat) {
         await (0, devkit_1.formatFiles)(tree);
     }
+    if (task) {
+        return task;
+    }
 }
 exports.default = moveGenerator;

package/src/utilities/package-manager-workspaces.d.ts

@@ -0,0 +1,5 @@
+import { type Tree } from '@nx/devkit';
+export declare function isProjectIncludedInPackageManagerWorkspaces(tree: Tree, projectRoot: string): boolean;
+export declare function getPackageManagerWorkspacesPatterns(tree: Tree): string[];
+export declare function isUsingPackageManagerWorkspaces(tree: Tree): boolean;
+export declare function isWorkspacesEnabled(tree: Tree): boolean;

package/src/utilities/package-manager-workspaces.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isProjectIncludedInPackageManagerWorkspaces = isProjectIncludedInPackageManagerWorkspaces;
+exports.getPackageManagerWorkspacesPatterns = getPackageManagerWorkspacesPatterns;
+exports.isUsingPackageManagerWorkspaces = isUsingPackageManagerWorkspaces;
+exports.isWorkspacesEnabled = isWorkspacesEnabled;
+const devkit_1 = require("@nx/devkit");
+const posix_1 = require("node:path/posix");
+const package_json_1 = require("nx/src/plugins/package-json");
+const picomatch = require("picomatch");
+function isProjectIncludedInPackageManagerWorkspaces(tree, projectRoot) {
+    if (!isUsingPackageManagerWorkspaces(tree)) {
+        return false;
+    }
+    const patterns = getPackageManagerWorkspacesPatterns(tree);
+    return patterns.some((p) => picomatch(p)((0, posix_1.join)(projectRoot, 'package.json')));
+}
+function getPackageManagerWorkspacesPatterns(tree) {
+    return (0, package_json_1.getGlobPatternsFromPackageManagerWorkspaces)(tree.root, (path) => (0, devkit_1.readJson)(tree, path, { expectComments: true }), (path) => {
+        const content = tree.read(path, 'utf-8');
+        const { load } = require('@zkochan/js-yaml');
+        return load(content, { filename: path });
+    }, (path) => tree.exists(path));
+}
+function isUsingPackageManagerWorkspaces(tree) {
+    return isWorkspacesEnabled(tree);
+}
+function isWorkspacesEnabled(tree) {
+    const packageManager = (0, devkit_1.detectPackageManager)(tree.root);
+    if (packageManager === 'pnpm') {
+        return tree.exists('pnpm-workspace.yaml');
+    }
+    // yarn and npm both use the same 'workspaces' property in package.json
+    if (tree.exists('package.json')) {
+        const packageJson = (0, devkit_1.readJson)(tree, 'package.json');
+        return !!packageJson?.workspaces;
+    }
+    return false;
+}

package/src/utilities/typescript/ts-solution-setup.d.ts

@@ -1,2 +1,3 @@
 import { type Tree } from '@nx/devkit';
 export declare function isUsingTsSolutionSetup(tree?: Tree): boolean;
+export declare function addProjectToTsSolutionWorkspace(tree: Tree, projectDir: string): Promise<void>;

package/src/utilities/typescript/ts-solution-setup.js

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isUsingTsSolutionSetup = isUsingTsSolutionSetup;
+exports.addProjectToTsSolutionWorkspace = addProjectToTsSolutionWorkspace;
 const devkit_1 = require("@nx/devkit");
+const posix_1 = require("node:path/posix");
 const tree_1 = require("nx/src/generators/tree");
+const package_manager_workspaces_1 = require("../package-manager-workspaces");
 function isUsingPackageManagerWorkspaces(tree) {
     return isWorkspacesEnabled(tree);
 }
@@ -55,3 +58,48 @@ function isUsingTsSolutionSetup(tree) {
     return (isUsingPackageManagerWorkspaces(tree) &&
         isWorkspaceSetupWithTsSolution(tree));
 }
+async function addProjectToTsSolutionWorkspace(tree, projectDir) {
+    const isIncluded = (0, package_manager_workspaces_1.isProjectIncludedInPackageManagerWorkspaces)(tree, projectDir);
+    if (isIncluded) {
+        return;
+    }
+    // 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 = (0, posix_1.dirname)(projectDir);
+    let pattern = projectDir;
+    if (baseDir !== '.') {
+        const patterns = (0, package_manager_workspaces_1.getPackageManagerWorkspacesPatterns)(tree);
+        const projectsBefore = await (0, devkit_1.globAsync)(tree, patterns);
+        patterns.push(`${baseDir}/*/package.json`);
+        const projectsAfter = await (0, devkit_1.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');
+        const yamlData = load(workspaceFile) ?? {};
+        yamlData.packages ??= [];
+        if (!yamlData.packages.includes(pattern)) {
+            yamlData.packages.push(pattern);
+            tree.write('pnpm-workspace.yaml', dump(yamlData, { indent: 2, quotingType: '"', forceQuotes: true }));
+        }
+    }
+    else {
+        // Update package.json
+        const packageJson = (0, devkit_1.readJson)(tree, 'package.json');
+        if (!packageJson.workspaces) {
+            packageJson.workspaces = [];
+        }
+        if (!packageJson.workspaces.includes(pattern)) {
+            packageJson.workspaces.push(pattern);
+            tree.write('package.json', JSON.stringify(packageJson, null, 2));
+        }
+    }
+}