nx 19.6.3 → 19.6.5

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

@@ -10,6 +10,8 @@ const tmp_1 = require("tmp");
 const nx_json_1 = require("../../config/nx-json");
 const file_map_utils_1 = require("../../project-graph/file-map-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 output_1 = require("../../utils/output");
 const params_1 = require("../../utils/params");
 const config_1 = require("./config/config");
@@ -17,6 +19,7 @@ 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 generate_version_plan_content_1 = require("./utils/generate-version-plan-content");
+const get_touched_projects_for_group_1 = require("./utils/get-touched-projects-for-group");
 const launch_editor_1 = require("./utils/launch-editor");
 const print_changes_1 = require("./utils/print-changes");
 const print_config_1 = require("./utils/print-config");
@@ -45,64 +48,155 @@ function createAPI(overrideReleaseConfig) {
             output_1.output.error(filterError);
             process.exit(1);
         }
+        // If no release groups have version plans enabled, it doesn't make sense to use the plan command only to set yourself up for an error at release time
+        if (!releaseGroups.some((group) => group.versionPlans === true)) {
+            if (releaseGroups.length === 1) {
+                output_1.output.warn({
+                    title: `Version plans are not enabled in your release configuration`,
+                    bodyLines: [
+                        'To enable version plans, set `"versionPlans": true` at the top level of your `"release"` configuration',
+                    ],
+                });
+                return 0;
+            }
+            output_1.output.warn({
+                title: 'No release groups have version plans enabled',
+                bodyLines: [
+                    'To enable version plans, set `"versionPlans": true` at the top level of your `"release"` configuration to apply it to all groups, otherwise set it at the release group level',
+                ],
+            });
+            return 0;
+        }
+        // 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,
+        }, nxJson);
         const versionPlanBumps = {};
         const setBumpIfNotNone = (projectOrGroup, version) => {
             if (version !== 'none') {
                 versionPlanBumps[projectOrGroup] = version;
             }
         };
-        if (releaseGroups[0].name === config_1.IMPLICIT_DEFAULT_RELEASE_GROUP) {
-            const group = releaseGroups[0];
-            if (group.projectsRelationship === 'independent') {
-                for (const project of group.projects) {
-                    setBumpIfNotNone(project, args.bump ||
-                        (await promptForVersion(`How do you want to bump the version of the project "${project}"?`)));
+        // Changed files are only relevant if considering touched projects
+        let changedFiles = [];
+        let getProjectsToVersionForGroup;
+        if (args.onlyTouched) {
+            changedFiles = (0, command_line_utils_1.parseFiles)(nxArgs).files;
+            if (nxArgs.verbose) {
+                if (changedFiles.length) {
+                    output_1.output.log({
+                        title: `Changed files based on resolved "base" (${nxArgs.base}) and "head" (${nxArgs.head ?? 'HEAD'})`,
+                        bodyLines: changedFiles.map((file) => `  - ${file}`),
+                    });
+                }
+                else {
+                    output_1.output.warn({
+                        title: 'No changed files found based on resolved "base" and "head"',
+                    });
                 }
             }
-            else {
-                // TODO: use project names instead of the implicit default release group name? (though this might be confusing, as users might think they can just delete one of the project bumps to change the behavior to independent versioning)
-                setBumpIfNotNone(group.name, args.bump ||
-                    (await promptForVersion(`How do you want to bump the versions of all projects?`)));
-            }
+            const resolvedAllFileData = await (0, all_file_data_1.allFileData)();
+            getProjectsToVersionForGroup = (0, get_touched_projects_for_group_1.createGetTouchedProjectsForGroup)(nxArgs, projectGraph, changedFiles, resolvedAllFileData);
         }
-        else {
-            for (const group of releaseGroups) {
-                if (group.projectsRelationship === 'independent') {
-                    for (const project of releaseGroupToFilteredProjects.get(group)) {
+        if (args.projects?.length) {
+            /**
+             * Run plan for all remaining release groups and filtered projects within them
+             */
+            for (const releaseGroup of releaseGroups) {
+                const releaseGroupName = releaseGroup.name;
+                const releaseGroupProjectNames = Array.from(releaseGroupToFilteredProjects.get(releaseGroup));
+                let applicableProjects = releaseGroupProjectNames;
+                if (args.onlyTouched &&
+                    typeof getProjectsToVersionForGroup === 'function') {
+                    applicableProjects = await getProjectsToVersionForGroup(releaseGroup, releaseGroupProjectNames, true);
+                }
+                if (!applicableProjects.length) {
+                    continue;
+                }
+                if (releaseGroup.projectsRelationship === 'independent') {
+                    for (const project of applicableProjects) {
                         setBumpIfNotNone(project, args.bump ||
-                            (await promptForVersion(`How do you want to bump the version of the project "${project}" within group "${group.name}"?`)));
+                            (await promptForVersion(`How do you want to bump the version of the project "${project}"${releaseGroupName === config_1.IMPLICIT_DEFAULT_RELEASE_GROUP
+                                ? ''
+                                : ` within group "${releaseGroupName}"`}?`)));
                     }
                 }
                 else {
-                    setBumpIfNotNone(group.name, args.bump ||
-                        (await promptForVersion(`How do you want to bump the versions of the projects in the group "${group.name}"?`)));
+                    setBumpIfNotNone(releaseGroupName, args.bump ||
+                        (await promptForVersion(`How do you want to bump the versions of ${releaseGroupName === config_1.IMPLICIT_DEFAULT_RELEASE_GROUP
+                            ? 'all projects'
+                            : `the projects in the group "${releaseGroupName}"`}?`)));
                 }
             }
-        }
-        if (!Object.keys(versionPlanBumps).length) {
-            output_1.output.warn({
-                title: 'No version bumps were selected so no version plan file was created.',
-            });
+            // Create a version plan file if applicable
+            await createVersionPlanFileForBumps(args, versionPlanBumps);
             return 0;
         }
-        const versionPlanName = `version-plan-${new Date().getTime()}`;
-        const versionPlanMessage = args.message || (await promptForMessage(versionPlanName));
-        const versionPlanFileContent = (0, generate_version_plan_content_1.generateVersionPlanContent)(versionPlanBumps, versionPlanMessage);
-        const versionPlanFileName = `${versionPlanName}.md`;
-        if (args.dryRun) {
-            output_1.output.logSingleLine(`Would create version plan file "${versionPlanFileName}", but --dry-run was set.`);
-            (0, print_changes_1.printDiff)('', versionPlanFileContent, 1);
-        }
-        else {
-            output_1.output.logSingleLine(`Creating version plan file "${versionPlanFileName}"`);
-            (0, print_changes_1.printDiff)('', versionPlanFileContent, 1);
-            const versionPlansAbsolutePath = (0, version_plans_1.getVersionPlansAbsolutePath)();
-            await (0, fs_extra_1.ensureDir)(versionPlansAbsolutePath);
-            await (0, fs_extra_1.writeFile)((0, node_path_1.join)(versionPlansAbsolutePath, versionPlanFileName), versionPlanFileContent);
+        /**
+         * Run plan for all remaining release groups
+         */
+        for (const releaseGroup of releaseGroups) {
+            const releaseGroupName = releaseGroup.name;
+            let applicableProjects = releaseGroup.projects;
+            if (args.onlyTouched &&
+                typeof getProjectsToVersionForGroup === 'function') {
+                applicableProjects = await getProjectsToVersionForGroup(releaseGroup, releaseGroup.projects, false);
+            }
+            if (!applicableProjects.length) {
+                continue;
+            }
+            if (releaseGroup.projectsRelationship === 'independent') {
+                for (const project of applicableProjects) {
+                    setBumpIfNotNone(project, args.bump ||
+                        (await promptForVersion(`How do you want to bump the version of the project "${project}"${releaseGroupName === config_1.IMPLICIT_DEFAULT_RELEASE_GROUP
+                            ? ''
+                            : ` within group "${releaseGroupName}"`}?`)));
+                }
+            }
+            else {
+                setBumpIfNotNone(releaseGroupName, args.bump ||
+                    (await promptForVersion(`How do you want to bump the versions of ${releaseGroupName === config_1.IMPLICIT_DEFAULT_RELEASE_GROUP
+                        ? 'all projects'
+                        : `the projects in the group "${releaseGroupName}"`}?`)));
+            }
         }
+        // Create a version plan file if applicable
+        await createVersionPlanFileForBumps(args, versionPlanBumps);
         return 0;
     };
 }
+async function createVersionPlanFileForBumps(args, versionPlanBumps) {
+    if (!Object.keys(versionPlanBumps).length) {
+        let bodyLines = [];
+        if (args.onlyTouched) {
+            bodyLines = [
+                'This might be because no projects have been changed, or projects you expected to release have not been touched',
+                'To include all projects, not just those that have been changed, pass --only-touched=false',
+                'Alternatively, you can specify alternate --base and --head refs to include only changes from certain commits',
+            ];
+        }
+        output_1.output.warn({
+            title: 'No version bumps were selected so no version plan file was created.',
+            bodyLines,
+        });
+        return 0;
+    }
+    const versionPlanName = `version-plan-${new Date().getTime()}`;
+    const versionPlanMessage = args.message || (await promptForMessage(versionPlanName));
+    const versionPlanFileContent = (0, generate_version_plan_content_1.generateVersionPlanContent)(versionPlanBumps, versionPlanMessage);
+    const versionPlanFileName = `${versionPlanName}.md`;
+    if (args.dryRun) {
+        output_1.output.logSingleLine(`Would create version plan file "${versionPlanFileName}", but --dry-run was set.`);
+        (0, print_changes_1.printDiff)('', versionPlanFileContent, 1);
+    }
+    else {
+        output_1.output.logSingleLine(`Creating version plan file "${versionPlanFileName}"`);
+        (0, print_changes_1.printDiff)('', versionPlanFileContent, 1);
+        const versionPlansAbsolutePath = (0, version_plans_1.getVersionPlansAbsolutePath)();
+        await (0, fs_extra_1.ensureDir)(versionPlansAbsolutePath);
+        await (0, fs_extra_1.writeFile)((0, node_path_1.join)(versionPlansAbsolutePath, versionPlanFileName), versionPlanFileContent);
+    }
+}
 async function promptForVersion(message) {
     try {
         const reply = await (0, enquirer_1.prompt)([

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

@@ -94,7 +94,7 @@ function createAPI(overrideReleaseConfig) {
             output_1.output.error(filterError);
             process.exit(1);
         }
-        (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);
         const planFiles = new Set();
         releaseGroups.forEach((group) => {
             if (group.resolvedVersionPlans) {

package/src/command-line/release/utils/get-touched-projects-for-group.d.ts

@@ -0,0 +1,7 @@
+import { FileData, ProjectGraph } from '../../../config/project-graph';
+import { NxArgs } from '../../../utils/command-line-utils';
+import { ReleaseGroupWithName } from '../config/filter-release-groups';
+/**
+ * Create a function that returns the touched projects for a given release group. Only relevant when version plans are enabled.
+ */
+export declare function createGetTouchedProjectsForGroup(nxArgs: NxArgs, projectGraph: ProjectGraph, changedFiles: string[], fileData: FileData[]): (releaseGroup: ReleaseGroupWithName, releaseGroupFilteredProjectNames: string[], hasProjectsFilter: boolean) => Promise<string[]>;

package/src/command-line/release/utils/get-touched-projects-for-group.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGetTouchedProjectsForGroup = createGetTouchedProjectsForGroup;
+const workspace_projects_1 = require("../../../project-graph/affected/locators/workspace-projects");
+const file_utils_1 = require("../../../project-graph/file-utils");
+const ignore_1 = require("../../../utils/ignore");
+const output_1 = require("../../../utils/output");
+const config_1 = require("../config/config");
+/**
+ * Create a function that returns the touched projects for a given release group. Only relevant when version plans are enabled.
+ */
+function createGetTouchedProjectsForGroup(nxArgs, projectGraph, changedFiles, fileData) {
+    /**
+     * 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();
+    return async function getTouchedProjectsForGroup(releaseGroup, 
+    // We don't access releaseGroups.projects directly, because we need to take the --projects filter into account
+    releaseGroupFilteredProjectNames, hasProjectsFilter) {
+        // The current release group doesn't leverage version plans
+        if (!releaseGroup.versionPlans) {
+            return [];
+        }
+        // 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, fileData, nxArgs, undefined, ignore), projectGraph.nodes);
+            touchedProjects = touchedProjectsArr.reduce((acc, project) => ({ ...acc, [project]: true }), {});
+            serializedIgnorePatternsToTouchedProjects.set(serializedIgnorePatterns, touchedProjects);
+        }
+        const touchedProjectsUnderReleaseGroup = releaseGroupFilteredProjectNames.filter((project) => touchedProjects[project]);
+        if (touchedProjectsUnderReleaseGroup.length) {
+            output_1.output.log({
+                title: `Touched projects${hasProjectsFilter ? ` (after --projects filter applied)` : ''} 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${hasProjectsFilter ? ` (after --projects filter applied)` : ''} 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}"`
+                    : ''}`,
+            });
+        }
+        return touchedProjectsUnderReleaseGroup;
+    };
+}

package/src/command-line/release/utils/git.d.ts

@@ -62,6 +62,6 @@ export declare function parseConventionalCommitsMessage(message: string): {
     description: string;
     breaking: boolean;
 } | null;
-export declare function parseGitCommit(commit: RawGitCommit): GitCommit | null;
+export declare function parseGitCommit(commit: RawGitCommit, isVersionPlanCommit?: boolean): GitCommit | null;
 export declare function getCommitHash(ref: string): Promise<string>;
 export declare function getFirstGitCommit(): Promise<string>;

package/src/command-line/release/utils/git.js

@@ -281,6 +281,30 @@ function parseConventionalCommitsMessage(message) {
         breaking: Boolean(match.groups.breaking),
     };
 }
+function extractReferencesFromCommitMessage(message, shortHash) {
+    const references = [];
+    for (const m of message.matchAll(PullRequestRE)) {
+        references.push({ type: 'pull-request', value: m[1] });
+    }
+    for (const m of message.matchAll(IssueRE)) {
+        if (!references.some((i) => i.value === m[1])) {
+            references.push({ type: 'issue', value: m[1] });
+        }
+    }
+    references.push({ value: shortHash, type: 'hash' });
+    return references;
+}
+function getAllAuthorsForCommit(commit) {
+    const authors = [commit.author];
+    // Additional authors can be specified in the commit body (depending on the VCS provider)
+    for (const match of commit.body.matchAll(CoAuthoredByRegex)) {
+        authors.push({
+            name: (match.groups.name || '').trim(),
+            email: (match.groups.email || '').trim(),
+        });
+    }
+    return authors;
+}
 // https://www.conventionalcommits.org/en/v1.0.0/
 // https://regex101.com/r/FSfNvA/1
 const ConventionalCommitRegex = /(?<type>[a-z]+)(\((?<scope>.+)\))?(?<breaking>!)?: (?<description>.+)/i;
@@ -289,7 +313,25 @@ const PullRequestRE = /\([ a-z]*(#\d+)\s*\)/gm;
 const IssueRE = /(#\d+)/gm;
 const ChangedFileRegex = /(A|M|D|R\d*|C\d*)\t([^\t\n]*)\t?(.*)?/gm;
 const RevertHashRE = /This reverts commit (?<hash>[\da-f]{40})./gm;
-function parseGitCommit(commit) {
+function parseGitCommit(commit, isVersionPlanCommit = false) {
+    // For version plans, we do not require conventional commits and therefore cannot extract data based on that format
+    if (isVersionPlanCommit) {
+        return {
+            ...commit,
+            description: commit.message,
+            type: '',
+            scope: '',
+            references: extractReferencesFromCommitMessage(commit.message, commit.shortHash),
+            // The commit message is not the source of truth for a breaking (major) change in version plans, so the value is not relevant
+            // TODO(v20): Make the current GitCommit interface more clearly tied to conventional commits
+            isBreaking: false,
+            authors: getAllAuthorsForCommit(commit),
+            // Not applicable to version plans
+            affectedFiles: [],
+            // Not applicable, a version plan cannot have been added in a commit that also reverts another commit
+            revertedHashes: [],
+        };
+    }
     const parsedMessage = parseConventionalCommitsMessage(commit.message);
     if (!parsedMessage) {
         return null;
@@ -298,16 +340,7 @@ function parseGitCommit(commit) {
     const isBreaking = parsedMessage.breaking || commit.body.includes('BREAKING CHANGE:');
     let description = parsedMessage.description;
     // Extract references from message
-    const references = [];
-    for (const m of description.matchAll(PullRequestRE)) {
-        references.push({ type: 'pull-request', value: m[1] });
-    }
-    for (const m of description.matchAll(IssueRE)) {
-        if (!references.some((i) => i.value === m[1])) {
-            references.push({ type: 'issue', value: m[1] });
-        }
-    }
-    references.push({ value: commit.shortHash, type: 'hash' });
+    const references = extractReferencesFromCommitMessage(description, commit.shortHash);
     // Remove references and normalize
     description = description.replace(PullRequestRE, '').trim();
     let type = parsedMessage.type;
@@ -322,13 +355,7 @@ function parseGitCommit(commit) {
         description = commit.message;
     }
     // Find all authors
-    const authors = [commit.author];
-    for (const match of commit.body.matchAll(CoAuthoredByRegex)) {
-        authors.push({
-            name: (match.groups.name || '').trim(),
-            email: (match.groups.email || '').trim(),
-        });
-    }
+    const authors = getAllAuthorsForCommit(commit);
     // Extract file changes from commit body
     const affectedFiles = Array.from(commit.body.matchAll(ChangedFileRegex)).reduce((prev, [fullLine, changeType, file1, file2]) => 
     // file2 only exists for some change types, such as renames

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

@@ -82,7 +82,7 @@ function createAPI(overrideReleaseConfig) {
         }
         if (!args.specifier) {
             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);
         }
         else {
             if (args.verbose && releaseGroups.some((g) => !!g.versionPlans)) {

package/src/daemon/server/sync-generators.d.ts

@@ -4,3 +4,7 @@ export declare function getCachedSyncGeneratorChanges(generators: string[]): Pro
 export declare function flushSyncGeneratorChangesToDisk(generators: string[]): Promise<void>;
 export declare function collectAndScheduleSyncGenerators(projectGraph: ProjectGraph): void;
 export declare function getCachedRegisteredSyncGenerators(): Promise<string[]>;
+/**
+ * @internal
+ */
+export declare function _getConflictingGeneratorGroups(results: SyncGeneratorChangesResult[]): string[][];