create-gtkx 2.0.0-beta.1 → 2.0.0-beta.3

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, 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,13 +37,17 @@ 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 InstallDependenciesOptions = {
     cwd: string;
     packageManager: PackageManager;
@@ -88,6 +94,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,7 +116,8 @@ const APPLICATION_ID_SUFFIX = ".app";
 const APPLICATION_ID_SEGMENT_LIMIT = APPLICATION_ID_MAX_LENGTH - APPLICATION_ID_PREFIX.length -
     APPLICATION_ID_SUFFIX.length;
 
-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");
@@ -153,6 +164,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,
@@ -200,6 +217,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);
@@ -252,6 +280,19 @@ const promptApplicationId = async (name: string): Promise<string> => {
     );
 };
 
+const promptDisplayName = async (name: string): Promise<string> => {
+    const defaultDisplayName = displayNameFromProjectName(name);
+
+    return guardCancellation(
+        await p.text({
+            message: "Display name",
+            placeholder: defaultDisplayName,
+            defaultValue: defaultDisplayName,
+            validate: validateDisplayNameAnswer,
+        }),
+    );
+};
+
 const packageManagerOption = (manager: (typeof PACKAGE_MANAGERS)[number], detected: PackageManager | undefined) => {
     let hint: string | undefined;
 
@@ -297,16 +338,6 @@ const isOptionEnabled = async (
         ? guardCancellation(await p.confirm({ message, initialValue: true }))
         : true);
 
-const emptyDir = (root: string): void => {
-    for (const entry of readdirSync(root)) {
-        if (entry === ".git") {
-            continue;
-        }
-
-        rmSync(join(root, entry), { recursive: true, force: true });
-    }
-};
-
 const shouldOverwriteDirectory = async (target: string, options: CreateOptions): Promise<boolean> => {
     if (!options.isInteractive) {
         return options.shouldOverwrite === true;
@@ -314,17 +345,17 @@ const shouldOverwriteDirectory = async (target: string, options: CreateOptions):
 
     return guardCancellation(
         await p.confirm({
-            message: `Directory "${target}" is not empty. Overwrite its contents?`,
+            message: `Directory "${target}" is not empty. Replace scaffold files?`,
             initialValue: false,
         }),
     );
 };
 
-const shouldEmptyTargetDirectory = async (root: string, target: string, options: CreateOptions): Promise<boolean> => {
+const validateTargetAvailability = async (root: string, target: string, options: CreateOptions): Promise<void> => {
     const stats = statSync(root, { throwIfNoEntry: false });
 
     if (stats === undefined) {
-        return false;
+        return;
     }
 
     if (!stats.isDirectory()) {
@@ -332,14 +363,14 @@ const shouldEmptyTargetDirectory = async (root: string, target: string, options:
     }
 
     if (isDirEmpty(root)) {
-        return false;
+        return;
     }
 
     if (await shouldOverwriteDirectory(target, options)) {
-        return true;
+        return;
     }
 
-    return fail(`Directory "${target}" is not empty`);
+    fail(`Directory "${target}" is not empty`);
 };
 
 const resolveTarget = async (options: CreateOptions): Promise<string> => {
@@ -362,6 +393,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,
@@ -381,10 +420,12 @@ 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);
+    await validateTargetAvailability(root, target, options);
     const packageManager = await resolvePackageManager(requested, options);
     const isTypescript = await isOptionEnabled(options.isTypescript, options.isInteractive, "Use TypeScript?");
 
@@ -399,11 +440,13 @@ const resolveOptions = async (options: CreateOptions): Promise<ResolvedOptions>
         root,
         isCurrentDirectory,
         name,
+        displayName,
         applicationId,
         packageManager,
         isTypescript,
         shouldIncludeTesting,
-        shouldEmptyTarget,
+        shouldInitializeGit: shouldInitialize,
+        shouldInstallDependencies: options.shouldInstallDependencies !== false,
     };
 };
 
@@ -430,25 +473,123 @@ const destinationPath = (template: string, resolved: ResolvedOptions): string =>
 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 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")] : []),
+    ...(resolved.isTypescript ? [join(root, "node_modules", ".gtkx", "env.d.ts")] : []),
+];
+
+const scaffoldProject = async (root: string, resolved: ResolvedOptions): Promise<void> => {
+    const files = await plannedScaffoldFiles(root, resolved);
+    const destinations = [...files.map((file) => file.destination), ...auxiliaryDestinations(root, resolved)];
+
+    for (const destination of destinations) {
+        assertSafeDestination(root, destination);
+    }
 
-        const destination = join(root, destinationPath(template, resolved));
-        mkdirSync(dirname(destination), { recursive: true });
-        writeFileSync(destination, await renderFile(template, context));
+    for (const destination of destinations) {
+        replaceTemplateDestination(destination);
+    }
+
+    for (const file of files) {
+        mkdirSync(dirname(file.destination), { recursive: true });
+        writeFileSync(file.destination, file.contents);
     }
 
     if (resolved.shouldIncludeTesting) {
@@ -487,6 +628,17 @@ const installDependencies = async (options: InstallDependenciesOptions): Promise
 const pin = (names: string[]): string[] =>
     names.map((dependency) => dependency.startsWith("@gtkx/") ? `${dependency}@^${selfVersion}` : dependency);
 
+const dependencyVersions = (names: string[]): Record<string, string> => Object.fromEntries(
+    names.map((dependency) => [dependency, dependency.startsWith("@gtkx/") ? `^${selfVersion}` : "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 = ADD_COMMAND[resolved.packageManager];
 
@@ -550,7 +702,27 @@ const writeInitialEnvModule = (root: string): void => {
     writeFileSync(join(storeDir, "env.d.ts"), `${GTKX_ENV_MODULE_HEADER}\n`);
 };
 
-const initializeGitRepo = async (root: string): Promise<void> => {
+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, shouldInitialize: boolean): Promise<void> => {
+    if (!shouldInitialize || isInsideGitRepository(root)) {
+        return;
+    }
+
     const spinner = p.spinner();
     spinner.start("Initializing git repository...");
 
@@ -568,8 +740,9 @@ const initializeGitRepo = async (root: string): Promise<void> => {
 const printNextSteps = (resolved: ResolvedOptions): void => {
     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> => {
@@ -579,13 +752,12 @@ const createProjectStructure = async (root: string, resolved: ResolvedOptions):
         failed: "Failed to create the project structure",
         run: async () => {
             mkdirSync(root, { recursive: true });
-
-            if (resolved.shouldEmptyTarget) {
-                emptyDir(root);
-            }
-
             await scaffoldProject(root, resolved);
             writeBuildAllowance(root, resolved.packageManager);
+
+            if (resolved.isTypescript) {
+                writeInitialEnvModule(root);
+            }
         },
     });
 };
@@ -596,13 +768,14 @@ const scaffold = async (options: CreateOptions = {}): Promise<void> => {
     const { root } = resolved;
     const devDeps = getDevDependencies(resolved);
     await createProjectStructure(root, resolved);
-    await installAllDependencies({ resolved, devDependencies: devDeps });
 
-    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);
 };
 

package/src/templates/gtkx.config.ts.ejs

@@ -4,11 +4,10 @@ export default defineConfig({
     applicationId: "<%= applicationId %>",
     applicationIcon: "data/icons",
     deploy: {
-        name: "<%= title %>",
+        name: <%- sourceStringLiteral(displayName) %>,
         summary: "A GTK4 application built with GTKX",
         description: [
-            "<%= title %> is a GTK4 and Adwaita application built with GTKX, which renders native GObject "
-            + "widgets from React. Replace this paragraph with a description of what your application does.",
+            <%- sourceStringLiteral(`${displayName} is a GTK4 and Adwaita application built with GTKX, which renders native GObject widgets from React. Replace this paragraph with a description of what your application does.`) %>,
         ],
         categories: ["Utility"],
     },

package/src/templates/mise.toml.ejs

@@ -0,0 +1,2 @@
+[tools]
+node = "26.7.0"

package/src/templates/src/app.tsx.ejs

@@ -8,7 +8,7 @@ const MainWindow = () => {
 
     return (
         <GtkApplicationWindow
-            title="<%= title %>"
+            title={<%- sourceStringLiteral(displayName) %>}
             defaultWidth={400}
             defaultHeight={300}
             onCloseRequest={quit}

package/src/templates.ts

@@ -6,7 +6,7 @@ import { join } from "node:path";
 type TemplateContext = {
     name: string;
     applicationId: string;
-    title: string;
+    displayName: string;
     shouldIncludeTesting: boolean;
     isTypescript: boolean;
     importExtension: string;