@wp-typia/project-tools 0.24.3 → 0.24.5

package/dist/runtime/cli-init.d.ts

@@ -1,17 +1 @@
-import type { RetrofitInitPlan } from "./cli-init-types.js";
-export { applyInitPlan } from "./cli-init-apply.js";
-export { getInitPlan } from "./cli-init-plan.js";
-export type { InitCommandMode, InitDependencyChange, InitFilePlan, InitPackageManagerFieldChange, InitPlanAction, InitPlanLayoutKind, InitPlanStatus, InitScriptChange, RetrofitInitBlockTarget, RetrofitInitPlan, } from "./cli-init-types.js";
-/**
- * Execute `wp-typia init` in preview or apply mode.
- *
- * @param options Resolved command options including the target project
- * directory, optional package-manager override, and whether writes should be
- * applied.
- * @returns The previewed or applied retrofit init plan.
- */
-export declare function runInitCommand(options: {
-    apply?: boolean;
-    packageManager?: string;
-    projectDir: string;
-}): Promise<RetrofitInitPlan>;
+export * from "./cli/cli-init.js";

package/dist/runtime/cli-init.js

@@ -1,21 +1 @@
-import { applyInitPlan as applyInitPlanImpl } from "./cli-init-apply.js";
-import { getInitPlan as getInitPlanImpl } from "./cli-init-plan.js";
-export { applyInitPlan } from "./cli-init-apply.js";
-export { getInitPlan } from "./cli-init-plan.js";
-/**
- * Execute `wp-typia init` in preview or apply mode.
- *
- * @param options Resolved command options including the target project
- * directory, optional package-manager override, and whether writes should be
- * applied.
- * @returns The previewed or applied retrofit init plan.
- */
-export async function runInitCommand(options) {
-    return options.apply
-        ? applyInitPlanImpl(options.projectDir, {
-            packageManager: options.packageManager,
-        })
-        : getInitPlanImpl(options.projectDir, {
-            packageManager: options.packageManager,
-        });
-}
+export * from "./cli/cli-init.js";

package/dist/runtime/cli-prompt.d.ts

@@ -1,60 +1 @@
-type ValidateInput = (value: string) => boolean | string;
-export type PromptLinePrinter = (line: string) => void;
-interface PromptOption<T extends string> {
-    hint?: string;
-    label: string;
-    value: T;
-}
-/**
- * Prompt adapter used by CLI scaffold flows and migration wizard flows.
- */
-export interface ReadlinePrompt {
-    close(): void;
-    select<T extends string>(message: string, options: PromptOption<T>[], defaultValue?: number): Promise<T>;
-    text(message: string, defaultValue: string, validate?: ValidateInput): Promise<string>;
-}
-/**
- * Output adapters used by prompt rendering and validation feedback.
- */
-export interface ReadlinePromptOutput {
-    /** Render one informational prompt line. */
-    printLine?: PromptLinePrinter;
-    /** Render one validation or selection error line. */
-    errorLine?: PromptLinePrinter;
-}
-/**
- * Adapter interface for readline-style prompt interactions.
- *
- * Public CLI code uses the native readline implementation, while tests can
- * substitute lightweight doubles that expose the same `question` and `close`
- * methods.
- */
-export interface ReadlineQuestionAdapter {
-    /** Close the underlying prompt interface and release any open handles. */
-    close(): void;
-    /**
-     * Render one prompt and resolve with the collected answer string.
-     *
-     * @param query Prompt text written to the active output stream.
-     * @param callback Callback that receives the entered answer.
-     */
-    question(query: string, callback: (answer: string) => void): void;
-}
-/**
- * Create the default readline-backed prompt implementation for the CLI.
- *
- * @param output Optional line printers for prompt and validation output.
- * @returns A prompt adapter that reads from stdin and writes to stdout.
- */
-export declare function createReadlinePrompt(output?: ReadlinePromptOutput): ReadlinePrompt;
-/**
- * Build a prompt adapter around a supplied readline-style question interface.
- *
- * This keeps the production CLI path unchanged while letting tests validate
- * retry behavior without stubbing global stdin/stdout.
- *
- * @param rl Readline-compatible question adapter.
- * @param output Optional line printers for prompt and validation output.
- */
-export declare function createReadlinePromptWithInterface(rl: ReadlineQuestionAdapter, output?: ReadlinePromptOutput): ReadlinePrompt;
-export {};
+export * from "./cli/cli-prompt.js";

package/dist/runtime/cli-prompt.js

@@ -1,141 +1 @@
-import readline from "node:readline";
-/**
- * Create the default readline-backed prompt implementation for the CLI.
- *
- * @param output Optional line printers for prompt and validation output.
- * @returns A prompt adapter that reads from stdin and writes to stdout.
- */
-export function createReadlinePrompt(output = {}) {
-    const rl = readline.createInterface({
-        input: process.stdin,
-        output: process.stdout,
-    });
-    return createReadlinePromptWithInterface(rl, output);
-}
-/**
- * Build a prompt adapter around a supplied readline-style question interface.
- *
- * This keeps the production CLI path unchanged while letting tests validate
- * retry behavior without stubbing global stdin/stdout.
- *
- * @param rl Readline-compatible question adapter.
- * @param output Optional line printers for prompt and validation output.
- */
-export function createReadlinePromptWithInterface(rl, output = {}) {
-    const { errorLine, printLine } = resolveReadlinePromptOutput(output);
-    const askQuestion = (query) => new Promise((resolve) => {
-        rl.question(query, resolve);
-    });
-    return {
-        async text(message, defaultValue, validate) {
-            while (true) {
-                const value = normalizePromptAnswer(await askQuestion(formatTextPrompt(message, defaultValue))) || defaultValue;
-                if (validate) {
-                    const result = validate(value);
-                    if (result !== true) {
-                        errorLine(formatValidationError(message, result, defaultValue));
-                        continue;
-                    }
-                }
-                return value;
-            }
-        },
-        async select(message, options, defaultValue = 1) {
-            if (options.length === 0) {
-                throw new Error(`select() requires at least one option for prompt: ${message}`);
-            }
-            const resolvedDefaultIndex = getResolvedDefaultIndex(options, defaultValue);
-            renderSelectPrompt(message, options, resolvedDefaultIndex, printLine);
-            while (true) {
-                const answer = normalizePromptAnswer(await askQuestion(formatChoicePrompt(resolvedDefaultIndex)));
-                if (answer.length === 0) {
-                    return options[resolvedDefaultIndex].value;
-                }
-                const selection = resolvePromptSelection(options, answer);
-                if (selection) {
-                    return selection.value;
-                }
-                if (isPromptHelpToken(answer)) {
-                    renderSelectPrompt(message, options, resolvedDefaultIndex, printLine);
-                    continue;
-                }
-                errorLine(formatInvalidSelectionError(answer, options, resolvedDefaultIndex));
-            }
-        },
-        close() {
-            rl.close();
-        },
-    };
-}
-function resolveReadlinePromptOutput({ errorLine, printLine, }) {
-    return {
-        errorLine: errorLine ?? writePromptErrorLine,
-        printLine: printLine ?? writePromptLine,
-    };
-}
-function writePromptLine(line) {
-    process.stdout.write(`${line}\n`);
-}
-function writePromptErrorLine(line) {
-    process.stderr.write(`${line}\n`);
-}
-function normalizePromptAnswer(value) {
-    return String(value).trim();
-}
-function normalizePromptToken(value) {
-    return value.trim().toLowerCase();
-}
-function getResolvedDefaultIndex(options, defaultValue) {
-    const candidateIndex = Number.isInteger(defaultValue) ? defaultValue - 1 : -1;
-    return options[candidateIndex] ? candidateIndex : 0;
-}
-function formatTextPrompt(message, defaultValue) {
-    const suffix = defaultValue.length > 0 ? ` [default: ${defaultValue}]` : "";
-    return `${message}${suffix}: `;
-}
-function formatValidationError(message, result, defaultValue) {
-    const detail = typeof result === "string" ? result : "Invalid input";
-    const retryHint = defaultValue.length > 0 ? ` Press Enter to keep "${defaultValue}".` : "";
-    return `❌ ${message}: ${detail}.${retryHint}`;
-}
-function formatChoicePrompt(defaultIndex) {
-    return `Choice [default: ${defaultIndex + 1}, ? for options]: `;
-}
-function renderSelectPrompt(message, options, defaultIndex, printLine) {
-    printLine(message);
-    printLine("  Enter a number, option label, or option value. Press Enter to keep the default, or type ? to list choices again.");
-    options.forEach((option, index) => {
-        const defaultMarker = index === defaultIndex ? " (default)" : "";
-        const valueHint = normalizePromptToken(option.label) === normalizePromptToken(option.value)
-            ? ""
-            : ` [${option.value}]`;
-        printLine(`  ${index + 1}. ${option.label}${valueHint}${defaultMarker}`);
-        if (option.hint) {
-            printLine(`     ${option.hint}`);
-        }
-    });
-}
-function isPromptHelpToken(answer) {
-    const normalized = normalizePromptToken(answer);
-    return normalized === "?" || normalized === "help" || normalized === "list";
-}
-function resolvePromptSelection(options, answer) {
-    const numericChoice = Number(answer);
-    if (!Number.isNaN(numericChoice) && options[numericChoice - 1]) {
-        return options[numericChoice - 1];
-    }
-    const normalizedAnswer = normalizePromptToken(answer);
-    return options.find((option) => {
-        const normalizedLabel = normalizePromptToken(option.label);
-        const normalizedValue = normalizePromptToken(option.value);
-        return normalizedAnswer === normalizedLabel || normalizedAnswer === normalizedValue;
-    });
-}
-function formatInvalidSelectionError(answer, options, defaultIndex) {
-    const optionValues = options.map((option) => option.value).join(", ");
-    return [
-        `❌ Invalid selection: ${answer}.`,
-        `Enter 1-${options.length}, one of: ${optionValues},`,
-        `or press Enter for "${options[defaultIndex].label}".`,
-    ].join(" ");
-}
+export * from "./cli/cli-prompt.js";

package/dist/runtime/cli-scaffold-emission.d.ts

@@ -1,124 +1 @@
-import { scaffoldProject } from "./scaffold.js";
-import type { PackageManagerId } from "./package-managers.js";
-import type { ScaffoldProgressEvent } from "./scaffold.js";
-type ScaffoldProjectOptions = Parameters<typeof scaffoldProject>[0];
-/**
- * Dependency installation hook accepted by scaffold emission.
- */
-export type ScaffoldInstallDependencies = ScaffoldProjectOptions["installDependencies"];
-/**
- * Dry-run metadata returned after rendering a scaffold into a preview directory.
- */
-export interface ScaffoldDryRunPlan {
-    /**
-     * Whether dependency installation would run or is skipped by --no-install.
-     */
-    dependencyInstall: "skipped-by-flag" | "would-install";
-    /**
-     * Sorted project-relative paths that would be written by the scaffold.
-     */
-    files: string[];
-}
-/**
- * Normalized scaffold emission options shared by real and dry-run flows.
- */
-export interface ScaffoldEmissionOptions {
-    /**
-     * Whether an existing target directory may be reused.
-     */
-    allowExistingDir: boolean;
-    /**
-     * Optional alternate render target specification for supported templates.
-     */
-    alternateRenderTargets?: ScaffoldProjectOptions["alternateRenderTargets"];
-    /**
-     * Resolved scaffold answers used by template variable generation.
-     */
-    answers: ScaffoldProjectOptions["answers"];
-    /**
-     * Caller working directory used to resolve relative template inputs.
-     */
-    cwd: string;
-    /**
-     * Persistence storage mode for templates that support storage options.
-     */
-    dataStorageMode?: ScaffoldProjectOptions["dataStorageMode"];
-    /**
-     * Optional public root id selected from an external layer package.
-     */
-    externalLayerId?: string;
-    /**
-     * Optional external layer source package, path, or locator.
-     */
-    externalLayerSource?: string;
-    /**
-     * Display label for the external layer source before path resolution.
-     */
-    externalLayerSourceLabel?: string;
-    /**
-     * Optional dependency installer override used by tests and callers.
-     */
-    installDependencies?: ScaffoldProjectOptions["installDependencies"];
-    /**
-     * Whether generated projects should skip dependency installation.
-     */
-    noInstall: boolean;
-    /**
-     * Optional callback for scaffold progress events.
-     */
-    onProgress?: ((event: ScaffoldProgressEvent) => void | Promise<void>) | undefined;
-    /**
-     * Package manager used for generated metadata and follow-up commands.
-     */
-    packageManager: PackageManagerId;
-    /**
-     * Persistence access policy for templates that support server storage.
-     */
-    persistencePolicy?: ScaffoldProjectOptions["persistencePolicy"];
-    /**
-     * Optional create profile that enables preset groups such as plugin QA.
-     */
-    profile?: ScaffoldProjectOptions["profile"];
-    /**
-     * Absolute target directory for the generated project.
-     */
-    projectDir: string;
-    /**
-     * Resolved template id or external template locator to render.
-     */
-    templateId: string;
-    /**
-     * Optional built-in or external template variant id.
-     */
-    variant?: string;
-    /**
-     * Whether migration UI support should be added when supported.
-     */
-    withMigrationUi: boolean;
-    /**
-     * Whether scaffold test presets should be emitted.
-     */
-    withTestPreset: boolean;
-    /**
-     * Whether local wp-env support should be emitted.
-     */
-    withWpEnv: boolean;
-}
-/**
- * Emit scaffold files into the target project directory.
- *
- * @param options Normalized scaffold emission options.
- * @returns The scaffold result produced by the runtime renderer.
- */
-export declare function emitScaffoldProject(options: ScaffoldEmissionOptions): Promise<Awaited<ReturnType<typeof scaffoldProject>>>;
-/**
- * Build a dry-run scaffold plan without mutating the requested target directory.
- *
- * @param options Normalized scaffold emission options.
- * @returns Preview metadata and the scaffold result from the temp render.
- */
-export declare function buildScaffoldDryRunPlan(options: ScaffoldEmissionOptions): Promise<{
-    plan: ScaffoldDryRunPlan;
-    result: Awaited<ReturnType<typeof scaffoldProject>>;
-}>;
-export {};
+export * from "./templates/cli-scaffold-emission.js";

package/dist/runtime/cli-scaffold-emission.js

@@ -1,45 +1 @@
-import path from "node:path";
-import { assertDryRunTargetDirectoryReady, listRelativeProjectFiles, } from "./cli-scaffold-files.js";
-import { scaffoldProject } from "./scaffold.js";
-import { createManagedTempRoot } from "./temp-roots.js";
-/**
- * Emit scaffold files into the target project directory.
- *
- * @param options Normalized scaffold emission options.
- * @returns The scaffold result produced by the runtime renderer.
- */
-export async function emitScaffoldProject(options) {
-    return scaffoldProject(options);
-}
-/**
- * Build a dry-run scaffold plan without mutating the requested target directory.
- *
- * @param options Normalized scaffold emission options.
- * @returns Preview metadata and the scaffold result from the temp render.
- */
-export async function buildScaffoldDryRunPlan(options) {
-    await assertDryRunTargetDirectoryReady(options.projectDir, options.allowExistingDir);
-    const { path: tempRoot, cleanup } = await createManagedTempRoot("wp-typia-scaffold-plan-");
-    const previewProjectDir = path.join(tempRoot, "preview-project");
-    try {
-        const result = await emitScaffoldProject({
-            ...options,
-            allowExistingDir: false,
-            noInstall: true,
-            projectDir: previewProjectDir,
-        });
-        const files = await listRelativeProjectFiles(previewProjectDir);
-        return {
-            plan: {
-                dependencyInstall: options.noInstall
-                    ? "skipped-by-flag"
-                    : "would-install",
-                files,
-            },
-            result,
-        };
-    }
-    finally {
-        await cleanup();
-    }
-}
+export * from "./templates/cli-scaffold-emission.js";

package/dist/runtime/cli-scaffold-files.d.ts

@@ -1,22 +1 @@
-/**
- * List every file emitted under a scaffold project using POSIX-style paths.
- *
- * @param rootDir Root project directory to scan recursively.
- * @returns Sorted relative file paths suitable for dry-run preview output.
- */
-export declare function listRelativeProjectFiles(rootDir: string): Promise<string[]>;
-/**
- * Ensure a dry-run target would be legal before rendering into a temp preview.
- *
- * @param projectDir Real target project directory requested by the user.
- * @param allowExistingDir Whether existing target directories are allowed.
- * @throws Error when the target exists, is non-empty, and is not allowed.
- */
-export declare function assertDryRunTargetDirectoryReady(projectDir: string, allowExistingDir: boolean): Promise<void>;
-/**
- * Read script names from the package manifest emitted by a scaffold run.
- *
- * @param projectDir Generated project directory containing package.json.
- * @returns Script names, or undefined when the manifest is absent or invalid.
- */
-export declare function readGeneratedPackageScripts(projectDir: string): Promise<string[] | undefined>;
+export * from "./templates/cli-scaffold-files.js";

package/dist/runtime/cli-scaffold-files.js

@@ -1,69 +1 @@
-import { promises as fsp } from "node:fs";
-import path from "node:path";
-import { formatNonEmptyTargetDirectoryError } from "./scaffold-bootstrap.js";
-import { pathExists } from "./fs-async.js";
-import { readJsonFile } from "./json-utils.js";
-/**
- * List every file emitted under a scaffold project using POSIX-style paths.
- *
- * @param rootDir Root project directory to scan recursively.
- * @returns Sorted relative file paths suitable for dry-run preview output.
- */
-export async function listRelativeProjectFiles(rootDir) {
-    const relativeFiles = [];
-    async function visit(currentDir) {
-        const entries = await fsp.readdir(currentDir, { withFileTypes: true });
-        for (const entry of entries) {
-            const absolutePath = path.join(currentDir, entry.name);
-            if (entry.isDirectory()) {
-                await visit(absolutePath);
-                continue;
-            }
-            relativeFiles.push(path
-                .relative(rootDir, absolutePath)
-                .replace(path.sep === "\\" ? /\\/gu : /\//gu, "/"));
-        }
-    }
-    await visit(rootDir);
-    return relativeFiles.sort((left, right) => left.localeCompare(right));
-}
-/**
- * Ensure a dry-run target would be legal before rendering into a temp preview.
- *
- * @param projectDir Real target project directory requested by the user.
- * @param allowExistingDir Whether existing target directories are allowed.
- * @throws Error when the target exists, is non-empty, and is not allowed.
- */
-export async function assertDryRunTargetDirectoryReady(projectDir, allowExistingDir) {
-    if (!(await pathExists(projectDir)) || allowExistingDir) {
-        return;
-    }
-    const entries = await fsp.readdir(projectDir);
-    if (entries.length > 0) {
-        throw new Error(formatNonEmptyTargetDirectoryError(projectDir));
-    }
-}
-/**
- * Read script names from the package manifest emitted by a scaffold run.
- *
- * @param projectDir Generated project directory containing package.json.
- * @returns Script names, or undefined when the manifest is absent or invalid.
- */
-export async function readGeneratedPackageScripts(projectDir) {
-    try {
-        const parsedPackageJson = await readJsonFile(path.join(projectDir, "package.json"), {
-            context: "generated package manifest",
-        });
-        const scripts = parsedPackageJson.scripts &&
-            typeof parsedPackageJson.scripts === "object" &&
-            !Array.isArray(parsedPackageJson.scripts)
-            ? parsedPackageJson.scripts
-            : {};
-        return Object.entries(scripts)
-            .filter(([, value]) => typeof value === "string")
-            .map(([scriptName]) => scriptName);
-    }
-    catch {
-        return undefined;
-    }
-}
+export * from "./templates/cli-scaffold-files.js";

package/dist/runtime/cli-scaffold-output.d.ts

@@ -1,79 +1 @@
-import type { PackageManagerId } from "./package-managers.js";
-/**
- * Inputs used to build CLI next-step commands after scaffolding succeeds.
- */
-export interface ScaffoldNextStepsOptions {
-    /**
-     * Whether install instructions should be printed because install was skipped.
-     */
-    noInstall: boolean;
-    /**
-     * Package manager used to format install and run commands.
-     */
-    packageManager: PackageManagerId;
-    /**
-     * Absolute scaffold target directory.
-     */
-    projectDir: string;
-    /**
-     * Project path exactly as provided to the CLI.
-     */
-    projectInput: string;
-    /**
-     * Resolved template id used to choose the primary development script.
-     */
-    templateId: string;
-}
-/**
- * Inputs used to compute optional onboarding guidance after scaffolding.
- */
-export interface ScaffoldOptionalOnboardingOptions {
-    /**
-     * Script names discovered from the generated package manifest.
-     */
-    availableScripts?: string[];
-    /**
-     * Package manager used to format optional commands.
-     */
-    packageManager: PackageManagerId;
-    /**
-     * Resolved template id used to select template-specific guidance.
-     */
-    templateId: string;
-    /**
-     * Whether compound persistence support is present in generated variables.
-     */
-    compoundPersistenceEnabled?: boolean;
-}
-/**
- * User-facing optional onboarding copy and command list.
- */
-export interface OptionalOnboardingGuidance {
-    /**
-     * Full note shown in the detailed completion output.
-     */
-    note: string;
-    /**
-     * Short note shown in compact completion output.
-     */
-    shortNote: string;
-    /**
-     * Optional follow-up commands to show after next steps.
-     */
-    steps: string[];
-}
-/**
- * Build the printed next-step commands for a scaffolded project.
- *
- * @param options Project location and package-manager details used to format
- * next-step commands.
- * @returns Ordered shell commands shown after scaffolding succeeds.
- */
-export declare function getNextSteps({ projectInput, projectDir, packageManager, noInstall, templateId, }: ScaffoldNextStepsOptions): string[];
-/**
- * Compute optional onboarding guidance shown after scaffolding completes.
- *
- * @param options Package-manager and template context for optional guidance.
- * @returns Optional onboarding note and step list.
- */
-export declare function getOptionalOnboarding({ availableScripts, packageManager, templateId, compoundPersistenceEnabled, }: ScaffoldOptionalOnboardingOptions): OptionalOnboardingGuidance;
+export * from "./templates/cli-scaffold-output.js";

package/dist/runtime/cli-scaffold-output.js

@@ -1,49 +1 @@
-import path from "node:path";
-import { formatInstallCommand, formatRunScript, } from "./package-managers.js";
-import { getOptionalOnboardingNote, getOptionalOnboardingShortNote, getOptionalOnboardingSteps, } from "./scaffold-onboarding.js";
-import { getPrimaryDevelopmentScript } from "./local-dev-presets.js";
-function quoteShellValue(value) {
-    if (!value.startsWith("-") &&
-        /^[A-Za-z0-9._/@:-]+(?:\/[A-Za-z0-9._@:-]+)*$/.test(value)) {
-        return value;
-    }
-    return `'${value.replace(/'/g, `'"'"'`)}'`;
-}
-/**
- * Build the printed next-step commands for a scaffolded project.
- *
- * @param options Project location and package-manager details used to format
- * next-step commands.
- * @returns Ordered shell commands shown after scaffolding succeeds.
- */
-export function getNextSteps({ projectInput, projectDir, packageManager, noInstall, templateId, }) {
-    const cdTarget = path.isAbsolute(projectInput) ? projectDir : projectInput;
-    const steps = [`cd ${quoteShellValue(cdTarget)}`];
-    if (noInstall) {
-        steps.push(formatInstallCommand(packageManager));
-    }
-    steps.push(formatRunScript(packageManager, getPrimaryDevelopmentScript(templateId)));
-    return steps;
-}
-/**
- * Compute optional onboarding guidance shown after scaffolding completes.
- *
- * @param options Package-manager and template context for optional guidance.
- * @returns Optional onboarding note and step list.
- */
-export function getOptionalOnboarding({ availableScripts, packageManager, templateId, compoundPersistenceEnabled = false, }) {
-    return {
-        note: getOptionalOnboardingNote(packageManager, templateId, {
-            availableScripts,
-            compoundPersistenceEnabled,
-        }),
-        shortNote: getOptionalOnboardingShortNote(packageManager, templateId, {
-            availableScripts,
-            compoundPersistenceEnabled,
-        }),
-        steps: getOptionalOnboardingSteps(packageManager, templateId, {
-            availableScripts,
-            compoundPersistenceEnabled,
-        }),
-    };
-}
+export * from "./templates/cli-scaffold-output.js";