@nx/js 19.2.0-canary.20240604-0594deb → 19.2.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "19.2.0-canary.20240604-0594deb",
+  "version": "19.2.0-rc.0",
   "private": false,
   "description": "The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. ",
   "repository": {
@@ -58,9 +58,9 @@
     "semver": "^7.5.3",
     "source-map-support": "0.5.19",
     "tslib": "^2.3.0",
-    "@nx/devkit": "19.2.0-canary.20240604-0594deb",
-    "@nx/workspace": "19.2.0-canary.20240604-0594deb",
-    "@nrwl/js": "19.2.0-canary.20240604-0594deb"
+    "@nx/devkit": "19.2.0-rc.0",
+    "@nx/workspace": "19.2.0-rc.0",
+    "@nrwl/js": "19.2.0-rc.0"
   },
   "peerDependencies": {
     "verdaccio": "^5.0.4"

package/src/generators/init/init.js

@@ -86,6 +86,7 @@ async function initGenerator(tree, schema) {
         /dist
         /coverage
         /.nx/cache
+        /.nx/workspace-data
       `);
     }
     if (tree.exists('.vscode/extensions.json')) {

package/src/generators/release-version/release-version.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.releaseVersionGenerator = void 0;
 const devkit_1 = require("@nx/devkit");
 const chalk = require("chalk");
+const fs_extra_1 = require("fs-extra");
 const node_child_process_1 = require("node:child_process");
 const node_path_1 = require("node:path");
 const config_1 = require("nx/src/command-line/release/config/config");
@@ -15,8 +16,8 @@ const ora = require("ora");
 const semver_2 = require("semver");
 const npm_config_1 = require("../../utils/npm-config");
 const resolve_local_package_dependencies_1 = require("./utils/resolve-local-package-dependencies");
-const update_lock_file_1 = require("./utils/update-lock-file");
 const sort_projects_topologically_1 = require("./utils/sort-projects-topologically");
+const update_lock_file_1 = require("./utils/update-lock-file");
 async function releaseVersionGenerator(tree, options) {
     try {
         const versionData = {};
@@ -65,6 +66,7 @@ Valid values are: ${version_1.validReleaseVersionPrefixes
         let specifier = options.specifier
             ? options.specifier
             : undefined;
+        const deleteVersionPlanCallbacks = [];
         for (const project of projects) {
             const projectName = project.name;
             const packageRoot = projectNameToPackageRootMap.get(projectName);
@@ -197,6 +199,8 @@ To fix this you will either need to add a package.json file at that location, or
             }
             if (options.specifier) {
                 log(`📄 Using the provided version specifier "${options.specifier}".`);
+                // The user is forcibly overriding whatever specifierSource they had otherwise set by imperatively providing a specifier
+                options.specifierSource = 'prompt';
             }
             /**
              * If we are versioning independently then we always need to determine the specifier for each project individually, except
@@ -271,8 +275,76 @@ To fix this you will either need to add a package.json file at that location, or
                         }
                         break;
                     }
+                    case 'version-plans': {
+                        if (!options.releaseGroup.versionPlans) {
+                            if (options.releaseGroup.name === config_1.IMPLICIT_DEFAULT_RELEASE_GROUP) {
+                                throw new Error(`Invalid specifierSource "version-plans" provided. To enable version plans, set the "release.versionPlans" configuration option to "true" in nx.json.`);
+                            }
+                            else {
+                                throw new Error(`Invalid specifierSource "version-plans" provided. To enable version plans for release group "${options.releaseGroup.name}", set the "versionPlans" configuration option to "true" within the release group configuration in nx.json.`);
+                            }
+                        }
+                        if (options.releaseGroup.projectsRelationship === 'independent') {
+                            specifier = options.releaseGroup.versionPlans.reduce((spec, plan) => {
+                                if (!spec) {
+                                    return plan.projectVersionBumps[projectName];
+                                }
+                                if (plan.projectVersionBumps[projectName]) {
+                                    const prevNewVersion = (0, semver_2.inc)(currentVersion, spec);
+                                    const nextNewVersion = (0, semver_2.inc)(currentVersion, plan.projectVersionBumps[projectName]);
+                                    return (0, semver_2.gt)(nextNewVersion, prevNewVersion)
+                                        ? plan.projectVersionBumps[projectName]
+                                        : spec;
+                                }
+                                return spec;
+                            }, null);
+                        }
+                        else {
+                            specifier = options.releaseGroup.versionPlans.reduce((spec, plan) => {
+                                if (!spec) {
+                                    return plan.groupVersionBump;
+                                }
+                                const prevNewVersion = (0, semver_2.inc)(currentVersion, spec);
+                                const nextNewVersion = (0, semver_2.inc)(currentVersion, plan.groupVersionBump);
+                                return (0, semver_2.gt)(nextNewVersion, prevNewVersion)
+                                    ? plan.groupVersionBump
+                                    : spec;
+                            }, null);
+                        }
+                        if (!specifier) {
+                            if (updateDependents !== 'never' &&
+                                projectToDependencyBumps.has(projectName)) {
+                                // No applicable changes to the project directly by the user, but one or more dependencies have been bumped and updateDependents is enabled
+                                specifier = updateDependentsBump;
+                                log(`📄 Resolved the specifier as "${specifier}" because "release.version.generatorOptions.updateDependents" is enabled`);
+                            }
+                            else {
+                                specifier = null;
+                                log(`🚫 No changes were detected within version plans.`);
+                            }
+                        }
+                        else {
+                            log(`📄 Resolved the specifier as "${specifier}" using version plans.`);
+                        }
+                        if (options.deleteVersionPlans) {
+                            options.releaseGroup.versionPlans.forEach((p) => {
+                                deleteVersionPlanCallbacks.push(async (dryRun) => {
+                                    if (!dryRun) {
+                                        await (0, fs_extra_1.remove)(p.absolutePath);
+                                        // the relative path is easier to digest, so use that for
+                                        // git operations and logging
+                                        return [p.relativePath];
+                                    }
+                                    else {
+                                        return [];
+                                    }
+                                });
+                            });
+                        }
+                        break;
+                    }
                     default:
-                        throw new Error(`Invalid specifierSource "${specifierSource}" provided. Must be one of "prompt" or "conventional-commits"`);
+                        throw new Error(`Invalid specifierSource "${specifierSource}" provided. Must be one of "prompt", "conventional-commits" or "version-plans".`);
                 }
             }
             // Resolve any local package dependencies for this project (before applying the new version or updating the versionData)
@@ -306,7 +378,16 @@ To fix this you will either need to add a package.json file at that location, or
                     circularDependencies.add(`${dependentProject.source}:${dependentProject.target}`);
                     circularDependencies.add(`${dependentProject.target}:${dependentProject.source}`);
                 }
-                const isInCurrentBatch = options.projects.some((project) => project.name === dependentProject.source);
+                let isInCurrentBatch = options.projects.some((project) => project.name === dependentProject.source);
+                // For version-plans, we don't just need to consider the current batch of projects, but also the ones that are actually being updated as part of the plan file(s)
+                if (isInCurrentBatch && options.specifierSource === 'version-plans') {
+                    isInCurrentBatch = (options.releaseGroup.versionPlans || []).some((plan) => {
+                        if ('projectVersionBumps' in plan) {
+                            return plan.projectVersionBumps[dependentProject.source];
+                        }
+                        return true;
+                    });
+                }
                 if (!isInCurrentBatch) {
                     dependentProjectsOutsideCurrentBatch.push(dependentProject);
                 }
@@ -318,11 +399,14 @@ To fix this you will either need to add a package.json file at that location, or
             if (updateDependents === 'never') {
                 if (dependentProjectsOutsideCurrentBatch.length > 0) {
                     let logMsg = `⚠️  Warning, the following packages depend on "${project.name}"`;
+                    const reason = options.specifierSource === 'version-plans'
+                        ? 'because they are not referenced in any version plans'
+                        : 'via --projects';
                     if (options.releaseGroup.name === config_1.IMPLICIT_DEFAULT_RELEASE_GROUP) {
-                        logMsg += ` but have been filtered out via --projects, and therefore will not be updated:`;
+                        logMsg += ` but have been filtered out ${reason}, and therefore will not be updated:`;
                     }
                     else {
-                        logMsg += ` but are either not part of the current release group "${options.releaseGroup.name}", or have been filtered out via --projects, and therefore will not be updated:`;
+                        logMsg += ` but are either not part of the current release group "${options.releaseGroup.name}", or have been filtered out ${reason}, and therefore will not be updated:`;
                     }
                     const indent = Array.from(new Array(projectName.length + 4))
                         .map(() => ' ')
@@ -425,12 +509,20 @@ To fix this you will either need to add a package.json file at that location, or
             }
             if (updateDependents === 'auto') {
                 for (const dependentProject of dependentProjectsOutsideCurrentBatch) {
+                    if (options.specifierSource === 'version-plans' &&
+                        !projectToDependencyBumps.has(dependentProject.source)) {
+                        projectToDependencyBumps.set(dependentProject.source, new Set([projectName]));
+                    }
                     updateDependentProjectAndAddToVersionData({
                         dependentProject,
                         dependencyPackageName: packageName,
                         newDependencyVersion: newVersion,
                         // For these additional dependents, we need to update their package.json version as well because we know they will not come later in the topologically sorted projects loop
-                        forceVersionBump: updateDependentsBump,
+                        // (Unless using version plans and the dependent is not filtered out by --projects)
+                        forceVersionBump: options.specifierSource === 'version-plans' &&
+                            projects.find((p) => p.name === dependentProject.source)
+                            ? false
+                            : updateDependentsBump,
                     });
                 }
             }
@@ -468,9 +560,14 @@ To fix this you will either need to add a package.json file at that location, or
         return {
             data: versionData,
             callback: async (tree, opts) => {
+                const changedFiles = [];
+                const deletedFiles = [];
+                for (const cb of deleteVersionPlanCallbacks) {
+                    deletedFiles.push(...(await cb(opts.dryRun)));
+                }
                 const cwd = tree.root;
-                const updatedFiles = await (0, update_lock_file_1.updateLockFile)(cwd, opts);
-                return updatedFiles;
+                changedFiles.push(...(await (0, update_lock_file_1.updateLockFile)(cwd, opts)));
+                return { changedFiles, deletedFiles };
             },
         };
     }

package/src/generators/release-version/schema.json

@@ -29,7 +29,7 @@
       "type": "string",
       "default": "prompt",
       "description": "Which approach to use to determine the semver specifier used to bump the version of the project.",
-      "enum": ["prompt", "conventional-commits"]
+      "enum": ["prompt", "conventional-commits", "version-plans"]
     },
     "preid": {
       "type": "string",

package/src/plugins/typescript/plugin.js

@@ -11,7 +11,7 @@ const minimatch_1 = require("minimatch");
 const lock_file_1 = require("nx/src/plugins/js/lock-file/lock-file");
 const cache_directory_1 = require("nx/src/utils/cache-directory");
 const ts_config_1 = require("../../utils/typescript/ts-config");
-const cachePath = (0, node_path_1.join)(cache_directory_1.projectGraphCacheDirectory, 'tsc.hash');
+const cachePath = (0, node_path_1.join)(cache_directory_1.workspaceDataDirectory, 'tsc.hash');
 const targetsCache = readTargetsCache();
 function readTargetsCache() {
     return (0, node_fs_1.existsSync)(cachePath) ? (0, devkit_1.readJsonFile)(cachePath) : {};