nx 17.0.1 → 17.0.2

package/changelog-renderer/index.d.ts

@@ -0,0 +1,43 @@
+import type { GitCommit } from '../src/command-line/release/utils/git';
+import { RepoSlug } from '../src/command-line/release/utils/github';
+/**
+ * The ChangelogRenderOptions are specific to each ChangelogRenderer implementation, and are taken
+ * from the user's nx.json configuration and passed as is into the ChangelogRenderer function.
+ */
+export type ChangelogRenderOptions = Record<string, unknown>;
+/**
+ * A ChangelogRenderer function takes in the extracted commits and other relevant metadata
+ * and returns a string, or a Promise of a string of changelog contents (usually markdown).
+ *
+ * @param {Object} config The configuration object for the ChangelogRenderer
+ * @param {GitCommit[]} config.commits The collection of extracted commits to generate a changelog for
+ * @param {string} config.releaseVersion The version that is being released
+ * @param {string | null} config.project The name of specific project to generate a changelog for, or `null` if the overall workspace changelog
+ * @param {string | false} config.entryWhenNoChanges The (already interpolated) string to use as the changelog entry when there are no changes, or `false` if no entry should be generated
+ * @param {ChangelogRenderOptions} config.changelogRenderOptions The options specific to the ChangelogRenderer implementation
+ */
+export type ChangelogRenderer = (config: {
+    commits: GitCommit[];
+    releaseVersion: string;
+    project: string | null;
+    entryWhenNoChanges: string | false;
+    changelogRenderOptions: DefaultChangelogRenderOptions;
+    repoSlug?: RepoSlug;
+}) => Promise<string> | string;
+/**
+ * The specific options available to the default implementation of the ChangelogRenderer that nx exports
+ * for the common case.
+ */
+export interface DefaultChangelogRenderOptions extends ChangelogRenderOptions {
+    /**
+     * Whether or not the commit authors should be added to the bottom of the changelog in a "Thank You"
+     * section. Defaults to true.
+     */
+    includeAuthors?: boolean;
+}
+/**
+ * The default ChangelogRenderer implementation that nx exports for the common case of generating markdown
+ * from the given commits and other metadata.
+ */
+declare const defaultChangelogRenderer: ChangelogRenderer;
+export default defaultChangelogRenderer;

package/changelog-renderer/index.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const github_1 = require("../src/command-line/release/utils/github");
+// axios types and values don't seem to match
+const _axios = require("axios");
+const axios = _axios;
+/**
+ * The default ChangelogRenderer implementation that nx exports for the common case of generating markdown
+ * from the given commits and other metadata.
+ */
+const defaultChangelogRenderer = async ({ commits, releaseVersion, project, entryWhenNoChanges, changelogRenderOptions, repoSlug, }) => {
+    const markdownLines = [];
+    const breakingChanges = [];
+    const commitTypes = {
+        feat: { title: '🚀 Features' },
+        perf: { title: '🔥 Performance' },
+        fix: { title: '🩹 Fixes' },
+        refactor: { title: '💅 Refactors' },
+        docs: { title: '📖 Documentation' },
+        build: { title: '📦 Build' },
+        types: { title: '🌊 Types' },
+        chore: { title: '🏡 Chore' },
+        examples: { title: '🏀 Examples' },
+        test: { title: '✅ Tests' },
+        style: { title: '🎨 Styles' },
+        ci: { title: '🤖 CI' },
+    };
+    // workspace root level changelog
+    if (project === null) {
+        // No changes for the workspace
+        if (commits.length === 0) {
+            if (entryWhenNoChanges) {
+                markdownLines.push('', `## ${releaseVersion}\n\n${entryWhenNoChanges}`, '');
+            }
+            return markdownLines.join('\n').trim();
+        }
+        const typeGroups = groupBy(commits, 'type');
+        markdownLines.push('', `## ${releaseVersion}`, '');
+        for (const type of Object.keys(commitTypes)) {
+            const group = typeGroups[type];
+            if (!group || group.length === 0) {
+                continue;
+            }
+            markdownLines.push('', '### ' + commitTypes[type].title, '');
+            /**
+             * In order to make the final changelog most readable, we organize commits as follows:
+             * - By scope, where scopes are in alphabetical order (commits with no scope are listed first)
+             * - Within a particular scope grouping, we list commits in chronological order
+             */
+            const commitsInChronologicalOrder = group.reverse();
+            const commitsGroupedByScope = groupBy(commitsInChronologicalOrder, 'scope');
+            const scopesSortedAlphabetically = Object.keys(commitsGroupedByScope).sort();
+            for (const scope of scopesSortedAlphabetically) {
+                const commits = commitsGroupedByScope[scope];
+                for (const commit of commits) {
+                    const line = formatCommit(commit, repoSlug);
+                    markdownLines.push(line);
+                    if (commit.isBreaking) {
+                        breakingChanges.push(line);
+                    }
+                }
+            }
+        }
+    }
+    else {
+        // project level changelog
+        const scopeGroups = groupBy(commits, 'scope');
+        // Generating for a named project, but that project has no changes in the current set of commits, exit early
+        if (!scopeGroups[project]) {
+            if (entryWhenNoChanges) {
+                markdownLines.push('', `## ${releaseVersion}\n\n${entryWhenNoChanges}`, '');
+            }
+            return markdownLines.join('\n').trim();
+        }
+        markdownLines.push('', `## ${releaseVersion}`, '');
+        const typeGroups = groupBy(scopeGroups[project], 'type');
+        for (const type of Object.keys(commitTypes)) {
+            const group = typeGroups[type];
+            if (!group || group.length === 0) {
+                continue;
+            }
+            markdownLines.push('', `### ${commitTypes[type].title}`, '');
+            const commitsInChronologicalOrder = group.reverse();
+            for (const commit of commitsInChronologicalOrder) {
+                const line = formatCommit(commit, repoSlug);
+                markdownLines.push(line + '\n');
+                if (commit.isBreaking) {
+                    breakingChanges.push(line);
+                }
+            }
+        }
+    }
+    if (breakingChanges.length > 0) {
+        markdownLines.push('', '#### ⚠️  Breaking Changes', '', ...breakingChanges);
+    }
+    if (changelogRenderOptions.includeAuthors) {
+        const _authors = new Map();
+        for (const commit of commits) {
+            if (!commit.author) {
+                continue;
+            }
+            const name = formatName(commit.author.name);
+            if (!name || name.includes('[bot]')) {
+                continue;
+            }
+            if (_authors.has(name)) {
+                const entry = _authors.get(name);
+                entry.email.add(commit.author.email);
+            }
+            else {
+                _authors.set(name, { email: new Set([commit.author.email]) });
+            }
+        }
+        // Try to map authors to github usernames
+        if (repoSlug) {
+            await Promise.all([..._authors.keys()].map(async (authorName) => {
+                const meta = _authors.get(authorName);
+                for (const email of meta.email) {
+                    // For these pseudo-anonymized emails we can just extract the Github username from before the @
+                    // It could either be in the format: username@ or github_id+username@
+                    if (email.endsWith('@users.noreply.github.com')) {
+                        const match = email.match(/^(\d+\+)?([^@]+)@users\.noreply\.github\.com$/);
+                        if (match && match[2]) {
+                            meta.github = match[2];
+                            break;
+                        }
+                    }
+                    // Look up any other emails against the ungh.cc API
+                    const { data } = await axios
+                        .get(`https://ungh.cc/users/find/${email}`)
+                        .catch(() => ({ data: { user: null } }));
+                    if (data?.user) {
+                        meta.github = data.user.username;
+                        break;
+                    }
+                }
+            }));
+        }
+        const authors = [..._authors.entries()].map((e) => ({
+            name: e[0],
+            ...e[1],
+        }));
+        if (authors.length > 0) {
+            markdownLines.push('', '### ' + '❤️  Thank You', '', ...authors
+                // Sort the contributors by name
+                .sort((a, b) => a.name.localeCompare(b.name))
+                .map((i) => {
+                // Tag the author's Github username if we were able to resolve it so that Github adds them as a contributor
+                const github = i.github ? ` @${i.github}` : '';
+                return `- ${i.name}${github}`;
+            }));
+        }
+    }
+    return markdownLines.join('\n').trim();
+};
+exports.default = defaultChangelogRenderer;
+function formatName(name = '') {
+    return name
+        .split(' ')
+        .map((p) => p.trim())
+        .join(' ');
+}
+function groupBy(items, key) {
+    const groups = {};
+    for (const item of items) {
+        groups[item[key]] = groups[item[key]] || [];
+        groups[item[key]].push(item);
+    }
+    return groups;
+}
+function formatCommit(commit, repoSlug) {
+    let commitLine = '- ' +
+        (commit.scope ? `**${commit.scope.trim()}:** ` : '') +
+        (commit.isBreaking ? '⚠️  ' : '') +
+        commit.description;
+    if (repoSlug) {
+        commitLine += (0, github_1.formatReferences)(commit.references, repoSlug);
+    }
+    return commitLine;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nx",
-  "version": "17.0.1",
+  "version": "17.0.2",
   "private": false,
   "description": "The core Nx plugin contains the core functionality of Nx like the project graph, nx commands and task orchestration.",
   "repository": {
@@ -33,7 +33,6 @@
   },
   "homepage": "https://nx.dev",
   "dependencies": {
-    "@parcel/watcher": "2.0.4",
     "@yarnpkg/lockfile": "^1.1.0",
     "@yarnpkg/parsers": "3.0.0-rc.46",
     "@zkochan/js-yaml": "0.0.6",
@@ -68,7 +67,7 @@
     "yargs": "^17.6.2",
     "yargs-parser": "21.1.1",
     "node-machine-id": "1.1.12",
-    "@nrwl/tao": "17.0.1"
+    "@nrwl/tao": "17.0.2"
   },
   "peerDependencies": {
     "@swc-node/register": "^1.6.7",
@@ -83,16 +82,16 @@
     }
   },
   "optionalDependencies": {
-    "@nx/nx-darwin-x64": "17.0.1",
-    "@nx/nx-darwin-arm64": "17.0.1",
-    "@nx/nx-linux-x64-gnu": "17.0.1",
-    "@nx/nx-linux-x64-musl": "17.0.1",
-    "@nx/nx-win32-x64-msvc": "17.0.1",
-    "@nx/nx-linux-arm64-gnu": "17.0.1",
-    "@nx/nx-linux-arm64-musl": "17.0.1",
-    "@nx/nx-linux-arm-gnueabihf": "17.0.1",
-    "@nx/nx-win32-arm64-msvc": "17.0.1",
-    "@nx/nx-freebsd-x64": "17.0.1"
+    "@nx/nx-darwin-x64": "17.0.2",
+    "@nx/nx-darwin-arm64": "17.0.2",
+    "@nx/nx-linux-x64-gnu": "17.0.2",
+    "@nx/nx-linux-x64-musl": "17.0.2",
+    "@nx/nx-win32-x64-msvc": "17.0.2",
+    "@nx/nx-linux-arm64-gnu": "17.0.2",
+    "@nx/nx-linux-arm64-musl": "17.0.2",
+    "@nx/nx-linux-arm-gnueabihf": "17.0.2",
+    "@nx/nx-win32-arm64-msvc": "17.0.2",
+    "@nx/nx-freebsd-x64": "17.0.2"
   },
   "nx-migrations": {
     "migrations": "./migrations.json",

package/schemas/nx-schema.json

@@ -95,6 +95,86 @@
     "useDaemonProcess": {
       "type": "boolean",
       "description": "Specifies whether the daemon should be used for the default tasks runner."
+    },
+    "release": {
+      "type": "object",
+      "description": "Configuration for the nx release commands.",
+      "additionalProperties": false,
+      "properties": {
+        "groups": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "projects": {
+                "oneOf": [
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "minItems": 1
+                  },
+                  {
+                    "type": "string"
+                  }
+                ]
+              },
+              "version": {
+                "$ref": "#/definitions/NxReleaseVersionConfiguration"
+              },
+              "changelog": {
+                "oneOf": [
+                  {
+                    "$ref": "#/definitions/NxReleaseChangelogConfiguration"
+                  },
+                  {
+                    "type": "boolean",
+                    "enum": [false]
+                  }
+                ]
+              },
+              "releaseTagPattern": {
+                "type": "string"
+              }
+            },
+            "required": ["projects"]
+          }
+        },
+        "changelog": {
+          "type": "object",
+          "properties": {
+            "workspaceChangelog": {
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/NxReleaseChangelogConfiguration"
+                },
+                {
+                  "type": "boolean",
+                  "enum": [false]
+                }
+              ]
+            },
+            "projectChangelogs": {
+              "oneOf": [
+                {
+                  "$ref": "#/definitions/NxReleaseChangelogConfiguration"
+                },
+                {
+                  "type": "boolean",
+                  "enum": [false]
+                }
+              ]
+            }
+          }
+        },
+        "version": {
+          "$ref": "#/definitions/NxReleaseVersionConfiguration"
+        },
+        "releaseTagPattern": {
+          "type": "string"
+        }
+      }
     }
   },
   "definitions": {
@@ -389,6 +469,67 @@
           }
         }
       ]
+    },
+    "NxReleaseVersionConfiguration": {
+      "type": "object",
+      "properties": {
+        "generator": {
+          "type": "string"
+        },
+        "generatorOptions": {
+          "type": "object",
+          "additionalProperties": true
+        }
+      }
+    },
+    "NxReleaseChangelogConfiguration": {
+      "type": "object",
+      "properties": {
+        "createRelease": {
+          "oneOf": [
+            {
+              "type": "string",
+              "enum": ["github"]
+            },
+            {
+              "type": "boolean",
+              "enum": [false]
+            }
+          ]
+        },
+        "entryWhenNoChanges": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "boolean",
+              "enum": [false]
+            }
+          ]
+        },
+        "file": {
+          "oneOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "boolean",
+              "enum": [false]
+            }
+          ]
+        },
+        "renderer": {
+          "type": "string"
+        },
+        "renderOptions": {
+          "$ref": "#/definitions/ChangelogRenderOptions"
+        }
+      }
+    },
+    "ChangelogRenderOptions": {
+      "type": "object",
+      "additionalProperties": true
     }
   }
 }

package/src/adapter/ngcli-adapter.js

@@ -105,6 +105,37 @@ async function scheduleTarget(root, opts, verbose) {
     }));
 }
 exports.scheduleTarget = scheduleTarget;
+function createNodeModulesEngineHost(resolvePaths) {
+    const NodeModulesEngineHost = require('@angular-devkit/schematics/tools')
+        .NodeModulesEngineHost;
+    class NxNodeModulesEngineHost extends NodeModulesEngineHost {
+        constructor() {
+            super(resolvePaths);
+        }
+        _resolveCollectionPath(name, requester) {
+            let collectionFilePath;
+            const paths = requester
+                ? [(0, path_1.dirname)(requester), ...(resolvePaths || [])]
+                : resolvePaths || [];
+            if (name.endsWith('.json')) {
+                collectionFilePath = require.resolve(name, { paths });
+            }
+            else {
+                const { json: { generators, schematics }, path: packageJsonPath, } = (0, nx_plugin_1.readPluginPackageJson)(name, paths);
+                if (!schematics && !generators) {
+                    throw new Error(`The "${name}" package does not support Nx generators or Angular Devkit schematics.`);
+                }
+                collectionFilePath = require.resolve((0, path_1.join)((0, path_1.dirname)(packageJsonPath), schematics ?? generators));
+            }
+            return collectionFilePath;
+        }
+        _transformCollectionDescription(name, desc) {
+            desc.schematics ??= desc.generators;
+            return super._transformCollectionDescription(name, desc);
+        }
+    }
+    return new NxNodeModulesEngineHost();
+}
 function createWorkflow(fsHost, root, opts) {
     const NodeWorkflow = require('@angular-devkit/schematics/tools').NodeWorkflow;
     const workflow = new NodeWorkflow(fsHost, {
@@ -114,6 +145,7 @@ function createWorkflow(fsHost, root, opts) {
         root: (0, core_1.normalize)(root),
         registry: new core_1.schema.CoreSchemaRegistry(require('@angular-devkit/schematics').formats.standardFormats),
         resolvePaths: [process.cwd(), root],
+        engineHostCreator: (options) => createNodeModulesEngineHost(options.resolvePaths),
     });
     workflow.registry.addPostTransform(core_1.schema.transforms.addUndefinedDefaults);
     workflow.engineHost.registerOptionsTransform(require('@angular-devkit/schematics/tools').validateOptionsWithSchema(workflow.registry));