@nx/workspace 20.5.0 → 20.6.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/workspace",
-  "version": "20.5.0",
+  "version": "20.6.0-beta.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",
+    "@nx/devkit": "20.6.0-beta.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"
+    "nx": "20.6.0-beta.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/generators/new/generate-preset.js

@@ -70,6 +70,9 @@ function generatePreset(host, opts) {
                 : null,
             parsedArgs.interactive ? '--interactive=true' : '--interactive=false',
             opts.routing !== undefined ? `--routing=${opts.routing}` : null,
+            opts.useReactRouter !== undefined
+                ? `--useReactRouter=${opts.useReactRouter}`
+                : null,
             opts.unitTestRunner !== undefined
                 ? `--unitTestRunner=${opts.unitTestRunner}`
                 : null,
@@ -81,7 +84,7 @@ function generatePreset(host, opts) {
             opts.prefix !== undefined ? `--prefix=${opts.prefix}` : null,
             opts.nxCloudToken ? `--nxCloudToken=${opts.nxCloudToken}` : null,
             opts.formatter ? `--formatter=${opts.formatter}` : null,
-            opts.workspaces ? `--workspaces` : null,
+            opts.workspaces !== false ? `--workspaces` : `--no-workspaces`,
         ].filter((e) => !!e);
     }
 }
@@ -112,9 +115,6 @@ function getPresetDependencies({ preset, presetVersion, bundler, e2eTestRunner,
         case presets_1.Preset.NextJs:
         case presets_1.Preset.NextJsStandalone:
             return { dependencies: { '@nx/next': versions_1.nxVersion }, dev: {} };
-        case presets_1.Preset.RemixStandalone:
-        case presets_1.Preset.RemixMonorepo:
-            return { dependencies: { '@nx/remix': versions_1.nxVersion }, dev: {} };
         case presets_1.Preset.VueMonorepo:
         case presets_1.Preset.VueStandalone:
             return {

package/src/generators/new/generate-workspace-files.js

@@ -52,16 +52,6 @@ const presetToPluginMap = {
         generateLibCmd: '@nx/react',
         learnMoreLink: 'https://nx.dev/nx-api/next?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
     },
-    [presets_1.Preset.RemixMonorepo]: {
-        generateAppCmd: '@nx/remix',
-        generateLibCmd: '@nx/react',
-        learnMoreLink: 'https://nx.dev/nx-api/remix?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
-    },
-    [presets_1.Preset.RemixStandalone]: {
-        generateAppCmd: '@nx/remix',
-        generateLibCmd: '@nx/react',
-        learnMoreLink: 'https://nx.dev/nx-api/remix?utm_source=nx_project&utm_medium=readme&utm_campaign=nx_projects',
-    },
     [presets_1.Preset.ReactNative]: {
         generateAppCmd: '@nx/react-native',
         generateLibCmd: '@nx/react',
@@ -207,12 +197,11 @@ function createFiles(tree, options) {
         options.preset === presets_1.Preset.NuxtStandalone ||
         options.preset === presets_1.Preset.NodeStandalone ||
         options.preset === presets_1.Preset.NextJsStandalone ||
-        options.preset === presets_1.Preset.RemixStandalone ||
         options.preset === presets_1.Preset.TsStandalone
         ? './files-root-app'
         : (options.preset === presets_1.Preset.TS &&
-            process.env.NX_ADD_PLUGINS !== 'false' &&
-            process.env.NX_ADD_TS_PLUGIN !== 'false') ||
+            options.workspaces &&
+            process.env.NX_ADD_PLUGINS !== 'false') ||
             options.preset === presets_1.Preset.NPM
             ? './files-package-based-repo'
             : './files-integrated-repo';
@@ -227,7 +216,7 @@ function createFiles(tree, options) {
         packageManager: options.packageManager,
     });
 }
-async function createReadme(tree, { name, appName, directory, preset, nxCloud }, nxCloudToken) {
+async function createReadme(tree, { name, appName, directory, preset, nxCloud, workspaces }, nxCloudToken) {
     const formattedNames = (0, devkit_1.names)(name);
     // default to an empty one for custom presets
     const presetInfo = presetToPluginMap[preset] ?? {
@@ -241,8 +230,7 @@ async function createReadme(tree, { name, appName, directory, preset, nxCloud },
         formattedNames,
         isJsStandalone: preset === presets_1.Preset.TsStandalone,
         isTsPreset: preset === presets_1.Preset.TS,
-        isUsingNewTsSolutionSetup: process.env.NX_ADD_PLUGINS !== 'false' &&
-            process.env.NX_ADD_TS_PLUGIN !== 'false',
+        isUsingNewTsSolutionSetup: process.env.NX_ADD_PLUGINS !== 'false' && workspaces,
         isEmptyRepo: !appName,
         appName,
         generateAppCmd: presetInfo.generateAppCmd,
@@ -325,12 +313,11 @@ function setUpWorkspacesInPackageJson(tree, options) {
     if (options.preset === presets_1.Preset.NPM ||
         (options.preset === presets_1.Preset.TS &&
             process.env.NX_ADD_PLUGINS !== 'false' &&
-            process.env.NX_ADD_TS_PLUGIN !== 'false') ||
+            options.workspaces) ||
         ((options.preset === presets_1.Preset.Expo ||
             options.preset === presets_1.Preset.NextJs ||
             options.preset === presets_1.Preset.ReactMonorepo ||
             options.preset === presets_1.Preset.ReactNative ||
-            options.preset === presets_1.Preset.RemixMonorepo ||
             options.preset === presets_1.Preset.VueMonorepo ||
             options.preset === presets_1.Preset.Nuxt ||
             options.preset === presets_1.Preset.NodeMonorepo ||

package/src/generators/new/new.d.ts

@@ -17,6 +17,7 @@ interface Schema {
     bundler?: 'vite' | 'webpack';
     standaloneApi?: boolean;
     routing?: boolean;
+    useReactRouter?: boolean;
     packageManager?: PackageManager;
     unitTestRunner?: 'jest' | 'vitest' | 'none';
     e2eTestRunner?: 'cypress' | 'playwright' | 'detox' | 'jest' | 'none';

package/src/generators/new/schema.json

@@ -25,6 +25,11 @@
       "type": "boolean",
       "default": true
     },
+    "useReactRouter": {
+      "description": "Use React Router for routing.",
+      "type": "boolean",
+      "default": false
+    },
     "standaloneApi": {
       "description": "Use Standalone Components if generating an Angular application.",
       "type": "boolean",
@@ -105,7 +110,7 @@
     "workspaces": {
       "description": "Whether to use package manager workspaces.",
       "type": "boolean",
-      "default": false
+      "default": true
     }
   },
   "additionalProperties": true

package/src/generators/preset/preset.js

@@ -70,9 +70,12 @@ async function createPreset(tree, options) {
             unitTestRunner: options.unitTestRunner ??
                 (options.bundler === 'vite' ? 'vitest' : 'jest'),
             addPlugin,
+            routing: options.routing,
+            useReactRouter: options.useReactRouter,
             nxCloudToken: options.nxCloudToken,
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.ReactStandalone) {
@@ -86,6 +89,8 @@ async function createPreset(tree, options) {
             linter: options.linter,
             rootProject: true,
             bundler,
+            routing: options.routing,
+            useReactRouter: options.useReactRouter,
             e2eTestRunner: options.e2eTestRunner ?? 'playwright',
             unitTestRunner: options.unitTestRunner ?? (bundler === 'vite' ? 'vitest' : 'jest'),
             addPlugin,
@@ -93,36 +98,6 @@ async function createPreset(tree, options) {
             formatter: options.formatter,
         });
     }
-    else if (options.preset === presets_1.Preset.RemixMonorepo) {
-        const { applicationGenerator: remixApplicationGenerator } = require('@nx' +
-            '/remix/generators');
-        return remixApplicationGenerator(tree, {
-            name: options.name,
-            directory: (0, path_1.join)('apps', options.name),
-            linter: options.linter,
-            e2eTestRunner: options.e2eTestRunner ?? 'playwright',
-            unitTestRunner: options.unitTestRunner ?? 'vitest',
-            addPlugin,
-            nxCloudToken: options.nxCloudToken,
-            useTsSolution: options.workspaces,
-            formatter: options.formatter,
-        });
-    }
-    else if (options.preset === presets_1.Preset.RemixStandalone) {
-        const { applicationGenerator: remixApplicationGenerator } = require('@nx' +
-            '/remix/generators');
-        return remixApplicationGenerator(tree, {
-            name: options.name,
-            directory: '.',
-            linter: options.linter,
-            e2eTestRunner: options.e2eTestRunner ?? 'playwright',
-            rootProject: true,
-            unitTestRunner: options.unitTestRunner ?? 'vitest',
-            addPlugin,
-            nxCloudToken: options.nxCloudToken,
-            formatter: options.formatter,
-        });
-    }
     else if (options.preset === presets_1.Preset.VueMonorepo) {
         const { applicationGenerator: vueApplicationGenerator } = require('@nx' +
             '/vue');
@@ -137,6 +112,7 @@ async function createPreset(tree, options) {
             nxCloudToken: options.nxCloudToken,
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.VueStandalone) {
@@ -168,6 +144,7 @@ async function createPreset(tree, options) {
             nxCloudToken: options.nxCloudToken,
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.NuxtStandalone) {
@@ -200,6 +177,7 @@ async function createPreset(tree, options) {
             addPlugin,
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.NextJsStandalone) {
@@ -245,6 +223,7 @@ async function createPreset(tree, options) {
             addPlugin,
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.Express) {
@@ -258,6 +237,7 @@ async function createPreset(tree, options) {
             addPlugin,
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.ReactNative) {
@@ -274,6 +254,7 @@ async function createPreset(tree, options) {
             bundler: options.bundler ?? 'webpack',
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.Expo) {
@@ -288,14 +269,14 @@ async function createPreset(tree, options) {
             nxCloudToken: options.nxCloudToken,
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.TS) {
         const { initGenerator } = require('@nx' + '/js');
         return initGenerator(tree, {
             formatter: options.formatter,
-            addTsPlugin: process.env.NX_ADD_PLUGINS !== 'false' &&
-                process.env.NX_ADD_TS_PLUGIN !== 'false',
+            addTsPlugin: process.env.NX_ADD_PLUGINS !== 'false' && options.workspaces,
         });
     }
     else if (options.preset === presets_1.Preset.TsStandalone) {
@@ -346,6 +327,7 @@ async function createPreset(tree, options) {
             addPlugin,
             useTsSolution: options.workspaces,
             formatter: options.formatter,
+            useProjectJson: !options.workspaces,
         });
     }
     else {

package/src/generators/preset/schema.d.ts

@@ -16,6 +16,7 @@ export interface Schema {
   nextAppDir?: boolean;
   nextSrcDir?: boolean;
   routing?: boolean;
+  useReactRouter?: boolean;
   standaloneApi?: boolean;
   unitTestRunner?: 'jest' | 'vitest' | 'none';
   e2eTestRunner?: 'cypress' | 'playwright' | 'jest' | 'detox' | 'none';

package/src/generators/preset/schema.json

@@ -25,6 +25,11 @@
       "type": "boolean",
       "default": true
     },
+    "useReactRouter": {
+      "description": "Use React Router for routing.",
+      "type": "boolean",
+      "default": false
+    },
     "style": {
       "description": "The file extension to be used for style files.",
       "type": "string",
@@ -122,7 +127,7 @@
     "workspaces": {
       "description": "Whether to use package manager workspaces.",
       "type": "boolean",
-      "default": false
+      "default": true
     }
   },
   "required": ["preset", "name"]

package/src/generators/utils/presets.d.ts

@@ -8,8 +8,6 @@ export declare enum Preset {
     ReactMonorepo = "react-monorepo",
     ReactStandalone = "react-standalone",
     NextJsStandalone = "nextjs-standalone",
-    RemixMonorepo = "remix-monorepo",
-    RemixStandalone = "remix-standalone",
     ReactNative = "react-native",
     VueMonorepo = "vue-monorepo",
     VueStandalone = "vue-standalone",

package/src/generators/utils/presets.js

@@ -12,8 +12,6 @@ var Preset;
     Preset["ReactMonorepo"] = "react-monorepo";
     Preset["ReactStandalone"] = "react-standalone";
     Preset["NextJsStandalone"] = "nextjs-standalone";
-    Preset["RemixMonorepo"] = "remix-monorepo";
-    Preset["RemixStandalone"] = "remix-standalone";
     Preset["ReactNative"] = "react-native";
     Preset["VueMonorepo"] = "vue-monorepo";
     Preset["VueStandalone"] = "vue-standalone";

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));
+        }
+    }
+}