@nx/workspace 20.2.2 → 20.3.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/workspace",
-  "version": "20.2.2",
+  "version": "20.3.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,12 @@
     }
   },
   "dependencies": {
-    "@nx/devkit": "20.2.2",
+    "@nx/devkit": "20.3.0-beta.1",
     "chalk": "^4.1.0",
     "enquirer": "~2.3.6",
     "tslib": "^2.3.0",
     "yargs-parser": "21.1.1",
-    "nx": "20.2.2"
+    "nx": "20.3.0-beta.1"
   },
   "publishConfig": {
     "access": "public"

package/src/generators/move/lib/update-imports.js

@@ -7,6 +7,7 @@ const get_import_path_1 = require("../../../utilities/get-import-path");
 const ts_config_1 = require("../../../utilities/ts-config");
 const typescript_1 = require("../../../utilities/typescript");
 const utils_1 = require("./utils");
+const ts_solution_setup_1 = require("../../../utilities/typescript/ts-solution-setup");
 let tsModule;
 /**
  * Updates all the imports in the workspace and modifies the tsconfig appropriately.
@@ -19,9 +20,13 @@ function updateImports(tree, schema, project) {
     }
     const { libsDir } = (0, devkit_1.getWorkspaceLayout)(tree);
     const projects = (0, devkit_1.getProjects)(tree);
+    const isUsingTsSolution = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
     // use the source root to find the from location
     // this attempts to account for libs that have been created with --importPath
-    const tsConfigPath = (0, ts_config_1.getRootTsConfigPathInTree)(tree);
+    const tsConfigPath = isUsingTsSolution
+        ? 'tsconfig.json'
+        : (0, ts_config_1.getRootTsConfigPathInTree)(tree);
+    // If we are using a ts solution setup, we need to use tsconfig.json instead of tsconfig.base.json
     let tsConfig;
     let mainEntryPointImportPath;
     let secondaryEntryPointImportPaths;
@@ -84,25 +89,53 @@ function updateImports(tree, schema, project) {
             to: schema.relativeToRootDestination,
         };
         if (tsConfig) {
-            const path = tsConfig.compilerOptions.paths[projectRef.from];
-            if (!path) {
-                throw new Error([
-                    `unable to find "${projectRef.from}" in`,
-                    `${tsConfigPath} compilerOptions.paths`,
-                ].join(' '));
-            }
-            const updatedPath = path.map((x) => (0, devkit_1.joinPathFragments)(projectRoot.to, (0, path_1.relative)(projectRoot.from, x)));
-            if (schema.updateImportPath && projectRef.to) {
-                tsConfig.compilerOptions.paths[projectRef.to] = updatedPath;
-                if (projectRef.from !== projectRef.to) {
-                    delete tsConfig.compilerOptions.paths[projectRef.from];
-                }
+            if (!isUsingTsSolution) {
+                updateTsConfigPaths(tsConfig, projectRef, tsConfigPath, projectRoot, schema);
             }
             else {
-                tsConfig.compilerOptions.paths[projectRef.from] = updatedPath;
+                updateTsConfigReferences(tsConfig, projectRoot, tsConfigPath, schema);
             }
+            (0, devkit_1.writeJson)(tree, tsConfigPath, tsConfig);
+        }
+    }
+}
+function updateTsConfigReferences(tsConfig, projectRoot, tsConfigPath, schema) {
+    // Since paths can be './path' or 'path' we check if both are the same relative path to the workspace root
+    const projectRefIndex = tsConfig.references.findIndex((ref) => (0, path_1.relative)(ref.path, projectRoot.from) === '');
+    if (projectRefIndex === -1) {
+        throw new Error(`unable to find "${projectRoot.from}" in ${tsConfigPath} references`);
+    }
+    const updatedPath = (0, devkit_1.joinPathFragments)(projectRoot.to, (0, path_1.relative)(projectRoot.from, tsConfig.references[projectRefIndex].path));
+    let normalizedPath = (0, path_1.normalize)(updatedPath);
+    if (!normalizedPath.startsWith('.') &&
+        !normalizedPath.startsWith('../') &&
+        !(0, path_1.isAbsolute)(normalizedPath)) {
+        normalizedPath = `./${normalizedPath}`;
+    }
+    if (schema.updateImportPath && projectRoot.to) {
+        tsConfig.references[projectRefIndex].path = normalizedPath;
+    }
+    else {
+        tsConfig.references.push({ path: normalizedPath });
+    }
+}
+function updateTsConfigPaths(tsConfig, projectRef, tsConfigPath, projectRoot, schema) {
+    const path = tsConfig.compilerOptions.paths[projectRef.from];
+    if (!path) {
+        throw new Error([
+            `unable to find "${projectRef.from}" in`,
+            `${tsConfigPath} compilerOptions.paths`,
+        ].join(' '));
+    }
+    const updatedPath = path.map((x) => (0, devkit_1.joinPathFragments)(projectRoot.to, (0, path_1.relative)(projectRoot.from, x)));
+    if (schema.updateImportPath && projectRef.to) {
+        tsConfig.compilerOptions.paths[projectRef.to] = updatedPath;
+        if (projectRef.from !== projectRef.to) {
+            delete tsConfig.compilerOptions.paths[projectRef.from];
         }
-        (0, devkit_1.writeJson)(tree, tsConfigPath, tsConfig);
+    }
+    else {
+        tsConfig.compilerOptions.paths[projectRef.from] = updatedPath;
     }
 }
 function ensureTrailingSlash(path) {

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

@@ -330,7 +330,11 @@ function setUpWorkspacesInPackageJson(tree, options) {
             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.RemixMonorepo ||
+            options.preset === presets_1.Preset.VueMonorepo ||
+            options.preset === presets_1.Preset.Nuxt ||
+            options.preset === presets_1.Preset.NodeMonorepo ||
+            options.preset === presets_1.Preset.Express) &&
             options.workspaces)) {
         const workspaces = options.workspaceGlobs ?? ['packages/**'];
         if (options.packageManager === 'pnpm') {

package/src/generators/preset/preset.js

@@ -129,6 +129,8 @@ async function createPreset(tree, options) {
             e2eTestRunner: options.e2eTestRunner ?? 'playwright',
             addPlugin,
             nxCloudToken: options.nxCloudToken,
+            useTsSolution: options.workspaces,
+            formatter: options.formatter,
         });
     }
     else if (options.preset === presets_1.Preset.VueStandalone) {
@@ -157,6 +159,8 @@ async function createPreset(tree, options) {
             e2eTestRunner: options.e2eTestRunner ?? 'playwright',
             addPlugin,
             nxCloudToken: options.nxCloudToken,
+            useTsSolution: options.workspaces,
+            formatter: options.formatter,
         });
     }
     else if (options.preset === presets_1.Preset.NuxtStandalone) {
@@ -229,6 +233,8 @@ async function createPreset(tree, options) {
             linter: options.linter,
             e2eTestRunner: options.e2eTestRunner ?? 'jest',
             addPlugin,
+            useTsSolution: options.workspaces,
+            formatter: options.formatter,
         });
     }
     else if (options.preset === presets_1.Preset.Express) {
@@ -239,6 +245,8 @@ async function createPreset(tree, options) {
             linter: options.linter,
             e2eTestRunner: options.e2eTestRunner ?? 'jest',
             addPlugin,
+            useTsSolution: options.workspaces,
+            formatter: options.formatter,
         });
     }
     else if (options.preset === presets_1.Preset.ReactNative) {
@@ -321,6 +329,8 @@ async function createPreset(tree, options) {
             rootProject: false,
             e2eTestRunner: options.e2eTestRunner ?? 'jest',
             addPlugin,
+            useTsSolution: options.workspaces,
+            formatter: options.formatter,
         });
     }
     else {

package/src/generators/remove/lib/update-tsconfig.js

@@ -4,23 +4,38 @@ exports.updateTsconfig = updateTsconfig;
 const devkit_1 = require("@nx/devkit");
 const ts_config_1 = require("../../../utilities/ts-config");
 const find_project_for_path_1 = require("nx/src/project-graph/utils/find-project-for-path");
+const ts_solution_setup_1 = require("../../../utilities/typescript/ts-solution-setup");
+const path_1 = require("path");
 /**
  * Updates the tsconfig paths to remove the project.
  *
  * @param schema The options provided to the schematic
  */
 async function updateTsconfig(tree, schema) {
-    const tsConfigPath = (0, ts_config_1.getRootTsConfigPathInTree)(tree);
+    const isUsingTsSolution = (0, ts_solution_setup_1.isUsingTsSolutionSetup)(tree);
+    const tsConfigPath = isUsingTsSolution
+        ? 'tsconfig.json'
+        : (0, ts_config_1.getRootTsConfigPathInTree)(tree);
     if (tree.exists(tsConfigPath)) {
         const graph = await (0, devkit_1.createProjectGraphAsync)();
         const projectMapping = (0, find_project_for_path_1.createProjectRootMappings)(graph.nodes);
         (0, devkit_1.updateJson)(tree, tsConfigPath, (json) => {
-            for (const importPath in json.compilerOptions.paths) {
-                for (const path of json.compilerOptions.paths[importPath]) {
-                    const project = (0, find_project_for_path_1.findProjectForPath)((0, devkit_1.normalizePath)(path), projectMapping);
-                    if (project === schema.projectName) {
-                        delete json.compilerOptions.paths[importPath];
-                        break;
+            if (isUsingTsSolution) {
+                const projectConfigs = (0, devkit_1.readProjectsConfigurationFromProjectGraph)(graph);
+                const project = projectConfigs.projects[schema.projectName];
+                if (!project) {
+                    throw new Error(`Could not find project '${schema.project}'. Please choose a project that exists in the Nx Workspace.`);
+                }
+                json.references = json.references.filter((ref) => (0, path_1.relative)(ref.path, project.root) !== '');
+            }
+            else {
+                for (const importPath in json.compilerOptions.paths) {
+                    for (const path of json.compilerOptions.paths[importPath]) {
+                        const project = (0, find_project_for_path_1.findProjectForPath)((0, devkit_1.normalizePath)(path), projectMapping);
+                        if (project === schema.projectName) {
+                            delete json.compilerOptions.paths[importPath];
+                            break;
+                        }
                     }
                 }
             }

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

@@ -0,0 +1,2 @@
+import { type Tree } from '@nx/devkit';
+export declare function isUsingTsSolutionSetup(tree?: Tree): boolean;

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

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUsingTsSolutionSetup = isUsingTsSolutionSetup;
+const devkit_1 = require("@nx/devkit");
+const tree_1 = require("nx/src/generators/tree");
+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;
+}
+function isWorkspaceSetupWithTsSolution(tree) {
+    if (!tree.exists('tsconfig.base.json') || !tree.exists('tsconfig.json')) {
+        return false;
+    }
+    const tsconfigJson = (0, devkit_1.readJson)(tree, 'tsconfig.json');
+    if (tsconfigJson.extends !== './tsconfig.base.json') {
+        return false;
+    }
+    /**
+     * New setup:
+     * - `files` is defined and set to an empty array
+     * - `references` is defined and set to an empty array
+     * - `include` is not defined or is set to an empty array
+     */
+    if (!tsconfigJson.files ||
+        tsconfigJson.files.length > 0 ||
+        !tsconfigJson.references ||
+        !!tsconfigJson.include?.length) {
+        return false;
+    }
+    const baseTsconfigJson = (0, devkit_1.readJson)(tree, 'tsconfig.base.json');
+    if (!baseTsconfigJson.compilerOptions ||
+        !baseTsconfigJson.compilerOptions.composite ||
+        !baseTsconfigJson.compilerOptions.declaration) {
+        return false;
+    }
+    const { compilerOptions, ...rest } = baseTsconfigJson;
+    if (Object.keys(rest).length > 0) {
+        return false;
+    }
+    return true;
+}
+function isUsingTsSolutionSetup(tree) {
+    tree ??= new tree_1.FsTree(devkit_1.workspaceRoot, false);
+    return (isUsingPackageManagerWorkspaces(tree) &&
+        isWorkspaceSetupWithTsSolution(tree));
+}