create-nx-workspace 22.4.2 → 22.4.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nx-workspace",
-  "version": "22.4.2",
+  "version": "22.4.3",
   "private": false,
   "description": "Smart Repos · Fast Builds",
   "repository": {

package/src/create-workspace.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"create-workspace.d.ts","sourceRoot":"","sources":["../../../../packages/create-nx-workspace/src/create-workspace.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAGpE,OAAO,EAGL,aAAa,EACd,MAAM,iBAAiB,CAAC;AAsBzB,wBAAgB,4BAA4B,IAAI;IAC9C,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAEA;AAED,wBAAsB,eAAe,CAAC,CAAC,SAAS,sBAAsB,EACpE,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,CAAC,EACV,OAAO,CAAC,EAAE,CAAC;;;;;GA0LZ;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAI7D"}
+{"version":3,"file":"create-workspace.d.ts","sourceRoot":"","sources":["../../../../packages/create-nx-workspace/src/create-workspace.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAC;AAGpE,OAAO,EAGL,aAAa,EACd,MAAM,iBAAiB,CAAC;AA0BzB,wBAAgB,4BAA4B,IAAI;IAC9C,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;CAChC,CAEA;AAED,wBAAsB,eAAe,CAAC,CAAC,SAAS,sBAAsB,EACpE,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,CAAC,EACV,OAAO,CAAC,EAAE,CAAC;;;;;GA6MZ;AAED,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAI7D"}

package/src/create-workspace.js

@@ -16,6 +16,7 @@ const output_1 = require("./utils/output");
 const get_third_party_preset_1 = require("./utils/preset/get-third-party-preset");
 const preset_1 = require("./utils/preset/preset");
 const clone_template_1 = require("./utils/template/clone-template");
+const update_readme_1 = require("./utils/template/update-readme");
 const child_process_utils_1 = require("./utils/child-process-utils");
 const package_manager_1 = require("./utils/package-manager");
 // State for SIGINT handler - only set after workspace is fully installed
@@ -140,9 +141,25 @@ async function createWorkspace(preset, options, rawArgs) {
         connectUrl = await (0, nx_cloud_1.createNxCloudOnboardingUrl)(nxCloud, token, directory, useGitHub);
         // Store for SIGINT handler
         cloudConnectUrl = connectUrl;
+        // Update README with connect URL (strips markers, adds connect section)
+        // Then commit the change - amend if not pushed, new commit if already pushed
+        if (isTemplate) {
+            const readmeUpdated = (0, update_readme_1.addConnectUrlToReadme)(directory, connectUrl);
+            if (readmeUpdated && !skipGit && commit) {
+                const alreadyPushed = pushedToVcs === git_1.VcsPushStatus.PushedToVcs;
+                await (0, update_readme_1.amendOrCommitReadme)(directory, alreadyPushed);
+            }
+        }
         nxCloudInfo = await (0, nx_cloud_1.getNxCloudInfo)(connectUrl, pushedToVcs, options.completionMessageKey, name);
     }
     else if (isTemplate && nxCloud === 'skip') {
+        // Strip marker comments from README even when cloud is skipped
+        // so users don't see raw <!-- BEGIN/END: nx-cloud --> markers
+        const readmeUpdated = (0, update_readme_1.addConnectUrlToReadme)(directory, undefined);
+        if (readmeUpdated && !skipGit && commit) {
+            const alreadyPushed = pushedToVcs === git_1.VcsPushStatus.PushedToVcs;
+            await (0, update_readme_1.amendOrCommitReadme)(directory, alreadyPushed);
+        }
         // Show nx connect message when user skips cloud in template flow
         nxCloudInfo = (0, nx_cloud_1.getSkippedNxCloudInfo)();
     }

package/src/utils/template/update-readme.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Updates README content by processing the nx-cloud marker section.
+ * - If connectUrl is provided: replaces markers and content with the connect URL section
+ * - If connectUrl is undefined: removes markers and their content entirely
+ *
+ * This ensures users never see the raw <!-- BEGIN/END: nx-cloud --> markers in their README.
+ *
+ * @param readmeContent - The current README content
+ * @param connectUrl - The Nx Cloud connect URL (optional)
+ * @returns The updated README content with markers processed, or original if markers not found
+ */
+export declare function updateReadmeContent(readmeContent: string, connectUrl: string | undefined): string;
+/**
+ * Updates the README.md file in the given directory with the Nx Cloud connect URL.
+ * This is a convenience wrapper around updateReadmeContent that handles file I/O.
+ *
+ * @param directory - The workspace directory containing README.md
+ * @param connectUrl - The Nx Cloud connect URL
+ * @returns true if the file was modified, false otherwise
+ */
+export declare function addConnectUrlToReadme(directory: string, connectUrl: string | undefined): boolean;
+/**
+ * Commits README.md changes, either by amending the initial commit or creating a new one.
+ * - If already pushed to VCS: creates a new commit (to avoid requiring force push)
+ * - If not pushed: amends the initial commit (cleaner history)
+ *
+ * @param directory - The workspace directory
+ * @param alreadyPushed - Whether the repo was already pushed to VCS
+ */
+export declare function amendOrCommitReadme(directory: string, alreadyPushed: boolean): Promise<void>;
+//# sourceMappingURL=update-readme.d.ts.map

package/src/utils/template/update-readme.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-readme.d.ts","sourceRoot":"","sources":["../../../../../../packages/create-nx-workspace/src/utils/template/update-readme.ts"],"names":[],"mappings":"AAYA;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CACjC,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,GAAG,SAAS,GAC7B,MAAM,CAuCR;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,MAAM,EACjB,UAAU,EAAE,MAAM,GAAG,SAAS,GAC7B,OAAO,CAeT;AAED;;;;;;;GAOG;AACH,wBAAsB,mBAAmB,CACvC,SAAS,EAAE,MAAM,EACjB,aAAa,EAAE,OAAO,GACrB,OAAO,CAAC,IAAI,CAAC,CAWf"}

package/src/utils/template/update-readme.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateReadmeContent = updateReadmeContent;
+exports.addConnectUrlToReadme = addConnectUrlToReadme;
+exports.amendOrCommitReadme = amendOrCommitReadme;
+const node_fs_1 = require("node:fs");
+const path_1 = require("path");
+const child_process_utils_1 = require("../child-process-utils");
+const BEGIN_MARKER = '<!-- BEGIN: nx-cloud -->';
+const END_MARKER = '<!-- END: nx-cloud -->';
+const CLOUD_SETUP_SECTION = `## Finish your Nx platform setup
+
+🚀 [Finish setting up your workspace]({{CONNECT_URL}}) to get faster builds with remote caching, distributed task execution, and self-healing CI. [Learn more about Nx Cloud](https://nx.dev/ci/intro/why-nx-cloud).
+`;
+/**
+ * Updates README content by processing the nx-cloud marker section.
+ * - If connectUrl is provided: replaces markers and content with the connect URL section
+ * - If connectUrl is undefined: removes markers and their content entirely
+ *
+ * This ensures users never see the raw <!-- BEGIN/END: nx-cloud --> markers in their README.
+ *
+ * @param readmeContent - The current README content
+ * @param connectUrl - The Nx Cloud connect URL (optional)
+ * @returns The updated README content with markers processed, or original if markers not found
+ */
+function updateReadmeContent(readmeContent, connectUrl) {
+    const beginIndex = readmeContent.indexOf(BEGIN_MARKER);
+    const endIndex = readmeContent.indexOf(END_MARKER);
+    if (beginIndex === -1 || endIndex === -1 || beginIndex >= endIndex) {
+        return readmeContent;
+    }
+    // If no connect URL, remove the markers and placeholder content entirely
+    if (!connectUrl) {
+        // Remove the marker section and surrounding newlines to avoid extra blank lines
+        // Skip one newline before BEGIN marker (if present)
+        const beforeBegin = beginIndex > 0 && readmeContent[beginIndex - 1] === '\n'
+            ? beginIndex - 1
+            : beginIndex;
+        // Skip one newline after END marker (if present)
+        const afterEnd = endIndex + END_MARKER.length;
+        const skipTrailing = readmeContent[afterEnd] === '\n' ? afterEnd + 1 : afterEnd;
+        return (readmeContent.slice(0, beforeBegin) + readmeContent.slice(skipTrailing));
+    }
+    const section = CLOUD_SETUP_SECTION.replace('{{CONNECT_URL}}', connectUrl);
+    // Strip the markers - only include the section content
+    // Also skip one trailing newline after END marker since section already has one
+    const afterEnd = endIndex + END_MARKER.length;
+    const skipNewline = readmeContent[afterEnd] === '\n' ? afterEnd + 1 : afterEnd;
+    return (readmeContent.slice(0, beginIndex) +
+        section +
+        readmeContent.slice(skipNewline));
+}
+/**
+ * Updates the README.md file in the given directory with the Nx Cloud connect URL.
+ * This is a convenience wrapper around updateReadmeContent that handles file I/O.
+ *
+ * @param directory - The workspace directory containing README.md
+ * @param connectUrl - The Nx Cloud connect URL
+ * @returns true if the file was modified, false otherwise
+ */
+function addConnectUrlToReadme(directory, connectUrl) {
+    const readmePath = (0, path_1.join)(directory, 'README.md');
+    if (!(0, node_fs_1.existsSync)(readmePath)) {
+        return false;
+    }
+    const content = (0, node_fs_1.readFileSync)(readmePath, 'utf-8');
+    const updated = updateReadmeContent(content, connectUrl);
+    if (updated !== content) {
+        (0, node_fs_1.writeFileSync)(readmePath, updated);
+        return true;
+    }
+    return false;
+}
+/**
+ * Commits README.md changes, either by amending the initial commit or creating a new one.
+ * - If already pushed to VCS: creates a new commit (to avoid requiring force push)
+ * - If not pushed: amends the initial commit (cleaner history)
+ *
+ * @param directory - The workspace directory
+ * @param alreadyPushed - Whether the repo was already pushed to VCS
+ */
+async function amendOrCommitReadme(directory, alreadyPushed) {
+    await (0, child_process_utils_1.execAndWait)('git add README.md', directory);
+    if (alreadyPushed) {
+        await (0, child_process_utils_1.execAndWait)('git commit -m "chore: add Nx Cloud setup link to README"', directory);
+        await (0, child_process_utils_1.execAndWait)('git push', directory);
+    }
+    else {
+        await (0, child_process_utils_1.execAndWait)('git commit --amend --no-edit', directory);
+    }
+}