create-gtkx 1.6.0 → 2.0.0-beta.10

package/src/scaffolder.ts

@@ -2,8 +2,8 @@ import * as p from "@clack/prompts";
 import { APPLICATION_ID_MAX_LENGTH, isValidApplicationId } from "@gtkx/config/internal";
 import { errorMessage, tryResolveExecutable, upperFirst } from "@gtkx/utils";
 import { execFileSync } from "node:child_process";
-import { mkdirSync, readdirSync, rmSync, type Stats, statSync, writeFileSync } from "node:fs";
-import { basename, dirname, join, resolve } from "node:path";
+import { lstatSync, mkdirSync, readdirSync, rmSync, statSync, writeFileSync } from "node:fs";
+import { basename, dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
 import { addDependency, detectPackageManager as nypmDetectPackageManager } from "nypm";
 import { x } from "tinyexec";
 import packageManifest from "../package.json" with { type: "json" };
@@ -23,11 +23,13 @@ import { listTemplates, renderFile, type TemplateContext } from "./templates.js"
 type CreateOptions = {
     name?: string | undefined;
     applicationId?: string | undefined;
+    displayName?: string | undefined;
     packageManager?: string | undefined;
     isTypescript?: boolean | undefined;
     shouldIncludeTesting?: boolean | undefined;
     isInteractive?: boolean | undefined;
     shouldOverwrite?: boolean | undefined;
+    shouldInstallDependencies?: boolean | undefined;
 };
 
 type ResolvedOptions = {
@@ -35,11 +37,28 @@ type ResolvedOptions = {
     root: string;
     isCurrentDirectory: boolean;
     name: string;
+    displayName: string;
     applicationId: string;
     packageManager: PackageManager;
     isTypescript: boolean;
     shouldIncludeTesting: boolean;
-    shouldEmptyTarget: boolean;
+    shouldInitializeGit: boolean;
+    shouldInstallDependencies: boolean;
+};
+
+type ScaffoldFile = { destination: string; contents: string };
+
+type ScaffoldChanges = string[];
+
+type ScaffoldPlan = {
+    files: ScaffoldFile[];
+    replaceDestinations: string[];
+    changes: ScaffoldChanges;
+};
+
+type ScaffoldChange = {
+    destination: string;
+    relativePath: string;
 };
 
 type InstallDependenciesOptions = {
@@ -64,12 +83,13 @@ type SpinnerStep = {
     pending: string;
     done: string;
     failed: string;
-    run: () => Promise<void>;
+    run: () => Promise<void> | void;
     explain?: ((error: unknown) => void) | undefined;
 };
 
 const selfVersion = packageManifest.version;
 const ICON_TEMPLATE_NAME = "icon.svg";
+const TYPESCRIPT_VERSION = "^6.0.3";
 
 const GTKX_ENV_MODULE_HEADER = `/**
  * Generated by \`gtkx codegen\`, \`gtkx dev\`, and \`gtkx build\`; do not edit.
@@ -88,6 +108,10 @@ const ADD_COMMAND: Record<PackageManager, string> = Object.fromEntries(
     PACKAGE_MANAGERS.map((manager) => [manager.value, manager.addCommand]),
 ) as Record<PackageManager, string>;
 
+const INSTALL_COMMAND: Record<PackageManager, string> = Object.fromEntries(
+    PACKAGE_MANAGERS.map((manager) => [manager.value, manager.installCommand]),
+) as Record<PackageManager, string>;
+
 const INHERITED_SCRIPT_POLICY_VARS = ["npm_config_allow_scripts", "npm_config_allow-scripts"];
 const TESTING_TEMPLATES = new Set(["vitest.config.ts", "tests/app.test.tsx"]);
 const TYPESCRIPT_TEMPLATES = new Set(["tsconfig.json", "src/gtkx-env.d.ts"]);
@@ -106,12 +130,8 @@ const APPLICATION_ID_SUFFIX = ".app";
 const APPLICATION_ID_SEGMENT_LIMIT = APPLICATION_ID_MAX_LENGTH - APPLICATION_ID_PREFIX.length -
     APPLICATION_ID_SUFFIX.length;
 
-const pinGtkxDependency = (name: string, version: string): string =>
-    name.startsWith("@gtkx/") ? `${name}@^${version}` : name;
-
-const getDevCommand = (packageManager: PackageManager): string => DEV_COMMAND[packageManager];
-const getAddCommand = (packageManager: PackageManager): string => ADD_COMMAND[packageManager];
-const titleFromName = (name: string): string => name.split("-").map((part) => upperFirst(part)).join(" ");
+const displayNameFromProjectName = (name: string): string =>
+    name.split("-").map((part) => upperFirst(part)).join(" ");
 
 const gitConfigValue = (key: string): string | null => {
     const git = tryResolveExecutable("git");
@@ -147,7 +167,9 @@ const stripTrailingSlashes = (value: string): string => {
     return value.slice(0, end);
 };
 
-const formatTargetDir = (target: string): string => stripTrailingSlashes(target.trim().replaceAll(/[<>:"\\|?*]/g, ""));
+const formatTargetDir = (target: string): string =>
+    stripTrailingSlashes(target.trim().replaceAll(/[<>:"\\|?*]/g, ""));
+
 const deriveProjectName = (target: string): string => basename(resolve(process.cwd(), target));
 
 const isDirEmpty = (dir: string): boolean => {
@@ -156,6 +178,12 @@ const isDirEmpty = (dir: string): boolean => {
     return entries.length === 0 || (entries.length === 1 && entries[0] === ".git");
 };
 
+const shouldInitializeGit = (root: string): boolean => {
+    const entry = lstatSync(root, { throwIfNoEntry: false });
+
+    return entry === undefined || (entry.isDirectory() && readdirSync(root).length === 0);
+};
+
 const getDevDependencies = ({
     isTypescript,
     shouldIncludeTesting,
@@ -173,8 +201,10 @@ const getDevDependencies = ({
     return devDeps;
 };
 
+const isCancellation = (value: unknown): value is symbol => p.isCancel(value);
+
 const guardCancellation = <T>(value: T | symbol): T => {
-    if (p.isCancel(value)) {
+    if (isCancellation(value)) {
         p.cancel("Operation canceled");
         throw new OperationCanceledError();
     }
@@ -203,6 +233,17 @@ const validateApplicationIdInput = (value: string | undefined): string | undefin
 const validateApplicationIdAnswer = (value: string | undefined): string | undefined =>
     value ? validateApplicationIdFormat(value) : undefined;
 
+const validateDisplayName = (value: string | undefined): string | undefined => {
+    if (value === undefined || value.trim().length === 0) {
+        return "Display name is required";
+    }
+
+    return value.includes("\n") || value.includes("\r") ? "Display name must be a single line" : undefined;
+};
+
+const validateDisplayNameAnswer = (value: string | undefined): string | undefined =>
+    value ? validateDisplayName(value) : undefined;
+
 const fail = (message: string): never => {
     p.log.error(message);
     throw new ScaffoldAbortedError(message);
@@ -220,14 +261,6 @@ const requestedPackageManager = (value: string | undefined): PackageManager | un
     return value;
 };
 
-const targetStats = (root: string): Stats | undefined => {
-    try {
-        return statSync(root, { throwIfNoEntry: false });
-    } catch {
-        return undefined;
-    }
-};
-
 const validateTargetDir = (target: string): string | undefined => {
     if (!target) {
         return "Project directory is required";
@@ -263,40 +296,36 @@ const promptApplicationId = async (name: string): Promise<string> => {
     );
 };
 
-const detectPackageManager = async (cwd: string): Promise<PackageManager | undefined> => {
-    const detected = await nypmDetectPackageManager(cwd, { includeParentDirs: true });
-
-    if (!detected) {
-        return undefined;
-    }
+const promptDisplayName = async (name: string): Promise<string> => {
+    const defaultDisplayName = displayNameFromProjectName(name);
 
-    return isKnownPackageManager(detected.name) ? detected.name : undefined;
+    return guardCancellation(
+        await p.text({
+            message: "Display name",
+            placeholder: defaultDisplayName,
+            defaultValue: defaultDisplayName,
+            validate: validateDisplayNameAnswer,
+        }),
+    );
 };
 
-const packageManagerHint = (
-    manager: (typeof PACKAGE_MANAGERS)[number],
-    detected: PackageManager | undefined,
-): string | undefined => {
-    if (detected === manager.value) {
-        return "detected";
-    }
+const packageManagerOption = (manager: (typeof PACKAGE_MANAGERS)[number], detected: PackageManager | undefined) => {
+    let hint: string | undefined;
 
-    if (manager.isRecommended) {
-        return "recommended";
+    if (detected === manager.value) {
+        hint = "detected";
+    } else if (manager.isRecommended) {
+        hint = "recommended";
     }
 
-    return undefined;
-};
-
-const packageManagerOption = (manager: (typeof PACKAGE_MANAGERS)[number], detected: PackageManager | undefined) => {
-    const hint = packageManagerHint(manager, detected);
-
     return { value: manager.value, label: manager.label, ...(hint !== undefined && { hint }) };
 };
 
 const detectedPackageManager = async (): Promise<PackageManager | undefined> => {
     try {
-        return await detectPackageManager(process.cwd());
+        const detected = await nypmDetectPackageManager(process.cwd(), { includeParentDirs: true });
+
+        return detected && isKnownPackageManager(detected.name) ? detected.name : undefined;
     } catch {
         return undefined;
     }
@@ -315,73 +344,101 @@ const promptPackageManager = async (): Promise<PackageManager> => {
     );
 };
 
-const shouldUseTypeScript = async (): Promise<boolean> =>
-    guardCancellation(
-        await p.confirm({
-            message: "Use TypeScript?",
-            initialValue: true,
-        }),
-    );
+const isOptionEnabled = async (
+    value: boolean | undefined,
+    isInteractive: boolean | undefined,
+    message: string,
+): Promise<boolean> =>
+    value ??
+    (isInteractive
+        ? guardCancellation(await p.confirm({ message, initialValue: true }))
+        : true);
 
-const shouldSetUpTesting = async (): Promise<boolean> =>
-    guardCancellation(
-        await p.confirm({
-            message: "Include testing setup (Vitest)?",
-            initialValue: true,
-        }),
-    );
+const formatFileList = (heading: string, files: string[]): string => {
+    const indentedFiles = files.map((file) => `  ${file}`).join("\n");
 
-const emptyDir = (root: string): void => {
-    for (const entry of readdirSync(root)) {
-        if (entry === ".git") {
-            continue;
-        }
+    return `${heading}:\n${indentedFiles}`;
+};
 
-        rmSync(join(root, entry), { recursive: true, force: true });
+const reportPlannedChanges = (changes: ScaffoldChanges): void => {
+    if (changes.length > 0) {
+        p.log.info(formatFileList("Scaffold files to replace", changes));
     }
 };
 
-const prepareTargetDirectory = (root: string, shouldEmptyTarget: boolean): void => {
-    mkdirSync(root, { recursive: true });
-
-    if (shouldEmptyTarget) {
-        emptyDir(root);
+const reportCompletedChanges = (changes: ScaffoldChanges): void => {
+    if (changes.length > 0) {
+        p.log.success(formatFileList("Replaced scaffold files", changes));
     }
 };
 
-const shouldOverwriteDirectory = async (target: string, options: CreateOptions): Promise<boolean> => {
-    if (!options.isInteractive) {
-        return options.shouldOverwrite === true;
-    }
+const confirmOverwrite = async (target: string, changes: ScaffoldChanges): Promise<void> => {
+    reportPlannedChanges(changes);
 
-    return guardCancellation(
+    const shouldReplace = guardCancellation(
         await p.confirm({
-            message: `Directory "${target}" is not empty. Overwrite its contents?`,
+            message: `Directory "${target}" is not empty. Replace scaffold files?`,
             initialValue: false,
         }),
     );
+
+    if (!shouldReplace) {
+        fail(`Directory "${target}" is not empty`);
+    }
 };
 
-const shouldEmptyTargetDirectory = async (root: string, target: string, options: CreateOptions): Promise<boolean> => {
-    const stats = targetStats(root);
+const refuseNonEmptyDirectory = (target: string, changes: ScaffoldChanges): never => {
+    const heading = `Directory "${target}" is not empty. Pass --overwrite to`;
 
-    if (stats === undefined) {
-        return false;
+    return fail(
+        changes.length === 0
+            ? `${heading} scaffold into it`
+            : formatFileList(`${heading} replace these scaffold files`, changes),
+    );
+};
+
+const acceptNonEmptyDirectory = async (
+    target: string,
+    options: CreateOptions,
+    changes: ScaffoldChanges,
+): Promise<void> => {
+    if (options.isInteractive) {
+        await confirmOverwrite(target, changes);
+
+        return;
     }
 
-    if (!stats.isDirectory()) {
-        return fail(`Target "${target}" is not a directory`);
+    if (options.shouldOverwrite === true) {
+        reportPlannedChanges(changes);
+
+        return;
     }
 
-    if (isDirEmpty(root)) {
-        return false;
+    refuseNonEmptyDirectory(target, changes);
+};
+
+const assertTargetIsDirectory = (root: string, target: string): void => {
+    const stats = statSync(root, { throwIfNoEntry: false });
+
+    if (stats !== undefined && !stats.isDirectory()) {
+        fail(`Target "${target}" is not a directory`);
     }
+};
 
-    if (await shouldOverwriteDirectory(target, options)) {
-        return true;
+const validateTargetAvailability = async (
+    root: string,
+    target: string,
+    options: CreateOptions,
+    changes: ScaffoldChanges,
+): Promise<void> => {
+    const stats = statSync(root, { throwIfNoEntry: false });
+    assertTargetIsDirectory(root, target);
+
+    if (stats === undefined || isDirEmpty(root)) {
+        return;
     }
 
-    return fail(`Directory "${target}" is not empty`);
+    await acceptNonEmptyDirectory(target, options, changes);
 };
 
 const resolveTarget = async (options: CreateOptions): Promise<string> => {
@@ -404,6 +461,14 @@ const resolveApplicationId = async (options: CreateOptions, name: string): Promi
     return error === undefined ? applicationId : fail(error);
 };
 
+const resolveDisplayName = async (options: CreateOptions, name: string): Promise<string> => {
+    const value = options.displayName ??
+        (options.isInteractive ? await promptDisplayName(name) : displayNameFromProjectName(name));
+    const error = validateDisplayName(value);
+
+    return error === undefined ? value.trim() : fail(error);
+};
+
 const resolvePackageManager = async (
     requested: PackageManager | undefined,
     options: CreateOptions,
@@ -419,44 +484,36 @@ const resolvePackageManager = async (
     return (await detectedPackageManager()) ?? "pnpm";
 };
 
-const isTypescriptSelected = async (options: CreateOptions): Promise<boolean> => {
-    if (options.isTypescript !== undefined) {
-        return options.isTypescript;
-    }
-
-    return options.isInteractive ? shouldUseTypeScript() : true;
-};
-
-const isTestingIncluded = async (options: CreateOptions): Promise<boolean> => {
-    if (options.shouldIncludeTesting !== undefined) {
-        return options.shouldIncludeTesting;
-    }
-
-    return options.isInteractive ? shouldSetUpTesting() : true;
-};
-
 const resolveOptions = async (options: CreateOptions): Promise<ResolvedOptions> => {
     const requested = requestedPackageManager(options.packageManager);
     const target = await resolveTarget(options);
     const name = deriveProjectName(target);
+    const displayName = await resolveDisplayName(options, name);
     const applicationId = await resolveApplicationId(options, name);
     const root = resolve(process.cwd(), target);
     const isCurrentDirectory = root === process.cwd();
-    const shouldEmptyTarget = await shouldEmptyTargetDirectory(root, target, options);
+    const shouldInitialize = shouldInitializeGit(root);
     const packageManager = await resolvePackageManager(requested, options);
-    const isTypescript = await isTypescriptSelected(options);
-    const shouldIncludeTesting = await isTestingIncluded(options);
+    const isTypescript = await isOptionEnabled(options.isTypescript, options.isInteractive, "Use TypeScript?");
+
+    const shouldIncludeTesting = await isOptionEnabled(
+        options.shouldIncludeTesting,
+        options.isInteractive,
+        "Include testing setup (Vitest)?",
+    );
 
     return {
         target,
         root,
         isCurrentDirectory,
         name,
+        displayName,
         applicationId,
         packageManager,
         isTypescript,
         shouldIncludeTesting,
-        shouldEmptyTarget,
+        shouldInitializeGit: shouldInitialize,
+        shouldInstallDependencies: options.shouldInstallDependencies !== false,
     };
 };
 
@@ -472,48 +529,185 @@ const isTemplateIncluded = (templateRelativePath: string, resolved: ResolvedOpti
     return true;
 };
 
-const toScriptExtension = (templateRelativePath: string, isTypescript: boolean): string =>
-    isTypescript ? templateRelativePath : templateRelativePath.replace(/\.tsx$/, ".jsx").replace(/\.ts$/, ".js");
-
-const toIconPath = (path: string, applicationId: string): string =>
-    path.endsWith(ICON_TEMPLATE_NAME) ? `${path.slice(0, -ICON_TEMPLATE_NAME.length)}${applicationId}.svg` : path;
+const destinationPath = (template: string, resolved: ResolvedOptions): string => {
+    const scriptPath = resolved.isTypescript ? template : template.replace(/\.tsx$/, ".jsx").replace(/\.ts$/, ".js");
 
-const toDestinationPath = (templateRelativePath: string, isTypescript: boolean, applicationId: string): string =>
-    toIconPath(toScriptExtension(templateRelativePath, isTypescript), applicationId);
-
-const addTestScript = (root: string): void => {
-    updateManifest(root, (manifest) => {
-        (manifest.scripts as Record<string, string>).test = "vitest run";
-    });
+    return scriptPath.endsWith(ICON_TEMPLATE_NAME)
+        ? `${scriptPath.slice(0, -ICON_TEMPLATE_NAME.length)}${resolved.applicationId}.svg`
+        : scriptPath;
 };
 
 const templateContext = (resolved: ResolvedOptions): TemplateContext => ({
     name: resolved.name,
     applicationId: resolved.applicationId,
-    title: titleFromName(resolved.name),
+    displayName: resolved.displayName,
     shouldIncludeTesting: resolved.shouldIncludeTesting,
     isTypescript: resolved.isTypescript,
     importExtension: resolved.isTypescript ? ".js" : ".jsx",
-    developerName: gitConfigValue("user.name") ?? titleFromName(resolved.name),
+    developerName: gitConfigValue("user.name") ?? resolved.displayName,
     developerEmail: gitConfigValue("user.email"),
 });
 
-const scaffoldProject = async (root: string, resolved: ResolvedOptions): Promise<void> => {
-    const { applicationId, isTypescript, shouldIncludeTesting } = resolved;
+const replaceTemplateDestination = (destination: string): void => {
+    const entry = lstatSync(destination, { throwIfNoEntry: false });
+
+    if (entry === undefined) {
+        return;
+    }
+
+    if (!entry.isFile() && !entry.isSymbolicLink()) {
+        fail(`Cannot replace scaffold file because its destination is not a file: ${destination}`);
+    }
+
+    rmSync(destination, { force: true });
+};
+
+const projectRelativeDestination = (root: string, destination: string): string => {
+    const relativePath = relative(root, destination);
+    const isOutsideProject = relativePath.length === 0 || relativePath.startsWith(`..${sep}`) ||
+        isAbsolute(relativePath);
+
+    if (isOutsideProject) {
+        fail(`Scaffold destination is outside the project: ${destination}`);
+    }
+
+    return relativePath;
+};
+
+const assertRootIsNotSymbolicLink = (root: string): void => {
+    const rootEntry = lstatSync(root, { throwIfNoEntry: false });
+
+    if (rootEntry?.isSymbolicLink()) {
+        fail(`Cannot scaffold through a symbolic link: ${root}`);
+    }
+};
+
+const assertSafeAncestor = (ancestor: string): void => {
+    const entry = lstatSync(ancestor, { throwIfNoEntry: false });
+
+    if (entry?.isSymbolicLink()) {
+        fail(`Cannot scaffold through a symbolic link: ${ancestor}`);
+    }
+
+    if (entry !== undefined && !entry.isDirectory()) {
+        fail(`Cannot scaffold through a non-directory path: ${ancestor}`);
+    }
+};
+
+const assertSafeAncestors = (root: string, relativePath: string): void => {
+    let ancestor = root;
+    const segments = relativePath.split(sep);
+    const ancestorSegments = segments.slice(0, -1);
+
+    for (const segment of ancestorSegments) {
+        ancestor = join(ancestor, segment);
+        assertSafeAncestor(ancestor);
+    }
+};
+
+const assertReplaceableDestination = (destination: string): void => {
+    const entry = lstatSync(destination, { throwIfNoEntry: false });
+    const isReplaceable = entry === undefined || entry.isFile() || entry.isSymbolicLink();
+
+    if (!isReplaceable) {
+        fail(`Cannot replace scaffold file because its destination is not a file: ${destination}`);
+    }
+};
+
+const assertSafeDestination = (root: string, destination: string): void => {
+    const relativePath = projectRelativeDestination(root, destination);
+    assertRootIsNotSymbolicLink(root);
+    assertSafeAncestors(root, relativePath);
+    assertReplaceableDestination(destination);
+};
+
+const plannedScaffoldFiles = async (root: string, resolved: ResolvedOptions): Promise<ScaffoldFile[]> => {
     const context = templateContext(resolved);
+    const files: ScaffoldFile[] = [];
 
     for (const template of listTemplates()) {
-        if (!isTemplateIncluded(template, resolved)) {
-            continue;
+        if (isTemplateIncluded(template, resolved)) {
+            files.push({
+                destination: join(root, destinationPath(template, resolved)),
+                contents: await renderFile(template, context),
+            });
         }
+    }
+
+    return files;
+};
+
+const auxiliaryDestinations = (root: string, resolved: ResolvedOptions): string[] =>
+    resolved.packageManager === "pnpm" ? [join(root, "pnpm-workspace.yaml")] : [];
 
-        const destination = join(root, toDestinationPath(template, isTypescript, applicationId));
-        mkdirSync(dirname(destination), { recursive: true });
-        writeFileSync(destination, await renderFile(template, context));
+const envModulePath = (root: string): string => join(root, "node_modules", ".gtkx", "env.d.ts");
+
+const shouldWriteEnvModule = (resolved: ResolvedOptions): boolean =>
+    resolved.isTypescript && resolved.shouldInstallDependencies;
+
+const generatedDestinations = (root: string, resolved: ResolvedOptions): string[] =>
+    shouldWriteEnvModule(resolved) ? [envModulePath(root)] : [];
+
+const isPresent = (path: string): boolean => lstatSync(path, { throwIfNoEntry: false }) !== undefined;
+
+const classifyScaffoldChange = (
+    root: string,
+    destination: string,
+): ScaffoldChange | undefined => {
+    const entry = lstatSync(destination, { throwIfNoEntry: false });
+
+    if (entry === undefined) {
+        return undefined;
     }
 
-    if (shouldIncludeTesting) {
-        addTestScript(root);
+    return { destination, relativePath: projectRelativeDestination(root, destination) };
+};
+
+const addScaffoldChange = (plan: ScaffoldPlan, change: ScaffoldChange | undefined): void => {
+    if (change === undefined) {
+        return;
+    }
+
+    plan.replaceDestinations.push(change.destination);
+    plan.changes.push(change.relativePath);
+};
+
+const planScaffoldProject = async (root: string, resolved: ResolvedOptions): Promise<ScaffoldPlan> => {
+    const files = await plannedScaffoldFiles(root, resolved);
+    const reported = [...files.map((file) => file.destination), ...auxiliaryDestinations(root, resolved)];
+    const generated = generatedDestinations(root, resolved);
+
+    for (const destination of [...reported, ...generated]) {
+        assertSafeDestination(root, destination);
+    }
+
+    const plan: ScaffoldPlan = {
+        files,
+        replaceDestinations: generated.filter((destination) => isPresent(destination)),
+        changes: [],
+    };
+
+    for (const destination of reported) {
+        addScaffoldChange(plan, classifyScaffoldChange(root, destination));
+    }
+
+    return plan;
+};
+
+const scaffoldProject = (root: string, resolved: ResolvedOptions, plan: ScaffoldPlan): void => {
+    for (const destination of plan.replaceDestinations) {
+        replaceTemplateDestination(destination);
+    }
+
+    for (const file of plan.files) {
+        mkdirSync(dirname(file.destination), { recursive: true });
+        writeFileSync(file.destination, file.contents);
+    }
+
+    if (resolved.shouldIncludeTesting) {
+        updateManifest(root, (manifest) => {
+            (manifest.scripts as Record<string, string>).test = "vitest run";
+        });
     }
 };
 
@@ -543,10 +737,34 @@ const installDependencies = async (options: InstallDependenciesOptions): Promise
     });
 };
 
-const pin = (names: string[]): string[] => names.map((dependency) => pinGtkxDependency(dependency, selfVersion));
+const pin = (names: string[]): string[] =>
+    names.map((dependency) => {
+        if (dependency.startsWith("@gtkx/")) {
+            return `${dependency}@^${selfVersion}`;
+        }
+
+        return dependency === "typescript" ? `${dependency}@${TYPESCRIPT_VERSION}` : dependency;
+    });
+
+const dependencyVersions = (names: string[]): Record<string, string> => Object.fromEntries(
+    names.map((dependency) => {
+        if (dependency.startsWith("@gtkx/")) {
+            return [dependency, `^${selfVersion}`];
+        }
+
+        return [dependency, dependency === "typescript" ? TYPESCRIPT_VERSION : "latest"];
+    }),
+);
+
+const writeDependencies = (root: string, devDependencies: string[]): void => {
+    updateManifest(root, (manifest) => {
+        manifest.dependencies = dependencyVersions(DEPENDENCIES);
+        manifest.devDependencies = dependencyVersions(devDependencies);
+    });
+};
 
 const formatRecovery = ({ resolved, devDependencies }: InstallFailureOptions): string => {
-    const add = getAddCommand(resolved.packageManager);
+    const add = ADD_COMMAND[resolved.packageManager];
 
     const steps = [
         ...(resolved.isCurrentDirectory ? [] : [`cd ${resolved.target}`]),
@@ -603,12 +821,32 @@ const installAllDependencies = async (options: InstallAllOptions): Promise<void>
 };
 
 const writeInitialEnvModule = (root: string): void => {
-    const storeDir = join(root, "node_modules", ".gtkx");
-    mkdirSync(storeDir, { recursive: true });
-    writeFileSync(join(storeDir, "env.d.ts"), `${GTKX_ENV_MODULE_HEADER}\n`);
+    const path = envModulePath(root);
+    mkdirSync(dirname(path), { recursive: true });
+    writeFileSync(path, `${GTKX_ENV_MODULE_HEADER}\n`);
+};
+
+const isInsideGitRepository = (root: string): boolean => {
+    const git = tryResolveExecutable("git");
+
+    if (git === undefined) {
+        return false;
+    }
+
+    try {
+        execFileSync(git, ["-C", root, "rev-parse", "--show-toplevel"], { stdio: "ignore" });
+
+        return true;
+    } catch {
+        return false;
+    }
 };
 
-const initializeGitRepo = async (root: string): Promise<void> => {
+const initializeGitRepo = async (root: string, shouldInitialize: boolean): Promise<void> => {
+    if (!shouldInitialize || isInsideGitRepository(root)) {
+        return;
+    }
+
     const spinner = p.spinner();
     spinner.start("Initializing git repository...");
 
@@ -624,21 +862,30 @@ const initializeGitRepo = async (root: string): Promise<void> => {
 };
 
 const printNextSteps = (resolved: ResolvedOptions): void => {
-    const devCmd = getDevCommand(resolved.packageManager);
+    const devCmd = DEV_COMMAND[resolved.packageManager];
     const cdStep = resolved.isCurrentDirectory ? "" : `cd ${resolved.target}\n`;
+    const installStep = resolved.shouldInstallDependencies ? "" : `${INSTALL_COMMAND[resolved.packageManager]}\n`;
     const testingNote = resolved.shouldIncludeTesting ? HEADLESS_COMPOSITOR_NOTE : "";
-    p.note(`${cdStep}${devCmd}${testingNote}`, "Next steps");
+    p.note(`${cdStep}${installStep}${devCmd}${testingNote}`, "Next steps");
 };
 
-const createProjectStructure = async (root: string, resolved: ResolvedOptions): Promise<void> => {
+const createProjectStructure = async (
+    root: string,
+    resolved: ResolvedOptions,
+    plan: ScaffoldPlan,
+): Promise<void> => {
     await runWithSpinner({
         pending: "Creating project structure...",
         done: "Project structure created",
         failed: "Failed to create the project structure",
-        run: async () => {
-            prepareTargetDirectory(root, resolved.shouldEmptyTarget);
-            await scaffoldProject(root, resolved);
+        run: () => {
+            mkdirSync(root, { recursive: true });
+            scaffoldProject(root, resolved, plan);
             writeBuildAllowance(root, resolved.packageManager);
+
+            if (shouldWriteEnvModule(resolved)) {
+                writeInitialEnvModule(root);
+            }
         },
     });
 };
@@ -648,14 +895,19 @@ const scaffold = async (options: CreateOptions = {}): Promise<void> => {
     const resolved = await resolveOptions(options);
     const { root } = resolved;
     const devDeps = getDevDependencies(resolved);
-    await createProjectStructure(root, resolved);
-    await installAllDependencies({ resolved, devDependencies: devDeps });
+    assertTargetIsDirectory(root, resolved.target);
+    const plan = await planScaffoldProject(root, resolved);
+    await validateTargetAvailability(root, resolved.target, options, plan.changes);
+    await createProjectStructure(root, resolved, plan);
+    reportCompletedChanges(plan.changes);
 
-    if (resolved.isTypescript) {
-        writeInitialEnvModule(root);
+    if (resolved.shouldInstallDependencies) {
+        await installAllDependencies({ resolved, devDependencies: devDeps });
+    } else {
+        writeDependencies(root, devDeps);
     }
 
-    await initializeGitRepo(root);
+    await initializeGitRepo(root, resolved.shouldInitializeGit);
     printNextSteps(resolved);
 };