create-next-hydra 0.1.0 → 0.2.0

package/dist/scaffold.js

@@ -1,17 +1,28 @@
+import { stat } from "node:fs/promises";
 import path from "node:path";
+import { fileURLToPath } from "node:url";
 import { intro } from "@clack/prompts";
 import { cloneStarter } from "./clone.js";
+import { addCatalogReferences, loadGitHubSourceRegistryCatalog, loadSourceRegistryCatalog, } from "./composition/catalog.js";
+import { formatCompositionPlan } from "./composition/format.js";
+import { installPreparedComposition, prepareComposition, validatePackageRequirementTargets, } from "./composition/install.js";
+import { planComposition, selectionFromPreset } from "./composition/planner.js";
+import { applyPackageRequirements, applyPnpmPatches, removeWorkspaceTargets, } from "./composition/workspace.js";
 import { DEFAULT_PACKAGE_MANAGER } from "./constants.js";
-import { ensureParentDirectory, isDirectoryEmpty, pathExists, removePath, toDisplayPath, } from "./fs-utils.js";
-import { CommandExecutionError, ensureGitInstalled, initializeGitRepository, } from "./git.js";
-import { createSpinner, finish, info, printNextSteps, success, warn, } from "./logger.js";
+import { ensureParentDirectory, isDirectoryEmpty, pathExists, toDisplayPath, } from "./fs-utils.js";
+import { CommandExecutionError, ensureGitInstalled, initializeGitRepository, runCommand, } from "./git.js";
+import { createSpinner, finish, info, printInstructions, success, warn, } from "./logger.js";
+import { promptForProvider } from "./prompts.js";
 import { sanitizeStarter } from "./sanitize.js";
 const SHELL_NEEDS_QUOTING_REGEX = /[\s"'\\]/;
+const GITHUB_SCP_REPOSITORY = /^(?:git@|ssh:\/\/git@)github\.com[:/]([^/]+)\/([^/]+?)(?:\.git)?$/;
+const LEADING_SLASH = /^\//;
+const GIT_SUFFIX = /\.git$/;
 function quotePathForShell(value) {
     if (!SHELL_NEEDS_QUOTING_REGEX.test(value)) {
         return value;
     }
-    return `'${value.replace(/'/g, `'\"'\"'`)}'`;
+    return `'${value.replaceAll("'", `'"'"'`)}'`;
 }
 async function resolveAndValidateTarget(inputTargetDir) {
     const targetDir = inputTargetDir.trim();
@@ -20,8 +31,7 @@ async function resolveAndValidateTarget(inputTargetDir) {
     if (!targetName) {
         throw new Error("Please provide a valid target folder.");
     }
-    const existedBefore = await pathExists(targetPath);
-    if (existedBefore) {
+    if (await pathExists(targetPath)) {
         const isEmpty = await isDirectoryEmpty(targetPath);
         if (!isEmpty) {
             throw new Error(`Target directory is not empty: ${toDisplayPath(targetPath)}`);
@@ -30,46 +40,117 @@ async function resolveAndValidateTarget(inputTargetDir) {
     else {
         await ensureParentDirectory(targetPath);
     }
-    return { targetDir, targetName, targetPath, existedBefore };
+    return { targetDir, targetName, targetPath };
 }
 function formatGitError(error) {
-    const isCloneCommand = error.command.startsWith("git clone ");
     const stderr = error.stderr.trim();
-    if (stderr) {
-        if (!isCloneCommand) {
-            return `${error.command}\n\n${stderr}`;
-        }
-        return [
-            error.command,
-            "",
-            stderr,
+    const stdout = error.stdout.trim();
+    const detail = stderr || stdout || error.message;
+    const hint = error.command.startsWith("git clone ")
+        ? [
             "",
             "Hint: If the starter repo is private or you are testing locally, use `--repo-url`.",
             "Example: create-next-hydra my-app --repo-url /path/to/next-hydra",
-        ].join("\n");
+        ]
+        : [];
+    return [error.command, "", detail, ...hint].join("\n");
+}
+async function localRepositoryPath(repoUrl) {
+    let candidate;
+    if (repoUrl.startsWith("file:")) {
+        candidate = fileURLToPath(repoUrl);
     }
-    const stdout = error.stdout.trim();
-    if (stdout) {
-        if (!isCloneCommand) {
-            return `${error.command}\n\n${stdout}`;
+    else if (path.isAbsolute(repoUrl) ||
+        repoUrl.startsWith(".") ||
+        !repoUrl.includes(":")) {
+        candidate = path.resolve(repoUrl);
+    }
+    else {
+        return null;
+    }
+    try {
+        return (await stat(candidate)).isDirectory() ? candidate : null;
+    }
+    catch {
+        return null;
+    }
+}
+function githubRepository(repoUrl) {
+    const scpMatch = GITHUB_SCP_REPOSITORY.exec(repoUrl);
+    if (scpMatch?.[1] && scpMatch[2]) {
+        return `${scpMatch[1]}/${scpMatch[2]}`;
+    }
+    try {
+        const url = new URL(repoUrl);
+        if (url.hostname !== "github.com") {
+            return null;
         }
-        return [
-            error.command,
-            "",
-            stdout,
-            "",
-            "Hint: If the starter repo is private or you are testing locally, use `--repo-url`.",
-            "Example: create-next-hydra my-app --repo-url /path/to/next-hydra",
-        ].join("\n");
+        const parts = url.pathname
+            .replace(LEADING_SLASH, "")
+            .replace(GIT_SUFFIX, "")
+            .split("/");
+        return parts.length === 2 && parts[0] && parts[1]
+            ? `${parts[0]}/${parts[1]}`
+            : null;
+    }
+    catch {
+        return null;
     }
-    return `${error.command}\n\n${error.message}`;
 }
-export async function scaffoldProject(options) {
+async function requestedSelection(options, catalog) {
+    if (options.preset && (options.auth || options.cms || options.commerce)) {
+        throw new Error("`--preset` cannot be combined with provider flags.");
+    }
+    if (options.preset) {
+        const preset = selectionFromPreset(catalog, options.preset);
+        return {
+            ...preset,
+            addOns: [...new Set([...preset.addOns, ...(options.addOns ?? [])])],
+        };
+    }
+    if (options.yes && !(options.auth && options.cms && options.commerce)) {
+        throw new Error("`--yes` requires `--auth`, `--cms`, and `--commerce`, or one `--preset`.");
+    }
+    const auth = options.auth ?? (await promptForProvider("auth", "workos"));
+    const cms = options.cms ?? (await promptForProvider("cms", "drupal"));
+    const commerce = options.commerce ?? (await promptForProvider("commerce", "commercetools"));
+    return {
+        addOns: options.addOns ?? [],
+        providers: { auth, cms, commerce },
+    };
+}
+function explicitSelectionReferences(options) {
+    return [
+        options.auth,
+        options.cms,
+        options.commerce,
+        options.preset,
+        ...(options.addOns ?? []),
+    ].filter((value) => Boolean(value));
+}
+function scaffoldFailure(error, targetPath, failedStep, completed, pending) {
+    let cause = String(error);
+    if (error instanceof Error) {
+        cause = error.message;
+    }
+    if (error instanceof CommandExecutionError) {
+        cause = formatGitError(error);
+    }
+    return new Error([
+        `Scaffolding stopped while ${failedStep}.`,
+        `Target: ${targetPath}`,
+        `Completed: ${completed.length > 0 ? completed.join(", ") : "none"}.`,
+        `Not attempted: ${pending.length > 0 ? pending.join(", ") : "none"}.`,
+        "The partial project has been left exactly as it stands for inspection or repair.",
+        "",
+        cause,
+    ].join("\n"), { cause: error });
+}
+export async function scaffoldProject(options, dependencies = {}) {
     intro("create-next-hydra");
     const spin = createSpinner();
     const { repoUrl, ref, skipGit, commit, verbose } = options;
-    const targetDir = options.targetDir;
-    if (!targetDir) {
+    if (!options.targetDir) {
         throw new Error("Missing target directory.");
     }
     spin.start("Checking git availability");
@@ -77,40 +158,124 @@ export async function scaffoldProject(options) {
         await ensureGitInstalled(verbose);
         spin.stop("Git detected");
     }
-    catch {
+    catch (error) {
         spin.stop("Git not available");
-        throw new Error("Git is required to scaffold a project. Please install git and try again.");
+        throw new Error("Git is required to scaffold a project. Please install git and try again.", { cause: error });
+    }
+    const sourcePath = await localRepositoryPath(repoUrl);
+    const remoteRepository = sourcePath ? null : githubRepository(repoUrl);
+    let sourceCatalog;
+    if (sourcePath) {
+        sourceCatalog = await loadSourceRegistryCatalog(sourcePath);
     }
-    const { targetPath, targetName, existedBefore } = await resolveAndValidateTarget(targetDir);
-    let cloneCompleted = false;
+    else if (remoteRepository) {
+        sourceCatalog = await loadGitHubSourceRegistryCatalog(remoteRepository, ref);
+    }
+    else {
+        throw new Error("Composition preflight supports a local starter path or a public GitHub repository. Use one of those forms with `--repo-url`.");
+    }
+    sourceCatalog = await addCatalogReferences(sourceCatalog, explicitSelectionReferences(options), process.cwd());
+    const selection = await requestedSelection(options, sourceCatalog);
+    sourceCatalog = await addCatalogReferences(sourceCatalog, [...Object.values(selection.providers), ...selection.addOns], process.cwd());
+    planComposition(sourceCatalog, selection);
+    const { targetPath, targetName } = await resolveAndValidateTarget(options.targetDir);
+    const completed = [];
+    const pending = [
+        "clone the starter",
+        "resolve the composition",
+        "remove variable provider source",
+        "install selected source",
+        "update package aliases",
+        "update pnpm patches",
+        "remove maintainer-only files",
+        "install dependencies",
+        "initialize Git",
+    ];
+    let currentStep = "clone the starter";
+    const runStep = async (label, operation) => {
+        currentStep = label;
+        pending.shift();
+        const result = await operation();
+        completed.push(label);
+        return result;
+    };
     try {
         spin.start("Cloning next-hydra starter");
-        await cloneStarter({
-            repoUrl,
-            targetPath,
-            ref,
-            verbose,
+        await runStep("clone the starter", async () => {
+            await cloneStarter({ ref, repoUrl, targetPath, verbose });
         });
-        cloneCompleted = true;
         spin.stop("Starter cloned");
-        spin.start("Sanitizing starter");
-        const { packageName } = await sanitizeStarter({ targetPath, targetName });
-        spin.stop("Starter sanitized");
+        spin.start("Resolving workspace composition");
+        const { catalog, plan, prepared } = await runStep("resolve the composition", async () => {
+            let targetCatalog = await loadSourceRegistryCatalog(targetPath);
+            targetCatalog = await addCatalogReferences(targetCatalog, [
+                ...explicitSelectionReferences(options),
+                ...Object.values(selection.providers),
+                ...selection.addOns,
+            ], process.cwd());
+            const targetPlan = planComposition(targetCatalog, selection);
+            const targetPrepared = await prepareComposition(targetCatalog, targetPlan);
+            await validatePackageRequirementTargets(targetPath, targetPlan, targetPrepared, targetPlan.variableTargets);
+            return {
+                catalog: targetCatalog,
+                plan: targetPlan,
+                prepared: targetPrepared,
+            };
+        });
+        spin.stop("Composition resolved");
+        info(formatCompositionPlan(plan));
+        spin.start("Removing unselected provider source");
+        await runStep("remove variable provider source", async () => {
+            await removeWorkspaceTargets(targetPath, plan.variableTargets);
+        });
+        spin.stop("Variable provider source removed");
+        spin.start("Installing selected provider source");
+        await runStep("install selected source", async () => {
+            await installPreparedComposition(targetPath, prepared);
+        });
+        spin.stop("Selected provider source installed");
+        await runStep("update package aliases", async () => {
+            await applyPackageRequirements(targetPath, plan);
+        });
+        await runStep("update pnpm patches", async () => {
+            await applyPnpmPatches(targetPath, plan);
+        });
+        spin.start("Removing maintainer-only files");
+        const { packageName } = await runStep("remove maintainer-only files", async () => {
+            const result = await sanitizeStarter({
+                registryAuthoringPaths: catalog.authoringPaths,
+                targetName,
+                targetPath,
+            });
+            await removeWorkspaceTargets(targetPath, catalog.authoringPaths);
+            return result;
+        });
+        spin.stop("Maintainer-only files removed");
+        spin.start("Installing dependencies");
+        await runStep("install dependencies", async () => {
+            if (dependencies.install) {
+                await dependencies.install(targetPath, verbose);
+                return;
+            }
+            await runCommand(DEFAULT_PACKAGE_MANAGER, ["install"], {
+                cwd: targetPath,
+                verbose,
+            });
+        });
+        spin.stop("Dependencies installed");
         let gitInitialized = false;
         let committed = false;
         if (skipGit) {
+            pending.shift();
+            completed.push("skip Git initialization");
             info("Skipped git initialization (--skip-git).");
         }
         else {
             spin.start(commit
                 ? "Initializing git repo and creating initial commit"
                 : "Initializing git repo");
-            const gitResult = await initializeGitRepository(targetPath, {
-                commit,
-                verbose,
-            });
-            gitInitialized = gitResult.gitInitialized;
-            committed = gitResult.committed;
+            const gitResult = await runStep("initialize Git", async () => await initializeGitRepository(targetPath, { commit, verbose }));
+            ({ committed, gitInitialized } = gitResult);
             spin.stop(committed
                 ? "Git repo initialized with initial commit"
                 : "Git repo initialized");
@@ -119,31 +284,42 @@ export async function scaffoldProject(options) {
             }
         }
         const displayTarget = toDisplayPath(targetPath);
-        const cdTarget = quotePathForShell(displayTarget);
-        printNextSteps([
-            `cd ${cdTarget}`,
-            `${DEFAULT_PACKAGE_MANAGER} install`,
-            `${DEFAULT_PACKAGE_MANAGER} dev`,
-        ].join("\n"));
+        printInstructions([
+            ...(plan.instructions.length > 0
+                ? [
+                    {
+                        entries: plan.instructions.map((text) => ({
+                            kind: "text",
+                            text,
+                        })),
+                        title: "Provider setup",
+                    },
+                ]
+                : []),
+            {
+                entries: [
+                    {
+                        command: `cd ${quotePathForShell(displayTarget)}`,
+                        kind: "command",
+                    },
+                    {
+                        command: `${DEFAULT_PACKAGE_MANAGER} dev`,
+                        kind: "command",
+                    },
+                ],
+                title: "Next steps",
+            },
+        ]);
         success(`Created project in ${displayTarget}`);
         finish("Scaffold complete.");
         return {
-            projectPath: targetPath,
-            packageName,
-            gitInitialized,
             committed,
+            gitInitialized,
+            packageName,
+            projectPath: targetPath,
         };
     }
     catch (error) {
-        if (cloneCompleted === false && existedBefore === false) {
-            await removePath(targetPath);
-        }
-        if (error instanceof CommandExecutionError) {
-            throw new Error(formatGitError(error));
-        }
-        if (error instanceof Error) {
-            throw error;
-        }
-        throw new Error("Failed to scaffold project.");
+        throw scaffoldFailure(error, targetPath, currentStep, completed, pending);
     }
 }

package/dist/types.d.ts

@@ -6,6 +6,11 @@ export type CreateOptions = {
     ref?: string;
     repoUrl: string;
     verbose: boolean;
+    auth?: string;
+    cms?: string;
+    commerce?: string;
+    addOns?: string[];
+    preset?: string;
 };
 export type ResolvedCreateOptions = CreateOptions & {
     targetDir: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,OAAO,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,GAAG,EAAE,OAAO,CAAC;IACb,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG,aAAa,GAAG;IAClD,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC3B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B,cAAc,EAAE,OAAO,CAAC;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/version.d.ts

@@ -0,0 +1,2 @@
+export declare const CLI_VERSION: string;
+//# sourceMappingURL=version.d.ts.map

package/dist/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,WAAW,QAA0B,CAAC"}

package/dist/version.js

@@ -0,0 +1,2 @@
+import packageManifest from "../package.json" with { type: "json" };
+export const CLI_VERSION = packageManifest.version;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-next-hydra",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "CLI to scaffold a new next-hydra project",
   "keywords": [
     "cli",
@@ -13,14 +13,11 @@
   ],
   "license": "MIT",
   "type": "module",
-  "bin": {
-    "create-next-hydra": "dist/cli.js"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jakala-na/next-hydra",
+    "directory": "packages/create-next-hydra"
   },
-  "files": [
-    "dist"
-  ],
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -30,27 +27,42 @@
       "import": "./dist/cli.js"
     }
   },
-  "publishConfig": {
-    "access": "public"
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "bin": {
+    "create-next-hydra": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "schema"
+  ],
+  "dependencies": {
+    "@clack/prompts": "^0.11.0",
+    "commander": "^14.0.0",
+    "shadcn": "^4.16.2",
+    "yaml": "^2.9.0",
+    "zod": "^3.25.28"
+  },
+  "devDependencies": {
+    "@types/node": "24.13.3",
+    "typescript": "npm:@typescript/typescript6@6.0.2",
+    "vitest": "4.1.11",
+    "@repo/typescript-config": "0.0.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": "24.x"
+  },
+  "publishConfig": {
+    "access": "public"
   },
   "scripts": {
+    "prebuild": "node scripts/clean-dist.js",
     "build": "tsc -p tsconfig.json",
-    "typecheck": "tsc --noEmit -p tsconfig.json",
     "pack": "npm pack",
     "publish:dry-run": "npm publish --access public --dry-run",
     "publish:public": "npm publish --access public",
-    "prepublishOnly": "pnpm run build"
-  },
-  "dependencies": {
-    "@clack/prompts": "^0.11.0",
-    "commander": "^14.0.0"
-  },
-  "devDependencies": {
-    "@repo/typescript-config": "workspace:*",
-    "@types/node": "^22.15.21",
-    "typescript": "^5.8.3"
+    "test": "vitest run --exclude 'tests/e2e/**'",
+    "test:e2e": "vitest run tests/e2e",
+    "typecheck": "pnpm --workspace-root exec tsc --noEmit --project packages/create-next-hydra/tsconfig.json"
   }
-}
+}