@nx/js 19.7.0 → 19.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nx/js",
-  "version": "19.7.0",
+  "version": "19.7.2",
   "private": false,
   "description": "The JS plugin for Nx contains executors and generators that provide the best experience for developing JavaScript and TypeScript projects. ",
   "repository": {
@@ -39,8 +39,8 @@
     "@babel/preset-env": "^7.23.2",
     "@babel/preset-typescript": "^7.22.5",
     "@babel/runtime": "^7.22.6",
-    "@nx/devkit": "19.7.0",
-    "@nx/workspace": "19.7.0",
+    "@nx/devkit": "19.7.2",
+    "@nx/workspace": "19.7.2",
     "babel-plugin-const-enum": "^1.0.1",
     "babel-plugin-macros": "^2.8.0",
     "babel-plugin-transform-typescript-metadata": "^0.3.1",
@@ -61,7 +61,7 @@
     "ts-node": "10.9.1",
     "tsconfig-paths": "^4.1.2",
     "tslib": "^2.3.0",
-    "@nrwl/js": "19.7.0"
+    "@nrwl/js": "19.7.2"
   },
   "peerDependencies": {
     "verdaccio": "^5.0.4"

package/src/executors/release-publish/release-publish.impl.js

@@ -5,10 +5,11 @@ const devkit_1 = require("@nx/devkit");
 const child_process_1 = require("child_process");
 const npm_run_path_1 = require("npm-run-path");
 const path_1 = require("path");
+const is_locally_linked_package_version_1 = require("../../utils/is-locally-linked-package-version");
 const npm_config_1 = require("../../utils/npm-config");
+const extract_npm_publish_json_data_1 = require("./extract-npm-publish-json-data");
 const log_tar_1 = require("./log-tar");
 const chalk = require("chalk");
-const extract_npm_publish_json_data_1 = require("./extract-npm-publish-json-data");
 const LARGE_BUFFER = 1024 * 1000000;
 function processEnv(color) {
     const env = {
@@ -21,6 +22,7 @@ function processEnv(color) {
     return env;
 }
 async function runExecutor(options, context) {
+    const pm = (0, devkit_1.detectPackageManager)();
     /**
      * We need to check both the env var and the option because the executor may have been triggered
      * indirectly via dependsOn, in which case the env var will be set, but the option will not.
@@ -31,6 +33,28 @@ async function runExecutor(options, context) {
     const packageJsonPath = (0, path_1.join)(packageRoot, 'package.json');
     const packageJson = (0, devkit_1.readJsonFile)(packageJsonPath);
     const packageName = packageJson.name;
+    /**
+     * pnpm supports dynamically updating locally linked packages during its packing phase, but other package managers do not.
+     * Therefore, protect the user from publishing invalid packages by checking if it contains local dependency protocols.
+     */
+    if (pm !== 'pnpm') {
+        const depTypes = ['dependencies', 'devDependencies', 'peerDependencies'];
+        for (const depType of depTypes) {
+            const deps = packageJson[depType];
+            if (deps) {
+                for (const depName in deps) {
+                    if ((0, is_locally_linked_package_version_1.isLocallyLinkedPackageVersion)(deps[depName])) {
+                        console.error(`Error: Cannot publish package "${packageName}" because it contains a local dependency protocol in its "${depType}", and your package manager is ${pm}.
+
+Please update the local dependency on "${depName}" to be a valid semantic version (e.g. using \`nx release\`) before publishing, or switch to pnpm as a package manager, which supports dynamically replacing these protocols during publishing.`);
+                        return {
+                            success: false,
+                        };
+                    }
+                }
+            }
+        }
+    }
     // If package and project name match, we can make log messages terser
     let packageTxt = packageName === context.projectName
         ? `package "${packageName}"`
@@ -63,7 +87,7 @@ async function runExecutor(options, context) {
      * request with.
      *
      * Therefore, so as to not produce misleading output in dry around dist-tags being altered, we do not
-     * perform the npm view step, and just show npm publish's dry-run output.
+     * perform the npm view step, and just show npm/pnpm publish's dry-run output.
      */
     if (!isDryRun && !options.firstRelease) {
         const currentVersion = packageJson.version;
@@ -154,35 +178,38 @@ async function runExecutor(options, context) {
     }
     /**
      * NOTE: If this is ever changed away from running the command at the workspace root and pointing at the package root (e.g. back
-     * to running from the package root directly), then special attention should be paid to the fact that npm publish will nest its
+     * to running from the package root directly), then special attention should be paid to the fact that npm/pnpm publish will nest its
      * JSON output under the name of the package in that case (and it would need to be handled below).
      */
-    const npmPublishCommandSegments = [
-        `npm publish "${packageRoot}" --json --"${registryConfigKey}=${registry}" --tag=${tag}`,
+    const publishCommandSegments = [
+        pm === 'pnpm'
+            ? // Unlike npm, pnpm publish does not support a custom registryConfigKey option, and will error on uncommitted changes by default if --no-git-checks is not set
+                `pnpm publish "${packageRoot}" --json --registry="${registry}" --tag=${tag} --no-git-checks`
+            : `npm publish "${packageRoot}" --json --"${registryConfigKey}=${registry}" --tag=${tag}`,
     ];
     if (options.otp) {
-        npmPublishCommandSegments.push(`--otp=${options.otp}`);
+        publishCommandSegments.push(`--otp=${options.otp}`);
     }
     if (options.access) {
-        npmPublishCommandSegments.push(`--access=${options.access}`);
+        publishCommandSegments.push(`--access=${options.access}`);
     }
     if (isDryRun) {
-        npmPublishCommandSegments.push(`--dry-run`);
+        publishCommandSegments.push(`--dry-run`);
     }
     try {
-        const output = (0, child_process_1.execSync)(npmPublishCommandSegments.join(' '), {
+        const output = (0, child_process_1.execSync)(publishCommandSegments.join(' '), {
             maxBuffer: LARGE_BUFFER,
             env: processEnv(true),
             cwd: context.root,
             stdio: ['ignore', 'pipe', 'pipe'],
         });
         /**
-         * We cannot JSON.parse the output directly because if the user is using lifecycle scripts, npm will mix its publish output with the JSON output all on stdout.
+         * We cannot JSON.parse the output directly because if the user is using lifecycle scripts, npm/pnpm will mix its publish output with the JSON output all on stdout.
          * Additionally, we want to capture and show the lifecycle script outputs as beforeJsonData and afterJsonData and print them accordingly below.
          */
         const { beforeJsonData, jsonData, afterJsonData } = (0, extract_npm_publish_json_data_1.extractNpmPublishJsonData)(output.toString());
         if (!jsonData) {
-            console.error('The npm publish output data could not be extracted. Please report this issue on https://github.com/nrwl/nx');
+            console.error(`The ${pm} publish output data could not be extracted. Please report this issue on https://github.com/nrwl/nx`);
             return {
                 success: false,
             };
@@ -218,7 +245,7 @@ async function runExecutor(options, context) {
     catch (err) {
         try {
             const stdoutData = JSON.parse(err.stdout?.toString() || '{}');
-            console.error('npm publish error:');
+            console.error(`${pm} publish error:`);
             if (stdoutData.error?.summary) {
                 console.error(stdoutData.error.summary);
             }
@@ -226,7 +253,7 @@ async function runExecutor(options, context) {
                 console.error(stdoutData.error.detail);
             }
             if (context.isVerbose) {
-                console.error('npm publish stdout:');
+                console.error(`${pm} publish stdout:`);
                 console.error(JSON.stringify(stdoutData, null, 2));
             }
             if (!stdoutData.error) {
@@ -237,7 +264,7 @@ async function runExecutor(options, context) {
             };
         }
         catch (err) {
-            console.error('Something unexpected went wrong when processing the npm publish output\n', err);
+            console.error(`Something unexpected went wrong when processing the ${pm} publish output\n`, err);
             return {
                 success: false,
             };

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

@@ -14,6 +14,7 @@ const version_1 = require("nx/src/command-line/release/version");
 const utils_1 = require("nx/src/tasks-runner/utils");
 const ora = require("ora");
 const semver_2 = require("semver");
+const is_locally_linked_package_version_1 = require("../../utils/is-locally-linked-package-version");
 const npm_config_1 = require("../../utils/npm-config");
 const resolve_local_package_dependencies_1 = require("./utils/resolve-local-package-dependencies");
 const sort_projects_topologically_1 = require("./utils/sort-projects-topologically");
@@ -237,7 +238,8 @@ To fix this you will either need to add a package.json file at that location, or
                         }
                         specifier = await (0, resolve_semver_specifier_1.resolveSemverSpecifierFromConventionalCommits)(previousVersionRef, options.projectGraph, affectedProjects, options.conventionalCommitsConfig);
                         if (!specifier) {
-                            if (projectToDependencyBumps.has(projectName)) {
+                            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;
                                 logger.buffer(`📄 Resolved the specifier as "${specifier}" because "release.version.generatorOptions.updateDependents" is enabled`);
@@ -471,7 +473,7 @@ To fix this you will either need to add a package.json file at that location, or
                     // Depending on the package manager, locally linked packages could reference packages with `"private": true` and no version field at all
                     const currentPackageVersion = json.version ?? null;
                     if (!currentPackageVersion &&
-                        isLocallyLinkedPackageVersion(currentDependencyVersion)) {
+                        (0, is_locally_linked_package_version_1.isLocallyLinkedPackageVersion)(currentDependencyVersion)) {
                         if (forceVersionBump) {
                             // Look up any dependent projects from the transitiveLocalPackageDependents list
                             const transitiveDependentProjects = transitiveLocalPackageDependents.filter((localPackageDependency) => localPackageDependency.target === dependentProject.source);
@@ -496,10 +498,14 @@ To fix this you will either need to add a package.json file at that location, or
                             }
                         }
                     }
-                    // Apply the new version of the dependency to the dependent
-                    const newDepVersion = `${versionPrefix}${newDependencyVersion}`;
-                    json[dependentProject.dependencyCollection][dependencyPackageName] =
-                        newDepVersion;
+                    // Apply the new version of the dependency to the dependent (if not preserving locally linked package protocols)
+                    const shouldUpdateDependency = !((0, is_locally_linked_package_version_1.isLocallyLinkedPackageVersion)(currentDependencyVersion) &&
+                        options.preserveLocalDependencyProtocols);
+                    if (shouldUpdateDependency) {
+                        const newDepVersion = `${versionPrefix}${newDependencyVersion}`;
+                        json[dependentProject.dependencyCollection][dependencyPackageName] =
+                            newDepVersion;
+                    }
                     // Bump the dependent's version if applicable and record it in the version data
                     if (forceVersionBump) {
                         const newPackageVersion = (0, version_1.deriveNewSemverVersion)(currentPackageVersion, forceVersionBump, options.preid);
@@ -669,33 +675,3 @@ class ProjectLogger {
         });
     }
 }
-let pm;
-let pmVersion;
-const localPackageProtocols = [
-    'file:', // all package managers
-    'workspace:', // not npm
-    'portal:', // modern yarn only
-];
-function isLocallyLinkedPackageVersion(version) {
-    // Not using a supported local protocol
-    if (!localPackageProtocols.some((protocol) => version.startsWith(protocol))) {
-        return false;
-    }
-    // Supported by all package managers
-    if (version.startsWith('file:')) {
-        return true;
-    }
-    // Determine specific package manager in use
-    if (!pm) {
-        pm = (0, devkit_1.detectPackageManager)();
-        pmVersion = (0, devkit_1.getPackageManagerVersion)(pm);
-    }
-    if (pm === 'npm' && version.startsWith('workspace:')) {
-        throw new Error(`The "workspace:" protocol is not yet supported by npm (https://github.com/npm/rfcs/issues/765). Please ensure you have a valid setup according to your package manager before attempting to release packages.`);
-    }
-    if (version.startsWith('portal:') &&
-        (pm !== 'yarn' || (0, semver_2.lt)(pmVersion, '2.0.0'))) {
-        throw new Error(`The "portal:" protocol is only supported by yarn@2.0.0 and above. Please ensure you have a valid setup according to your package manager before attempting to release packages.`);
-    }
-    return true;
-}

package/src/utils/is-locally-linked-package-version.d.ts

@@ -0,0 +1 @@
+export declare function isLocallyLinkedPackageVersion(version: string): boolean;

package/src/utils/is-locally-linked-package-version.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLocallyLinkedPackageVersion = isLocallyLinkedPackageVersion;
+const devkit_1 = require("@nx/devkit");
+// import { lt } from 'semver';
+let pm;
+// let pmVersion: string | undefined;
+const localPackageProtocols = [
+    'file:', // all package managers
+    'workspace:', // not npm
+    // TODO: Support portal protocol at the project graph level before enabling here
+    // 'portal:', // modern yarn only
+];
+function isLocallyLinkedPackageVersion(version) {
+    // Not using a supported local protocol
+    if (!localPackageProtocols.some((protocol) => version.startsWith(protocol))) {
+        return false;
+    }
+    // Supported by all package managers
+    if (version.startsWith('file:')) {
+        return true;
+    }
+    // Determine specific package manager in use
+    if (!pm) {
+        pm = (0, devkit_1.detectPackageManager)();
+        // pmVersion = getPackageManagerVersion(pm);
+    }
+    if (pm === 'npm' && version.startsWith('workspace:')) {
+        throw new Error(`The "workspace:" protocol is not yet supported by npm (https://github.com/npm/rfcs/issues/765). Please ensure you have a valid setup according to your package manager before attempting to release packages.`);
+    }
+    // TODO: Support portal protocol at the project graph level before enabling here
+    // if (
+    //   version.startsWith('portal:') &&
+    //   (pm !== 'yarn' || lt(pmVersion, '2.0.0'))
+    // ) {
+    //   throw new Error(
+    //     `The "portal:" protocol is only supported by yarn@2.0.0 and above. Please ensure you have a valid setup according to your package manager before attempting to release packages.`
+    //   );
+    // }
+    return true;
+}