nx 19.6.0-beta.0 → 19.6.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx",
-  "version": "19.6.0-beta.0",
+  "version": "19.6.0-beta.1",
   "private": false,
   "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
   "repository": {
@@ -71,7 +71,7 @@
     "yargs-parser": "21.1.1",
     "node-machine-id": "1.1.12",
     "ora": "5.3.0",
-    "@nrwl/tao": "19.6.0-beta.0"
+    "@nrwl/tao": "19.6.0-beta.1"
   },
   "peerDependencies": {
     "@swc-node/register": "^1.8.0",
@@ -86,16 +86,16 @@
     }
   },
   "optionalDependencies": {
-    "@nx/nx-darwin-x64": "19.6.0-beta.0",
-    "@nx/nx-darwin-arm64": "19.6.0-beta.0",
-    "@nx/nx-linux-x64-gnu": "19.6.0-beta.0",
-    "@nx/nx-linux-x64-musl": "19.6.0-beta.0",
-    "@nx/nx-win32-x64-msvc": "19.6.0-beta.0",
-    "@nx/nx-linux-arm64-gnu": "19.6.0-beta.0",
-    "@nx/nx-linux-arm64-musl": "19.6.0-beta.0",
-    "@nx/nx-linux-arm-gnueabihf": "19.6.0-beta.0",
-    "@nx/nx-win32-arm64-msvc": "19.6.0-beta.0",
-    "@nx/nx-freebsd-x64": "19.6.0-beta.0"
+    "@nx/nx-darwin-x64": "19.6.0-beta.1",
+    "@nx/nx-darwin-arm64": "19.6.0-beta.1",
+    "@nx/nx-linux-x64-gnu": "19.6.0-beta.1",
+    "@nx/nx-linux-x64-musl": "19.6.0-beta.1",
+    "@nx/nx-win32-x64-msvc": "19.6.0-beta.1",
+    "@nx/nx-linux-arm64-gnu": "19.6.0-beta.1",
+    "@nx/nx-linux-arm64-musl": "19.6.0-beta.1",
+    "@nx/nx-linux-arm-gnueabihf": "19.6.0-beta.1",
+    "@nx/nx-win32-arm64-msvc": "19.6.0-beta.1",
+    "@nx/nx-freebsd-x64": "19.6.0-beta.1"
   },
   "nx-migrations": {
     "migrations": "./migrations.json",

package/release/changelog-renderer/index.js

@@ -216,13 +216,28 @@ function groupBy(items, key) {
     return groups;
 }
 function formatChange(change, changelogRenderOptions, repoSlug) {
+    let description = change.description;
+    let extraLines = [];
+    let extraLinesStr = '';
+    if (description.includes('\n')) {
+        [description, ...extraLines] = description.split('\n');
+        // Align the extra lines with the start of the description for better readability
+        const indentation = '  ';
+        extraLinesStr = extraLines
+            .filter((l) => l.trim().length > 0)
+            .map((l) => `${indentation}${l}`)
+            .join('\n');
+    }
     let changeLine = '- ' +
         (change.isBreaking ? '⚠️  ' : '') +
         (change.scope ? `**${change.scope.trim()}:** ` : '') +
-        change.description;
+        description;
     if (repoSlug && changelogRenderOptions.commitReferences) {
         changeLine += (0, github_1.formatReferences)(change.githubReferences, repoSlug);
     }
+    if (extraLinesStr) {
+        changeLine += '\n\n' + extraLinesStr;
+    }
     return changeLine;
 }
 /**

package/src/command-line/init/init-v2.js

@@ -33,7 +33,7 @@ async function initHandler(options) {
         (0, add_nx_scripts_1.generateDotNxSetup)(version);
         const { plugins } = await detectPlugins();
         plugins.forEach((plugin) => {
-            (0, child_process_2.execSync)(`./nx add ${plugin}`, {
+            (0, child_process_1.runNxSync)(`add ${plugin}`, {
                 stdio: 'inherit',
             });
         });

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

@@ -146,23 +146,34 @@ function createAPI(overrideReleaseConfig) {
                 const releaseGroup = releaseGroups[0];
                 if (releaseGroup.projectsRelationship === 'fixed') {
                     const versionPlans = releaseGroup.versionPlans;
-                    workspaceChangelogChanges = filterHiddenChanges(versionPlans
-                        .map((vp) => {
-                        const parsedMessage = (0, git_1.parseConventionalCommitsMessage)(vp.message);
-                        // only properly formatted conventional commits messages will be included in the changelog
-                        if (!parsedMessage) {
-                            return null;
-                        }
-                        return {
-                            type: parsedMessage.type,
-                            scope: parsedMessage.scope,
-                            description: parsedMessage.description,
-                            body: '',
-                            isBreaking: parsedMessage.breaking,
-                            githubReferences: [],
-                        };
+                    workspaceChangelogChanges = versionPlans
+                        .flatMap((vp) => {
+                        const releaseType = versionPlanSemverReleaseTypeToChangelogType(vp.groupVersionBump);
+                        const changes = !vp.triggeredByProjects
+                            ? {
+                                type: releaseType.type,
+                                scope: '',
+                                description: vp.message,
+                                body: '',
+                                isBreaking: releaseType.isBreaking,
+                                githubReferences: [],
+                                affectedProjects: '*',
+                            }
+                            : vp.triggeredByProjects.map((project) => {
+                                return {
+                                    type: releaseType.type,
+                                    scope: project,
+                                    description: vp.message,
+                                    body: '',
+                                    // TODO: what about github references?
+                                    isBreaking: releaseType.isBreaking,
+                                    githubReferences: [],
+                                    affectedProjects: [project],
+                                };
+                            });
+                        return changes;
                     })
-                        .filter(Boolean), nxReleaseConfig.conventionalCommits);
+                        .filter(Boolean);
                 }
             }
         }
@@ -286,24 +297,25 @@ function createAPI(overrideReleaseConfig) {
                     // TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
                     let commits;
                     if (releaseGroup.versionPlans) {
-                        changes = filterHiddenChanges(releaseGroup.versionPlans
+                        changes = releaseGroup.versionPlans
                             .map((vp) => {
-                            const parsedMessage = (0, git_1.parseConventionalCommitsMessage)(vp.message);
-                            // only properly formatted conventional commits messages will be included in the changelog
-                            if (!parsedMessage) {
+                            const bumpForProject = vp.projectVersionBumps[project.name];
+                            if (!bumpForProject) {
                                 return null;
                             }
+                            const releaseType = versionPlanSemverReleaseTypeToChangelogType(bumpForProject);
                             return {
-                                type: parsedMessage.type,
-                                scope: parsedMessage.scope,
-                                description: parsedMessage.description,
+                                type: releaseType.type,
+                                scope: project.name,
+                                description: vp.message,
                                 body: '',
-                                isBreaking: parsedMessage.breaking,
+                                isBreaking: releaseType.isBreaking,
                                 affectedProjects: Object.keys(vp.projectVersionBumps),
+                                // TODO: can we include github references when using version plans?
                                 githubReferences: [],
                             };
                         })
-                            .filter(Boolean), nxReleaseConfig.conventionalCommits);
+                            .filter(Boolean);
                     }
                     else {
                         let fromRef = args.from ||
@@ -385,24 +397,34 @@ function createAPI(overrideReleaseConfig) {
                 // TODO: remove this after the changelog renderer is refactored to remove coupling with git commits
                 let commits = [];
                 if (releaseGroup.versionPlans) {
-                    changes = filterHiddenChanges(releaseGroup.versionPlans
-                        .map((vp) => {
-                        const parsedMessage = (0, git_1.parseConventionalCommitsMessage)(vp.message);
-                        // only properly formatted conventional commits messages will be included in the changelog
-                        if (!parsedMessage) {
-                            return null;
-                        }
-                        return {
-                            type: parsedMessage.type,
-                            scope: parsedMessage.scope,
-                            description: parsedMessage.description,
-                            body: '',
-                            isBreaking: parsedMessage.breaking,
-                            githubReferences: [],
-                            affectedProjects: '*',
-                        };
+                    changes = releaseGroup.versionPlans
+                        .flatMap((vp) => {
+                        const releaseType = versionPlanSemverReleaseTypeToChangelogType(vp.groupVersionBump);
+                        const changes = !vp.triggeredByProjects
+                            ? {
+                                type: releaseType.type,
+                                scope: '',
+                                description: vp.message,
+                                body: '',
+                                isBreaking: releaseType.isBreaking,
+                                githubReferences: [],
+                                affectedProjects: '*',
+                            }
+                            : vp.triggeredByProjects.map((project) => {
+                                return {
+                                    type: releaseType.type,
+                                    scope: project,
+                                    description: vp.message,
+                                    body: '',
+                                    // TODO: what about github references?
+                                    isBreaking: releaseType.isBreaking,
+                                    githubReferences: [],
+                                    affectedProjects: [project],
+                                };
+                            });
+                        return changes;
                     })
-                        .filter(Boolean), nxReleaseConfig.conventionalCommits);
+                        .filter(Boolean);
                 }
                 else {
                     let fromRef = args.from ||
@@ -914,3 +936,19 @@ function createFileToProjectMap(projectFileMap) {
     }
     return fileToProjectMap;
 }
+function versionPlanSemverReleaseTypeToChangelogType(bump) {
+    switch (bump) {
+        case 'premajor':
+        case 'major':
+            return { type: 'feat', isBreaking: true };
+        case 'preminor':
+        case 'minor':
+            return { type: 'feat', isBreaking: false };
+        case 'prerelease':
+        case 'prepatch':
+        case 'patch':
+            return { type: 'fix', isBreaking: false };
+        default:
+            throw new Error(`Invalid semver bump type: ${bump}`);
+    }
+}

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

@@ -15,6 +15,11 @@ export interface VersionPlan extends VersionPlanFile {
 }
 export interface GroupVersionPlan extends VersionPlan {
     groupVersionBump: ReleaseType;
+    /**
+     * 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.
+     */
+    triggeredByProjects?: string[];
 }
 export interface ProjectsVersionPlan extends VersionPlan {
     projectVersionBumps: Record<string, ReleaseType>;

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

@@ -29,7 +29,7 @@ async function readRawVersionPlans() {
             relativePath: (0, path_1.join)(versionPlansDirectory, versionPlanFile),
             fileName: versionPlanFile,
             content: parsedContent.attributes,
-            message: getSingleLineMessage(parsedContent.body),
+            message: parsedContent.body,
             createdOnMs: versionPlanStats.birthtimeMs,
         });
     }
@@ -39,6 +39,9 @@ function setVersionPlansOnGroups(rawVersionPlans, releaseGroups, allProjectNames
     const groupsByName = releaseGroups.reduce((acc, group) => acc.set(group.name, group), new Map());
     const isDefaultGroup = isDefault(releaseGroups);
     for (const rawVersionPlan of rawVersionPlans) {
+        if (!rawVersionPlan.message) {
+            throw new Error(`Please add a changelog message to version plan: '${rawVersionPlan.fileName}'`);
+        }
         for (const [key, value] of Object.entries(rawVersionPlan.content)) {
             if (groupsByName.has(key)) {
                 const group = groupsByName.get(key);
@@ -143,6 +146,9 @@ function setVersionPlansOnGroups(rawVersionPlans, releaseGroups, allProjectNames
                                 throw new Error(`Found a version bump for project '${key}' in '${rawVersionPlan.fileName}' that conflicts with another project's version bump in the same release group '${groupForProject.name}'. When the group is in fixed versioning mode, all projects' version bumps within the same group must match.`);
                             }
                         }
+                        else {
+                            existingPlan.triggeredByProjects.push(key);
+                        }
                     }
                     else {
                         groupForProject.versionPlans.push({
@@ -152,7 +158,9 @@ function setVersionPlansOnGroups(rawVersionPlans, releaseGroups, allProjectNames
                             createdOnMs: rawVersionPlan.createdOnMs,
                             message: rawVersionPlan.message,
                             // This is a fixed group, so the version bump is for the group, even if a project within it was specified
+                            // but we track the projects that triggered the version bump so that we can accurately produce changelog entries.
                             groupVersionBump: value,
+                            triggeredByProjects: [key],
                         });
                     }
                 }
@@ -177,7 +185,3 @@ function getVersionPlansAbsolutePath() {
 function isReleaseType(value) {
     return semver_1.RELEASE_TYPES.includes(value);
 }
-// changelog messages may only be a single line long, so ignore anything else
-function getSingleLineMessage(message) {
-    return message.trim().split('\n')[0];
-}

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

@@ -4,21 +4,22 @@ exports.releasePlanCLIHandler = void 0;
 exports.createAPI = createAPI;
 const enquirer_1 = require("enquirer");
 const fs_extra_1 = require("fs-extra");
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 const semver_1 = require("semver");
+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 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 generate_version_plan_content_1 = require("./utils/generate-version-plan-content");
-const git_1 = require("./utils/git");
+const launch_editor_1 = require("./utils/launch-editor");
 const print_changes_1 = require("./utils/print-changes");
 const print_config_1 = require("./utils/print-config");
-const deep_merge_json_1 = require("./config/deep-merge-json");
 const releasePlanCLIHandler = (args) => (0, params_1.handleErrors)(args.verbose, () => createAPI({})(args));
 exports.releasePlanCLIHandler = releasePlanCLIHandler;
 function createAPI(overrideReleaseConfig) {
@@ -53,25 +54,6 @@ function createAPI(overrideReleaseConfig) {
                 versionPlanBumps[projectOrGroup] = version;
             }
         };
-        if (args.message) {
-            const message = (0, git_1.parseConventionalCommitsMessage)(args.message);
-            if (!message) {
-                output_1.output.error({
-                    title: 'Changelog message is not in conventional commits format.',
-                    bodyLines: [
-                        'Please ensure your message is in the form of:',
-                        '  type(optional scope): description',
-                        '',
-                        'For example:',
-                        '  feat(pkg-b): add new feature',
-                        '  fix(pkg-a): correct a bug',
-                        '  chore: update build process',
-                        '  fix(core)!: breaking change in core package',
-                    ],
-                });
-                process.exit(1);
-            }
-        }
         if (releaseGroups[0].name === config_1.IMPLICIT_DEFAULT_RELEASE_GROUP) {
             const group = releaseGroups[0];
             if (group.projectsRelationship === 'independent') {
@@ -106,9 +88,10 @@ function createAPI(overrideReleaseConfig) {
             });
             return 0;
         }
-        const versionPlanMessage = args.message || (await promptForMessage());
+        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 = `version-plan-${new Date().getTime()}.md`;
+        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);
@@ -118,7 +101,7 @@ function createAPI(overrideReleaseConfig) {
             (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, path_1.join)(versionPlansAbsolutePath, versionPlanFileName), versionPlanFileContent);
+            await (0, fs_extra_1.writeFile)((0, node_path_1.join)(versionPlansAbsolutePath, versionPlanFileName), versionPlanFileContent);
         }
         return 0;
     };
@@ -142,41 +125,38 @@ async function promptForVersion(message) {
         process.exit(0);
     }
 }
-async function promptForMessage() {
+async function promptForMessage(versionPlanName) {
     let message;
     do {
-        message = await _promptForMessage();
+        message = await _promptForMessage(versionPlanName);
     } while (!message);
     return message;
 }
-// TODO: support non-conventional commits messages (will require significant changelog renderer changes)
-async function _promptForMessage() {
+async function _promptForMessage(versionPlanName) {
     try {
         const reply = await (0, enquirer_1.prompt)([
             {
                 name: 'message',
-                message: 'What changelog message would you like associated with this change?',
+                message: 'What changelog message would you like associated with this change? (Leave blank to open an external editor for multi-line messages/easier editing)',
                 type: 'input',
             },
         ]);
-        const conventionalCommitsMessage = (0, git_1.parseConventionalCommitsMessage)(reply.message);
-        if (!conventionalCommitsMessage) {
+        let message = reply.message.trim();
+        if (!message.length) {
+            const tmpDir = (0, tmp_1.dirSync)().name;
+            const messageFilePath = (0, node_path_1.join)(tmpDir, `DRAFT_MESSAGE__${versionPlanName}.md`);
+            (0, fs_extra_1.writeFileSync)(messageFilePath, '');
+            await (0, launch_editor_1.launchEditor)(messageFilePath);
+            message = (0, fs_extra_1.readFileSync)(messageFilePath, 'utf-8');
+        }
+        message = message.trim();
+        if (!message) {
             output_1.output.warn({
-                title: 'Changelog message is not in conventional commits format.',
-                bodyLines: [
-                    'Please ensure your message is in the form of:',
-                    '  type(optional scope): description',
-                    '',
-                    'For example:',
-                    '  feat(pkg-b): add new feature',
-                    '  fix(pkg-a): correct a bug',
-                    '  chore: update build process',
-                    '  fix(core)!: breaking change in core package',
-                ],
+                title: 'A changelog message is required in order to create the version plan file',
+                bodyLines: [],
             });
-            return null;
         }
-        return reply.message;
+        return message;
     }
     catch (e) {
         output_1.output.log({

package/src/command-line/release/utils/generate-version-plan-content.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateVersionPlanContent = generateVersionPlanContent;
 function generateVersionPlanContent(bumps, message) {
-    return `---
+    const frontMatter = `---
 ${Object.entries(bumps)
         .filter(([_, version]) => version !== 'none')
         .map(([projectOrGroup, version]) => {
@@ -15,7 +15,6 @@ ${Object.entries(bumps)
     })
         .join('\n')}
 ---
-
-${message}
 `;
+    return `${frontMatter}${message ? `\n${message}\n` : ''}`;
 }

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

@@ -30,6 +30,11 @@ export interface ReleaseVersionGeneratorSchema {
      * This is only applicable to independently released projects.
      */
     updateDependents?: 'never' | 'auto';
+    /**
+     * Whether or not to completely omit project logs when that project has no applicable changes. This can be useful for
+     * large monorepos which have a large number of projects, especially when only a subset are released together.
+     */
+    logUnchangedProjects?: boolean;
 }
 export interface NxReleaseVersionResult {
     /**