nx 19.7.0-beta.2 → 19.7.0-beta.4

package/src/command-line/release/command-object.js

@@ -8,7 +8,7 @@ const logger_1 = require("../../utils/logger");
 const shared_options_1 = require("../yargs-utils/shared-options");
 exports.yargsReleaseCommand = {
     command: 'release',
-    describe: 'Orchestrate versioning and publishing of applications and libraries',
+    describe: 'Orchestrate versioning and publishing of applications and libraries.',
     builder: (yargs) => (0, shared_options_1.withVerbose)(yargs)
         .command(releaseCommand)
         .command(versionCommand)
@@ -29,10 +29,10 @@ exports.yargsReleaseCommand = {
         type: 'string',
         alias: 'p',
         coerce: shared_options_1.parseCSV,
-        describe: 'Projects to run. (comma/space delimited project names and/or patterns)',
+        describe: 'Projects to run. (comma/space delimited project names and/or patterns).',
     })
         .option('dry-run', {
-        describe: 'Preview the changes without updating files/creating releases',
+        describe: 'Preview the changes without updating files/creating releases.',
         alias: 'd',
         type: 'boolean',
         default: false,
@@ -40,7 +40,7 @@ exports.yargsReleaseCommand = {
         // NOTE: The camel case format is required for the coerce() function to be called correctly. It still supports --print-config casing.
         .option('printConfig', {
         type: 'string',
-        describe: 'Print the resolved nx release configuration that would be used for the current command and then exit',
+        describe: 'Print the resolved nx release configuration that would be used for the current command and then exit.',
         coerce: (val) => {
             if (val === '') {
                 return true;
@@ -72,7 +72,7 @@ exports.yargsReleaseCommand = {
 };
 const releaseCommand = {
     command: '$0 [specifier]',
-    describe: 'Create a version and release for the workspace, generate a changelog, and optionally publish the packages',
+    describe: 'Create a version and release for the workspace, generate a changelog, and optionally publish the packages.',
     builder: (yargs) => withFirstReleaseOptions(yargs)
         .positional('specifier', {
         type: 'string',
@@ -81,11 +81,11 @@ const releaseCommand = {
         .option('yes', {
         type: 'boolean',
         alias: 'y',
-        description: 'Automatically answer yes to the confirmation prompt for publishing',
+        description: 'Automatically answer yes to the confirmation prompt for publishing.',
     })
         .option('skip-publish', {
         type: 'boolean',
-        description: 'Skip publishing by automatically answering no to the confirmation prompt for publishing',
+        description: 'Skip publishing by automatically answering no to the confirmation prompt for publishing.',
     })
         .check((argv) => {
         if (argv.yes !== undefined && argv.skipPublish !== undefined) {
@@ -105,7 +105,7 @@ const releaseCommand = {
 const versionCommand = {
     command: 'version [specifier]',
     aliases: ['v'],
-    describe: 'Create a version and release for one or more applications and libraries',
+    describe: 'Create a version and release for one or more applications and libraries.',
     builder: (yargs) => withFirstReleaseOptions(withGitCommitAndGitTagOptions(yargs
         .positional('specifier', {
         type: 'string',
@@ -113,7 +113,7 @@ const versionCommand = {
     })
         .option('preid', {
         type: 'string',
-        describe: 'The optional prerelease identifier to apply to the version. This will only be applied in the case that the specifier argument has been set to `prerelease` OR when conventional commits are enabled, in which case it will modify the resolved specifier from conventional commits to be its prerelease equivalent. E.g. minor -> preminor',
+        describe: 'The optional prerelease identifier to apply to the version. This will only be applied in the case that the specifier argument has been set to `prerelease` OR when conventional commits are enabled, in which case it will modify the resolved specifier from conventional commits to be its prerelease equivalent. E.g. minor -> preminor.',
         default: '',
     })
         .option('stage-changes', {
@@ -132,32 +132,32 @@ const versionCommand = {
 const changelogCommand = {
     command: 'changelog [version]',
     aliases: ['c'],
-    describe: 'Generate a changelog for one or more projects, and optionally push to Github',
+    describe: 'Generate a changelog for one or more projects, and optionally push to Github.',
     builder: (yargs) => withFirstReleaseOptions(withGitCommitAndGitTagOptions(yargs
         // Disable default meaning of yargs version for this command
         .version(false)
         .positional('version', {
         type: 'string',
-        description: 'The version to create a Github release and changelog for',
+        description: 'The version to create a Github release and changelog for.',
     })
         .option('from', {
         type: 'string',
-        description: 'The git reference to use as the start of the changelog. If not set it will attempt to resolve the latest tag and use that',
+        description: 'The git reference to use as the start of the changelog. If not set it will attempt to resolve the latest tag and use that.',
     })
         .option('to', {
         type: 'string',
-        description: 'The git reference to use as the end of the changelog',
+        description: 'The git reference to use as the end of the changelog.',
         default: 'HEAD',
     })
         .option('interactive', {
         alias: 'i',
         type: 'string',
-        description: 'Interactively modify changelog markdown contents in your code editor before applying the changes. You can set it to be interactive for all changelogs, or only the workspace level, or only the project level',
+        description: 'Interactively modify changelog markdown contents in your code editor before applying the changes. You can set it to be interactive for all changelogs, or only the workspace level, or only the project level.',
         choices: ['all', 'workspace', 'projects'],
     })
         .option('git-remote', {
         type: 'string',
-        description: 'Alternate git remote in the form {user}/{repo} on which to create the Github release (useful for testing)',
+        description: 'Alternate git remote in the form {user}/{repo} on which to create the Github release (useful for testing).',
         default: 'origin',
     })
         .check((argv) => {
@@ -178,19 +178,24 @@ const changelogCommand = {
 const publishCommand = {
     command: 'publish',
     aliases: ['p'],
-    describe: 'Publish a versioned project to a registry',
+    describe: 'Publish a versioned project to a registry.',
     builder: (yargs) => withFirstReleaseOptions((0, shared_options_1.withRunManyOptions)((0, shared_options_1.withOutputStyleOption)(yargs))
         .option('registry', {
         type: 'string',
-        description: 'The registry to publish to',
+        description: 'The registry to publish to.',
     })
         .option('tag', {
         type: 'string',
-        description: 'The distribution tag to apply to the published package',
+        description: 'The distribution tag to apply to the published package.',
+    })
+        .option('access', {
+        type: 'string',
+        choices: ['public', 'restricted'],
+        description: 'Overrides the access level of the published package. Unscoped packages cannot be set to restricted. See the npm publish documentation for more information.',
     })
         .option('otp', {
         type: 'number',
-        description: 'A one-time password for publishing to a registry that requires 2FA',
+        description: 'A one-time password for publishing to a registry that requires 2FA.',
     })),
     handler: async (args) => {
         const status = await (await Promise.resolve().then(() => require('./publish'))).releasePublishCLIHandler(coerceParallelOption((0, shared_options_1.withOverrides)(args, 2)));
@@ -203,11 +208,8 @@ const publishCommand = {
 const planCommand = {
     command: 'plan [bump]',
     aliases: ['pl'],
-    // TODO: Remove this when docs are added
-    // Create a plan to pick a new version and generate a changelog entry.
-    // Hidden for now until the feature is more stable
-    describe: false,
-    builder: (yargs) => yargs
+    describe: 'Create a version plan file to specify the desired semver bump for one or more projects or groups, as well as the relevant changelog entry.',
+    builder: (yargs) => (0, shared_options_1.withAffectedOptions)(yargs)
         .positional('bump', {
         type: 'string',
         describe: 'Semver keyword to use for the selected release group.',
@@ -224,7 +226,12 @@ const planCommand = {
         .option('message', {
         type: 'string',
         alias: 'm',
-        describe: 'Custom message to use for the changelog entry',
+        describe: 'Custom message to use for the changelog entry.',
+    })
+        .option('onlyTouched', {
+        type: 'boolean',
+        describe: 'Only include projects that have been affected by the current changes.',
+        default: true,
     }),
     handler: async (args) => {
         const release = await Promise.resolve().then(() => require('./plan'));
@@ -237,10 +244,7 @@ const planCommand = {
 };
 const planCheckCommand = {
     command: 'plan:check',
-    // TODO: Remove this when docs are added
-    // Create a plan to pick a new version and generate a changelog entry.
-    // Hidden for now until the feature is more stable
-    describe: false,
+    describe: 'Ensure that all touched projects have an applicable version plan created for them.',
     builder: (yargs) => (0, shared_options_1.withAffectedOptions)(yargs),
     handler: async (args) => {
         const release = await Promise.resolve().then(() => require('./plan-check'));
@@ -257,7 +261,7 @@ function coerceParallelOption(args) {
 function withGitCommitAndGitTagOptions(yargs) {
     return yargs
         .option('git-commit', {
-        describe: 'Whether or not to automatically commit the changes made by this command',
+        describe: 'Whether or not to automatically commit the changes made by this command.',
         type: 'boolean',
     })
         .option('git-commit-message', {
@@ -265,11 +269,11 @@ function withGitCommitAndGitTagOptions(yargs) {
         type: 'string',
     })
         .option('git-commit-args', {
-        describe: 'Additional arguments (added after the --message argument, which may or may not be customized with --git-commit-message) to pass to the `git commit` command invoked behind the scenes',
+        describe: 'Additional arguments (added after the --message argument, which may or may not be customized with --git-commit-message) to pass to the `git commit` command invoked behind the scenes.',
         type: 'string',
     })
         .option('git-tag', {
-        describe: 'Whether or not to automatically tag the changes made by this command',
+        describe: 'Whether or not to automatically tag the changes made by this command.',
         type: 'boolean',
     })
         .option('git-tag-message', {
@@ -277,7 +281,7 @@ function withGitCommitAndGitTagOptions(yargs) {
         type: 'string',
     })
         .option('git-tag-args', {
-        describe: 'Additional arguments to pass to the `git tag` command invoked behind the scenes',
+        describe: 'Additional arguments to pass to the `git tag` command invoked behind the scenes.',
         type: 'string',
     })
         .option('stage-changes', {

package/src/command-line/release/config/version-plans.d.ts

@@ -1,4 +1,5 @@
 import { ReleaseType } from 'semver';
+import { RawGitCommit } from '../utils/git';
 import { ReleaseGroupWithName } from './filter-release-groups';
 export interface VersionPlanFile {
     absolutePath: string;
@@ -12,9 +13,21 @@ export interface RawVersionPlan extends VersionPlanFile {
 }
 export interface VersionPlan extends VersionPlanFile {
     message: string;
+    /**
+     * The commit that added the version plan file, will be null if the file was never committed.
+     * For optimal performance, we don't apply it at the time of reading the raw contents, because
+     * it hasn't yet passed further validation at that point.
+     */
+    commit: RawGitCommit | null;
 }
 export interface GroupVersionPlan extends VersionPlan {
     groupVersionBump: ReleaseType;
+    /**
+     * The commit that added the version plan file, will be null if the file was never committed.
+     * For optimal performance, we don't apply it at the time of reading the raw contents, because.
+     * it hasn't yet passed validation.
+     */
+    commit: RawGitCommit | null;
     /**
      * Will not be set if the group name was the trigger, otherwise will be a list of
      * all the individual project names explicitly found in the version plan file.
@@ -25,5 +38,5 @@ export interface ProjectsVersionPlan extends VersionPlan {
     projectVersionBumps: Record<string, ReleaseType>;
 }
 export declare function readRawVersionPlans(): Promise<RawVersionPlan[]>;
-export declare function setResolvedVersionPlansOnGroups(rawVersionPlans: RawVersionPlan[], releaseGroups: ReleaseGroupWithName[], allProjectNamesInWorkspace: string[]): ReleaseGroupWithName[];
+export declare function setResolvedVersionPlansOnGroups(rawVersionPlans: RawVersionPlan[], releaseGroups: ReleaseGroupWithName[], allProjectNamesInWorkspace: string[], isVerbose: boolean): Promise<ReleaseGroupWithName[]>;
 export declare function getVersionPlansAbsolutePath(): string;

package/src/command-line/release/config/version-plans.js

@@ -5,6 +5,7 @@ exports.setResolvedVersionPlansOnGroups = setResolvedVersionPlansOnGroups;
 exports.getVersionPlansAbsolutePath = getVersionPlansAbsolutePath;
 const fs_1 = require("fs");
 const fs_extra_1 = require("fs-extra");
+const node_child_process_1 = require("node:child_process");
 const path_1 = require("path");
 const semver_1 = require("semver");
 const workspace_root_1 = require("../../../utils/workspace-root");
@@ -35,7 +36,7 @@ async function readRawVersionPlans() {
     }
     return versionPlans;
 }
-function setResolvedVersionPlansOnGroups(rawVersionPlans, releaseGroups, allProjectNamesInWorkspace) {
+async function setResolvedVersionPlansOnGroups(rawVersionPlans, releaseGroups, allProjectNamesInWorkspace, isVerbose) {
     const groupsByName = releaseGroups.reduce((acc, group) => acc.set(group.name, group), new Map());
     const isDefaultGroup = isDefault(releaseGroups);
     for (const rawVersionPlan of rawVersionPlans) {
@@ -88,6 +89,7 @@ function setResolvedVersionPlansOnGroups(rawVersionPlans, releaseGroups, allProj
                         createdOnMs: rawVersionPlan.createdOnMs,
                         message: rawVersionPlan.message,
                         groupVersionBump: value,
+                        commit: await getCommitForVersionPlanFile(rawVersionPlan, isVerbose),
                     });
                 }
             }
@@ -130,6 +132,7 @@ function setResolvedVersionPlansOnGroups(rawVersionPlans, releaseGroups, allProj
                             projectVersionBumps: {
                                 [key]: value,
                             },
+                            commit: await getCommitForVersionPlanFile(rawVersionPlan, isVerbose),
                         });
                     }
                 }
@@ -161,6 +164,7 @@ function setResolvedVersionPlansOnGroups(rawVersionPlans, releaseGroups, allProj
                             // but we track the projects that triggered the version bump so that we can accurately produce changelog entries.
                             groupVersionBump: value,
                             triggeredByProjects: [key],
+                            commit: await getCommitForVersionPlanFile(rawVersionPlan, isVerbose),
                         });
                     }
                 }
@@ -185,3 +189,31 @@ function getVersionPlansAbsolutePath() {
 function isReleaseType(value) {
     return semver_1.RELEASE_TYPES.includes(value);
 }
+async function getCommitForVersionPlanFile(rawVersionPlan, isVerbose) {
+    return new Promise((resolve) => {
+        (0, node_child_process_1.exec)(`git log --diff-filter=A --pretty=format:"%s|%h|%an|%ae|%b" -n 1 -- ${rawVersionPlan.absolutePath}`, (error, stdout, stderr) => {
+            if (error) {
+                if (isVerbose) {
+                    console.error(`Error executing git command for ${rawVersionPlan.relativePath}: ${error.message}`);
+                }
+                return resolve(null);
+            }
+            if (stderr) {
+                if (isVerbose) {
+                    console.error(`Git command stderr for ${rawVersionPlan.relativePath}: ${stderr}`);
+                }
+                return resolve(null);
+            }
+            const [message, shortHash, authorName, authorEmail, ...body] = stdout
+                .trim()
+                .split('|');
+            const commitDetails = {
+                message: message || '',
+                shortHash: shortHash || '',
+                author: { name: authorName || '', email: authorEmail || '' },
+                body: body.join('|') || '', // Handle case where body might be empty or contain multiple '|'
+            };
+            return resolve(commitDetails);
+        });
+    });
+}

package/src/command-line/release/index.d.ts

@@ -10,19 +10,21 @@ export declare class ReleaseClient {
     release: (args: import("./command-object").ReleaseOptions) => Promise<import("./version").NxReleaseVersionResult | number>;
     constructor(overrideReleaseConfig: NxReleaseConfiguration);
 }
+declare const defaultClient: ReleaseClient;
 /**
  * @public
  */
-export declare const releaseChangelog: any;
+export declare const releaseChangelog: typeof defaultClient.releaseChangelog;
 /**
  * @public
  */
-export declare const releasePublish: any;
+export declare const releasePublish: typeof defaultClient.releasePublish;
 /**
  * @public
  */
-export declare const releaseVersion: any;
+export declare const releaseVersion: typeof defaultClient.releaseVersion;
 /**
  * @public
  */
-export declare const release: any;
+export declare const release: typeof defaultClient.release;
+export {};

package/src/command-line/release/plan-check.js

@@ -3,19 +3,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.releasePlanCheckCLIHandler = void 0;
 exports.createAPI = createAPI;
 const nx_json_1 = require("../../config/nx-json");
-const workspace_projects_1 = require("../../project-graph/affected/locators/workspace-projects");
 const file_map_utils_1 = require("../../project-graph/file-map-utils");
-const file_utils_1 = require("../../project-graph/file-utils");
 const project_graph_1 = require("../../project-graph/project-graph");
 const all_file_data_1 = require("../../utils/all-file-data");
 const command_line_utils_1 = require("../../utils/command-line-utils");
-const ignore_1 = require("../../utils/ignore");
 const output_1 = require("../../utils/output");
 const params_1 = require("../../utils/params");
 const config_1 = require("./config/config");
 const deep_merge_json_1 = require("./config/deep-merge-json");
 const filter_release_groups_1 = require("./config/filter-release-groups");
 const version_plans_1 = require("./config/version-plans");
+const get_touched_projects_for_group_1 = require("./utils/get-touched-projects-for-group");
 const print_config_1 = require("./utils/print-config");
 const releasePlanCheckCLIHandler = (args) => (0, params_1.handleErrors)(args.verbose, () => createAPI({})(args));
 exports.releasePlanCheckCLIHandler = releasePlanCheckCLIHandler;
@@ -37,7 +35,8 @@ function createAPI(overrideReleaseConfig) {
                 isDebug: args.printConfig === 'debug',
             });
         }
-        const { error: filterError, releaseGroups, releaseGroupToFilteredProjects, } = (0, filter_release_groups_1.filterReleaseGroups)(projectGraph, nxReleaseConfig, args.projects, args.groups);
+        // No filtering is applied here, as we want to consider all release groups for plan:check
+        const { error: filterError, releaseGroups } = (0, filter_release_groups_1.filterReleaseGroups)(projectGraph, nxReleaseConfig);
         if (filterError) {
             output_1.output.error(filterError);
             process.exit(1);
@@ -54,7 +53,7 @@ function createAPI(overrideReleaseConfig) {
             return 1;
         }
         const rawVersionPlans = await (0, version_plans_1.readRawVersionPlans)();
-        (0, version_plans_1.setResolvedVersionPlansOnGroups)(rawVersionPlans, releaseGroups, Object.keys(projectGraph.nodes));
+        await (0, version_plans_1.setResolvedVersionPlansOnGroups)(rawVersionPlans, releaseGroups, Object.keys(projectGraph.nodes), args.verbose);
         // Resolve the final values for base, head etc to use when resolving the changes to consider
         const { nxArgs } = (0, command_line_utils_1.splitArgsIntoNxArgsAndOverrides)(args, 'affected', {
             printWarnings: args.verbose,
@@ -74,11 +73,7 @@ function createAPI(overrideReleaseConfig) {
             }
         }
         const resolvedAllFileData = await (0, all_file_data_1.allFileData)();
-        /**
-         * Create a minimal subset of touched projects based on the configured ignore patterns, we only need
-         * to recompute when the ignorePatternsForPlanCheck differs between release groups.
-         */
-        const serializedIgnorePatternsToTouchedProjects = new Map();
+        const getTouchedProjectsForGroup = (0, get_touched_projects_for_group_1.createGetTouchedProjectsForGroup)(nxArgs, projectGraph, changedFiles, resolvedAllFileData);
         const NOTE_ABOUT_VERBOSE_LOGGING = 'Run with --verbose to see the full list of changed files used for the touched projects logic.';
         let hasErrors = false;
         for (const releaseGroup of releaseGroups) {
@@ -100,57 +95,9 @@ function createAPI(overrideReleaseConfig) {
                 });
                 continue;
             }
-            // Exclude patterns from .nxignore, .gitignore and explicit version plan config
-            let serializedIgnorePatterns = '[]';
-            const ignore = (0, ignore_1.getIgnoreObject)();
-            if (typeof releaseGroup.versionPlans !== 'boolean' &&
-                Array.isArray(releaseGroup.versionPlans.ignorePatternsForPlanCheck) &&
-                releaseGroup.versionPlans.ignorePatternsForPlanCheck.length) {
-                output_1.output.note({
-                    title: `Applying configured ignore patterns to changed files${releaseGroup.name !== config_1.IMPLICIT_DEFAULT_RELEASE_GROUP
-                        ? ` for release group "${releaseGroup.name}"`
-                        : ''}`,
-                    bodyLines: [
-                        ...releaseGroup.versionPlans.ignorePatternsForPlanCheck.map((pattern) => `  - ${pattern}`),
-                    ],
-                });
-                ignore.add(releaseGroup.versionPlans.ignorePatternsForPlanCheck);
-                serializedIgnorePatterns = JSON.stringify(releaseGroup.versionPlans.ignorePatternsForPlanCheck);
-            }
-            let touchedProjects = {};
-            if (serializedIgnorePatternsToTouchedProjects.has(serializedIgnorePatterns)) {
-                touchedProjects = serializedIgnorePatternsToTouchedProjects.get(serializedIgnorePatterns);
-            }
-            else {
-                // We only care about directly touched projects, not implicitly affected ones etc
-                const touchedProjectsArr = await (0, workspace_projects_1.getTouchedProjects)((0, file_utils_1.calculateFileChanges)(changedFiles, resolvedAllFileData, nxArgs, undefined, ignore), projectGraph.nodes);
-                touchedProjects = touchedProjectsArr.reduce((acc, project) => ({ ...acc, [project]: true }), {});
-                serializedIgnorePatternsToTouchedProjects.set(serializedIgnorePatterns, touchedProjects);
-            }
-            const touchedProjectsUnderReleaseGroup = releaseGroup.projects.filter((project) => touchedProjects[project]);
-            if (touchedProjectsUnderReleaseGroup.length) {
-                output_1.output.log({
-                    title: `Touched projects based on changed files${releaseGroup.name !== config_1.IMPLICIT_DEFAULT_RELEASE_GROUP
-                        ? ` under release group "${releaseGroup.name}"`
-                        : ''}`,
-                    bodyLines: [
-                        ...touchedProjectsUnderReleaseGroup.map((project) => `  - ${project}`),
-                        '',
-                        'NOTE: You can adjust your "versionPlans.ignorePatternsForPlanCheck" config to stop certain files from resulting in projects being classed as touched for the purposes of this command.',
-                    ],
-                });
-            }
-            else {
-                output_1.output.log({
-                    title: `No touched projects found based on changed files${typeof releaseGroup.versionPlans !== 'boolean' &&
-                        Array.isArray(releaseGroup.versionPlans.ignorePatternsForPlanCheck) &&
-                        releaseGroup.versionPlans.ignorePatternsForPlanCheck.length
-                        ? ' combined with configured ignore patterns'
-                        : ''}${releaseGroup.name !== config_1.IMPLICIT_DEFAULT_RELEASE_GROUP
-                        ? ` under release group "${releaseGroup.name}"`
-                        : ''}`,
-                });
-            }
+            const touchedProjectsUnderReleaseGroup = await getTouchedProjectsForGroup(releaseGroup, 
+            // We do not take any --projects or --groups filtering into account for plan:check
+            releaseGroup.projects, false);
             const projectsInResolvedVersionPlans = resolvedVersionPlans.reduce((acc, plan) => {
                 if ('projectVersionBumps' in plan) {
                     for (const project in plan.projectVersionBumps) {