create-nx-workspace 23.1.0-beta.5 → 23.1.0-beta.7

package/dist/bin/create-nx-workspace.d.ts

@@ -65,6 +65,8 @@ interface UnknownStackArguments extends BaseArguments {
 }
 type Arguments = NoneArguments | ReactArguments | AngularArguments | VueArguments | NodeArguments | UnknownStackArguments;
 export declare const commandsObject: yargs.Argv<Arguments>;
+/** Workspace names must start with a letter. */
+export declare function isValidWorkspaceName(name: string): boolean;
 export declare function validateWorkspaceName(name: string): void;
 /**
  * Resolves special folder name patterns (`.`, `./`, absolute paths) into a

package/dist/bin/create-nx-workspace.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.commandsObject = void 0;
+exports.isValidWorkspaceName = isValidWorkspaceName;
 exports.validateWorkspaceName = validateWorkspaceName;
 exports.resolveSpecialFolderName = resolveSpecialFolderName;
 exports.determineFolder = determineFolder;
@@ -620,9 +621,12 @@ function invariant(predicate, errorCode, message) {
         throw new error_utils_1.CnwError(errorCode, message);
     }
 }
+/** Workspace names must start with a letter. */
+function isValidWorkspaceName(name) {
+    return /^[a-zA-Z]/.test(name);
+}
 function validateWorkspaceName(name) {
-    const pattern = /^[a-zA-Z]/;
-    if (!pattern.test(name)) {
+    if (!isValidWorkspaceName(name)) {
         throw new error_utils_1.CnwError('INVALID_WORKSPACE_NAME', `The workspace name "${name}" is invalid. Workspace names must start with a letter. Examples of valid names: myapp, MyApp, my-app, my_app`);
     }
 }
@@ -641,12 +645,9 @@ function isCurrentDirReference(folderName) {
  * input is a regular name that needs no special handling.
  */
 function resolveSpecialFolderName(folderName) {
-    // User wants to init in the current directory
+    // User wants to scaffold in the current directory.
     if (isCurrentDirReference(folderName)) {
         const cwd = (0, path_1.resolve)(process.cwd());
-        if ((0, fs_1.readdirSync)(cwd).length > 0) {
-            throw new error_utils_1.CnwError('DIRECTORY_EXISTS', `The current directory is not empty. Use "nx init" to add Nx to an existing project.`);
-        }
         return { name: (0, path_1.basename)(cwd), workingDir: (0, path_1.dirname)(cwd) };
     }
     // Handle absolute paths like /tmp/acme
@@ -677,11 +678,20 @@ async function determineFolder(parsedArgs) {
             parsedArgs.workingDir = resolved.workingDir;
         }
         validateWorkspaceName(folderName);
-        // When input is "." or "./", resolveSpecialFolderName already validated
-        // the directory is empty. The target always "exists" because it IS the
-        // current working directory, so skip the existsSync check and default
-        // the workspace name to the directory name.
+        // When input is "." or "./", scaffold into the current directory. The
+        // target always "exists" because it IS the cwd, so skip the existsSync
+        // check and use the directory name as the workspace name.
         if (isCurrentDirReference(rawFolderName)) {
+            // Interactively confirm before scaffolding into the current directory;
+            // non-interactive (CI/AI) proceeds without prompting.
+            if (parsedArgs.interactive && !(0, is_ci_1.isCI)()) {
+                if (!(await promptCreateInCurrentDir(folderName))) {
+                    // Declined - fall back to creating a named subfolder under the cwd.
+                    parsedArgs.workingDir = undefined;
+                    return promptForFolder(parsedArgs);
+                }
+            }
+            parsedArgs.useCurrentDir = true;
             return folderName;
         }
         // If directory exists, either re-prompt (interactive) or error (non-interactive)
@@ -710,6 +720,18 @@ async function determineFolder(parsedArgs) {
     }
     return promptForFolder(parsedArgs);
 }
+async function promptCreateInCurrentDir(dirName) {
+    const { useCurrentDir } = await enquirer_1.default.prompt([
+        {
+            name: 'useCurrentDir',
+            message: `Create workspace in the current directory (${dirName})? Existing files may be overwritten.`,
+            type: 'autocomplete',
+            choices: [{ name: 'Yes' }, { name: 'No' }],
+            initial: 0,
+        },
+    ]);
+    return useCurrentDir === 'Yes';
+}
 async function promptForFolder(parsedArgs) {
     const reply = await enquirer_1.default.prompt([
         {
@@ -722,7 +744,7 @@ async function promptForFolder(parsedArgs) {
                 if (!value) {
                     return 'Folder name cannot be empty';
                 }
-                if (!/^[a-zA-Z]/.test(value)) {
+                if (!isValidWorkspaceName(value)) {
                     return 'Workspace name must start with a letter';
                 }
                 if ((0, fs_1.existsSync)(value)) {

package/dist/src/create-empty-workspace.js

@@ -27,10 +27,13 @@ async function createEmptyWorkspace(tmpDir, name, packageManager, options) {
     // Even though --skipInstall is not an option to create-nx-workspace, we pass through extra options to presets.
     // See: https://github.com/nrwl/nx/issues/31834
     delete options.skipInstall;
-    // workingDir is consumed by CNW itself, not passed to `nx new`
-    const { workingDir: _workingDir, ...nxNewOptions } = options;
+    // workingDir and useCurrentDir are consumed by CNW itself, not passed to `nx new`
+    const { workingDir: _workingDir, useCurrentDir, ...nxNewOptions } = options;
     const args = (0, unparse_1.unparse)({
         ...nxNewOptions,
+        // Scaffolding into the current directory: relax the generator's
+        // empty-directory guard so it can write into a non-empty cwd.
+        ...(useCurrentDir ? { skipEmptyDirCheck: true } : {}),
     }).join(' ');
     const pmc = (0, package_manager_1.getPackageManagerCommand)(packageManager);
     const command = `new ${args}`;

package/dist/src/create-workspace-options.d.ts

@@ -9,6 +9,12 @@ export interface CreateWorkspaceOptions {
      * Used when the user provides "." or an absolute path as the workspace name.
      */
     workingDir?: string;
+    /**
+     * @description Scaffold into the current directory in place. Set when the
+     * user passes "." / "./". Relaxes the empty-directory guard, so existing
+     * files in the cwd that collide with generated files are overwritten.
+     */
+    useCurrentDir?: boolean;
     packageManager: PackageManager;
     nxCloud: NxCloud;
     useGitHub?: boolean;

package/dist/src/create-workspace.js

@@ -16,7 +16,7 @@ const nx_cloud_1 = require("./utils/nx/nx-cloud");
 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 download_template_1 = require("./utils/template/download-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");
@@ -40,21 +40,27 @@ async function createWorkspace(preset, options, rawArgs) {
         options.template = resolveTemplateShorthand(options.template);
         if (!options.template.startsWith('nrwl/'))
             throw new Error(`Invalid template. Only templates from the 'nrwl' GitHub org are supported.`);
-        const templateUrl = `https://github.com/${options.template}`;
         const workingDir = (options.workingDir ?? process.cwd()).replace(/\\/g, '/');
         directory = (0, path_1.join)(workingDir, name);
+        // downloadTemplate extracts into `directory`, creating it and overwriting
+        // files. That is intended only when scaffolding into the current directory.
+        // Otherwise refuse to write over an existing path (the CLI already guards
+        // this in determineFolder; this protects direct createWorkspace() callers).
+        if (!options.useCurrentDir && (0, node_fs_1.existsSync)(directory)) {
+            throw new error_utils_2.CnwError('DIRECTORY_EXISTS', `The directory '${directory}' already exists. Choose a different name or remove the existing directory.`);
+        }
         const aiMode = (0, ai_output_1.isAiAgent)();
         // Use spinner for human mode, progress logs for AI mode
         let workspaceSetupSpinner;
         if (aiMode) {
-            (0, ai_output_1.logProgress)('cloning', `Cloning template ${options.template}...`);
+            (0, ai_output_1.logProgress)('downloading', `Downloading template ${options.template}...`);
         }
         else {
             const ora = require('ora');
             workspaceSetupSpinner = ora(`Creating workspace from template`).start();
         }
         try {
-            await (0, clone_template_1.cloneTemplate)(templateUrl, name, workingDir);
+            await (0, download_template_1.downloadTemplate)(options.template, directory);
             // Remove npm lockfile from template since we'll generate the correct one
             const npmLockPath = (0, path_1.join)(directory, 'package-lock.json');
             if ((0, node_fs_1.existsSync)(npmLockPath)) {

package/dist/src/internal-utils/prompts.js

@@ -14,7 +14,6 @@ const enquirer_1 = tslib_1.__importDefault(require("enquirer"));
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const ab_testing_1 = require("../utils/nx/ab-testing");
 const default_base_1 = require("../utils/git/default-base");
-const git_1 = require("../utils/git/git");
 const package_manager_1 = require("../utils/package-manager");
 const string_utils_1 = require("../utils/string-utils");
 const is_ci_1 = require("../utils/ci/is-ci");
@@ -102,9 +101,6 @@ async function determineTemplate(parsedArgs) {
     // Docs generation needs preset flow to document all presets
     if (process.env.NX_GENERATE_DOCS_PROCESS === 'true')
         return 'custom';
-    // Template flow requires git for cloning - fall back to custom preset if git is not available
-    if (!(0, git_1.isGitAvailable)())
-        return 'custom';
     const { template } = await enquirer_1.default.prompt([
         {
             name: 'template',

package/dist/src/utils/ai/ai-output.d.ts

@@ -16,7 +16,7 @@ export declare function isReplitAi(): boolean;
 export declare function isCursorAi(): boolean;
 export declare function isGeminiCli(): boolean;
 export declare function detectAiAgentName(): string | null;
-export type ProgressStage = 'starting' | 'cloning' | 'installing' | 'configuring' | 'initializing' | 'complete' | 'error';
+export type ProgressStage = 'starting' | 'downloading' | 'installing' | 'configuring' | 'initializing' | 'complete' | 'error';
 export interface ProgressMessage {
     stage: ProgressStage;
     message: string;

package/dist/src/utils/git/git.d.ts

@@ -9,11 +9,6 @@ export declare class GitHubPushError extends Error {
     constructor(message: string, reason: 'gh-not-installed' | 'gh-auth-failed' | 'push-timeout' | 'push-failed' | 'env-skip');
 }
 export declare function checkGitVersion(): Promise<string | null | undefined>;
-/**
- * Synchronously checks if git is available on the system.
- * Returns true if git command can be executed, false otherwise.
- */
-export declare function isGitAvailable(): boolean;
 /**
  * Synchronously checks if GitHub CLI (gh) is available on the system.
  * Returns true if gh command can be executed within 2 seconds, false otherwise.

package/dist/src/utils/git/git.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.GitHubPushError = exports.VcsPushStatus = void 0;
 exports.checkGitVersion = checkGitVersion;
-exports.isGitAvailable = isGitAvailable;
 exports.isGhCliAvailable = isGhCliAvailable;
 exports.initializeGitRepo = initializeGitRepo;
 exports.pushToGitHub = pushToGitHub;
@@ -37,19 +36,6 @@ async function checkGitVersion() {
         return null;
     }
 }
-/**
- * Synchronously checks if git is available on the system.
- * Returns true if git command can be executed, false otherwise.
- */
-function isGitAvailable() {
-    try {
-        (0, child_process_1.execSync)('git --version', { stdio: 'ignore', windowsHide: true });
-        return true;
-    }
-    catch {
-        return false;
-    }
-}
 // 1 second timeout for gh CLI pre-flight checks (version, auth). If gh is
 // wrapped by 1Password, a credential manager, or corporate SSO the call can
 // hang indefinitely. Better to skip the push than freeze the CLI.
@@ -155,9 +141,11 @@ async function initializeGitRepo(directory, options) {
     }
     const insideRepo = await (0, child_process_utils_1.execAndWait)('git rev-parse --is-inside-work-tree', directory, true).then(() => true, () => false);
     if (insideRepo) {
-        output_1.output.log({
-            title: 'Directory is already under version control. Skipping initialization of git.',
-        });
+        if (process.env.NX_VERBOSE_LOGGING === 'true') {
+            output_1.output.log({
+                title: 'Directory is already under version control. Skipping initialization of git.',
+            });
+        }
         return;
     }
     const defaultBase = options.defaultBase || (0, default_base_1.deduceDefaultBase)();

package/dist/src/utils/nx/ab-testing.d.ts

@@ -2,10 +2,10 @@ import type { BannerVariant, CompletionMessageKey } from './messages';
 export declare const NX_CLOUD_URL = "https://nx.dev/nx-cloud";
 /**
  * Clickable Nx Cloud marketing link for cloud prompt footers. Every
- * create-nx-workspace prompt reports the same medium, so the link is a single
- * baked constant embedded directly in the footers. Visible text stays the clean
- * `NX_CLOUD_URL` while clicks carry UTM attribution; terminals without OSC 8
- * support just render the bare URL (CLOUD-4642).
+ * create-nx-workspace prompt reports the same content tag, so the link is a
+ * single baked constant embedded directly in the footers. Visible text stays
+ * the clean `NX_CLOUD_URL` while clicks carry UTM attribution; terminals
+ * without OSC 8 support just render the bare URL (CLOUD-4642).
  */
 export declare const NX_CLOUD_HYPERLINK: string;
 /**

package/dist/src/utils/nx/ab-testing.js

@@ -17,12 +17,12 @@ const terminal_link_1 = require("../terminal-link");
 exports.NX_CLOUD_URL = 'https://nx.dev/nx-cloud';
 /**
  * Clickable Nx Cloud marketing link for cloud prompt footers. Every
- * create-nx-workspace prompt reports the same medium, so the link is a single
- * baked constant embedded directly in the footers. Visible text stays the clean
- * `NX_CLOUD_URL` while clicks carry UTM attribution; terminals without OSC 8
- * support just render the bare URL (CLOUD-4642).
+ * create-nx-workspace prompt reports the same content tag, so the link is a
+ * single baked constant embedded directly in the footers. Visible text stays
+ * the clean `NX_CLOUD_URL` while clicks carry UTM attribution; terminals
+ * without OSC 8 support just render the bare URL (CLOUD-4642).
  */
-exports.NX_CLOUD_HYPERLINK = (0, terminal_link_1.terminalLink)(exports.NX_CLOUD_URL, `${exports.NX_CLOUD_URL}?utm_source=nx-cli&utm_medium=create-nx-workspace`);
+exports.NX_CLOUD_HYPERLINK = (0, terminal_link_1.terminalLink)(exports.NX_CLOUD_URL, `${exports.NX_CLOUD_URL}?utm_source=nx-cli&utm_medium=cli&utm_campaign=nx-cloud-connect&utm_content=create-nx-workspace`);
 // Flow variant controls both tracking and banner display (CLOUD-4235)
 // Variants: 0 = control, 1 = updated prompt, 2 = no prompt (auto-connect)
 const FLOW_VARIANT_CACHE_FILE = (0, node_path_1.join)((0, node_os_1.tmpdir)(), 'nx-cnw-flow-variant');

package/dist/src/utils/template/download-template.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Download an nrwl template repository and extract it into `directory`.
+ *
+ * git is not required (fresh machines / CI / AI agents may have none), and an
+ * existing `.git` in `directory` is left intact, so this can scaffold into the
+ * current directory. Existing files (e.g. README) are overwritten.
+ *
+ * @param template GitHub repo slug, e.g. `nrwl/react-template`.
+ * @param directory Absolute path to extract into.
+ */
+export declare function downloadTemplate(template: string, directory: string): Promise<void>;

package/dist/src/utils/template/download-template.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.downloadTemplate = downloadTemplate;
+const tslib_1 = require("tslib");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const node_stream_1 = require("node:stream");
+const promises_1 = require("node:stream/promises");
+const node_zlib_1 = require("node:zlib");
+const tar = tslib_1.__importStar(require("tar-stream"));
+const error_utils_1 = require("../error-utils");
+// Branches to try, in order. GitHub serves a gzipped tarball of a repo at
+// https://github.com/<org>/<repo>/archive/refs/heads/<branch>.tar.gz.
+const DEFAULT_BRANCHES = ['main', 'master'];
+/**
+ * Download an nrwl template repository and extract it into `directory`.
+ *
+ * git is not required (fresh machines / CI / AI agents may have none), and an
+ * existing `.git` in `directory` is left intact, so this can scaffold into the
+ * current directory. Existing files (e.g. README) are overwritten.
+ *
+ * @param template GitHub repo slug, e.g. `nrwl/react-template`.
+ * @param directory Absolute path to extract into.
+ */
+async function downloadTemplate(template, directory) {
+    let body;
+    const attempts = [];
+    // A thrown fetch is a connectivity problem; a non-ok response is a missing
+    // branch/repo. Distinguish them so the error code (and its hints) are right.
+    let networkError = false;
+    for (const branch of DEFAULT_BRANCHES) {
+        const url = `https://github.com/${template}/archive/refs/heads/${branch}.tar.gz`;
+        try {
+            const res = await fetch(url);
+            if (res.ok && res.body) {
+                body = res.body;
+                break;
+            }
+            attempts.push(`${branch}: HTTP ${res.status}`);
+        }
+        catch (e) {
+            networkError = true;
+            attempts.push(`${branch}: ${e instanceof Error ? e.message : String(e)}`);
+        }
+    }
+    if (!body) {
+        throw new error_utils_1.CnwError(networkError ? 'NETWORK_ERROR' : 'TEMPLATE_CLONE_FAILED', `Failed to download template '${template}' (${attempts.join('; ')})`);
+    }
+    // Only remove the directory on failure if we created it - never delete a
+    // pre-existing dir (e.g. the user's current directory).
+    const dirPreexisted = (0, node_fs_1.existsSync)(directory);
+    (0, node_fs_1.mkdirSync)(directory, { recursive: true });
+    try {
+        await extractTarball(body, directory);
+    }
+    catch (e) {
+        if (!dirPreexisted) {
+            (0, node_fs_1.rmSync)(directory, { recursive: true, force: true });
+        }
+        const message = e instanceof Error ? e.message : String(e);
+        throw new error_utils_1.CnwError('TEMPLATE_CLONE_FAILED', `Failed to create starter workspace: ${message}`);
+    }
+}
+async function extractTarball(body, directory) {
+    const extract = tar.extract();
+    extract.on('entry', (header, stream, next) => {
+        // Drain the entry and move to the next one without writing anything.
+        const skip = () => {
+            stream.on('end', next);
+            stream.resume();
+        };
+        try {
+            // GitHub wraps everything in a top-level `<repo>-<branch>/` directory.
+            // Strip that first segment so files land directly in `directory`.
+            const relativePath = header.name.split('/').slice(1).join('/');
+            // Top-level dir entry or unsupported type (symlink, pax header).
+            if (!relativePath ||
+                (header.type !== 'file' && header.type !== 'directory')) {
+                return skip();
+            }
+            const destPath = (0, node_path_1.join)(directory, relativePath);
+            // Defense-in-depth against a malicious tarball escaping the target dir
+            // (zip-slip) via `..` entries.
+            const rel = (0, node_path_1.relative)(directory, destPath);
+            if (rel.startsWith('..') || (0, node_path_1.isAbsolute)(rel)) {
+                return skip();
+            }
+            if (header.type === 'directory') {
+                (0, node_fs_1.mkdirSync)(destPath, { recursive: true });
+                return skip();
+            }
+            (0, node_fs_1.mkdirSync)((0, node_path_1.dirname)(destPath), { recursive: true });
+            const writeStream = (0, node_fs_1.createWriteStream)(destPath, { mode: header.mode });
+            // Surface a write failure to the pipeline below so it rejects and tears
+            // down every stream.
+            writeStream.on('error', (err) => extract.destroy(err));
+            writeStream.on('close', next);
+            stream.pipe(writeStream);
+        }
+        catch (err) {
+            // A synchronous failure here (e.g. mkdirSync hitting EACCES/ENOSPC, or a
+            // path component that is a file) would otherwise escape the awaited
+            // pipeline; route it so the operation rejects instead of crashing.
+            extract.destroy(err);
+        }
+    });
+    // pipeline (unlike a manual .pipe() chain) forwards errors from every stage -
+    // a network drop on the source or a corrupt/truncated gzip rejects here and
+    // destroys all streams, so the caller can wrap it in a CnwError.
+    // Cast: the global (DOM) ReadableStream and node:stream/web differ structurally.
+    await (0, promises_1.pipeline)(node_stream_1.Readable.fromWeb(body), (0, node_zlib_1.createGunzip)(), extract);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-nx-workspace",
-  "version": "23.1.0-beta.5",
+  "version": "23.1.0-beta.7",
   "private": false,
   "description": "Smart Monorepos · Fast Builds",
   "repository": {
@@ -43,6 +43,7 @@
     "flat": "^5.0.2",
     "open": "^8.4.0",
     "ora": "^5.3.0",
+    "tar-stream": "~2.2.0",
     "tmp": "~0.2.7",
     "tslib": "^2.3.0",
     "yargs": "^17.6.2"

package/dist/src/utils/template/clone-template.d.ts

@@ -1 +0,0 @@
-export declare function cloneTemplate(templateUrl: string, targetDirectory: string, workingDir?: string): Promise<void>;

package/dist/src/utils/template/clone-template.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cloneTemplate = cloneTemplate;
-const child_process_utils_1 = require("../child-process-utils");
-const fs_1 = require("fs");
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const error_utils_1 = require("../error-utils");
-async function cloneTemplate(templateUrl, targetDirectory, workingDir) {
-    if ((0, fs_1.existsSync)(targetDirectory)) {
-        throw new error_utils_1.CnwError('DIRECTORY_EXISTS', `The directory '${targetDirectory}' already exists. Choose a different name or remove the existing directory.`);
-    }
-    try {
-        await (0, child_process_utils_1.execAndWait)(`git clone --depth 1 "${templateUrl}" "${targetDirectory}"`, workingDir ?? process.cwd());
-        // Ensure clean history
-        const gitDir = (0, path_1.join)(targetDirectory, '.git');
-        if ((0, fs_1.existsSync)(gitDir)) {
-            await (0, promises_1.rm)(gitDir, { recursive: true, force: true });
-        }
-    }
-    catch (e) {
-        const message = e instanceof Error ? e.message : String(e);
-        throw new error_utils_1.CnwError('TEMPLATE_CLONE_FAILED', `Failed to create starter workspace: ${message}`);
-    }
-}