@wp-typia/project-tools 0.16.12 → 0.16.13

package/dist/runtime/migration-maintenance.js

@@ -1,380 +1,2 @@
-import fs from 'node:fs';
-import path from 'node:path';
-import { execFileSync } from 'node:child_process';
-import { ROOT_PHP_MIGRATION_REGISTRY, } from './migration-constants.js';
-import { createMigrationDiff } from './migration-diff.js';
-import { createEdgeFixtureDocument, ensureEdgeFixtureFile, } from './migration-fixtures.js';
-import { collectGeneratedMigrationEntries, } from './migration-generated-artifacts.js';
-import { collectFixtureTargets, formatScaffoldCommand, getSelectedEntriesByBlock, hasSnapshotForVersion, isLegacySingleBlockProject, isSnapshotOptionalForBlockVersion, resolveLegacyVersions, } from './migration-planning.js';
-import { assertRuleHasNoTodos, getFixtureFilePath, getGeneratedDirForBlock, getRuleFilePath, getSnapshotBlockJsonPath, getSnapshotManifestPath, getSnapshotRoot, getSnapshotSavePath, loadMigrationProject, readRuleMetadata, } from './migration-project.js';
-import { renderFuzzFile, renderGeneratedDeprecatedFile, renderGeneratedMigrationIndexFile, renderMigrationRegistryFile, renderPhpMigrationRegistryFile, renderVerifyFile, } from './migration-render.js';
-import { createMigrationRiskSummary, formatMigrationRiskSummary, } from './migration-risk.js';
-import { getLocalTsxBinary, isInteractiveTerminal, readJson, resolveTargetMigrationVersion, } from './migration-utils.js';
-import { readWorkspaceInventory } from './workspace-inventory.js';
-import { getInvalidWorkspaceProjectReason, tryResolveWorkspaceProject, } from './workspace-project.js';
-/**
- * Run deterministic migration verification against generated fixtures.
- *
- * @param projectDir Absolute or relative project directory containing the migration workspace.
- * @param options Verification scope and console rendering options.
- * @returns Verified legacy versions.
- */
-export function verifyProjectMigrations(projectDir, { all = false, fromMigrationVersion, renderLine = console.log, } = {}) {
-    const state = loadMigrationProject(projectDir);
-    const targetVersions = resolveLegacyVersions(state, { all, fromMigrationVersion });
-    const blockEntries = getSelectedEntriesByBlock(state, targetVersions, 'verify');
-    const legacySingleBlock = isLegacySingleBlockProject(state);
-    if (targetVersions.length === 0) {
-        renderLine('No legacy migration versions configured for verification.');
-        return { verifiedVersions: [] };
-    }
-    const tsxBinary = getLocalTsxBinary(projectDir);
-    for (const [blockKey, entries] of Object.entries(blockEntries)) {
-        const block = state.blocks.find((entry) => entry.key === blockKey);
-        if (!block || entries.length === 0) {
-            continue;
-        }
-        for (const entry of entries) {
-            assertRuleHasNoTodos(projectDir, block, entry.fromVersion, state.config.currentMigrationVersion);
-        }
-        const verifyScriptPath = path.join(getGeneratedDirForBlock(state.paths, block), 'verify.ts');
-        if (!fs.existsSync(verifyScriptPath)) {
-            const selectedVersionsForBlock = entries.map((entry) => entry.fromVersion);
-            throw new Error(`Generated verify script is missing for ${block.blockName} (${selectedVersionsForBlock.join(', ')}). ` +
-                `Run \`${formatScaffoldCommand(selectedVersionsForBlock)}\` first, then \`wp-typia migrate doctor --all\` if the workspace should already be scaffolded.`);
-        }
-        const selectedVersionsForBlock = entries.map((entry) => entry.fromVersion);
-        const filteredArgs = all
-            ? ['--all']
-            : ['--from-migration-version', selectedVersionsForBlock[0]];
-        execFileSync(tsxBinary, [verifyScriptPath, ...filteredArgs], {
-            cwd: projectDir,
-            shell: process.platform === 'win32',
-            stdio: 'inherit',
-        });
-        renderLine(legacySingleBlock
-            ? `Verified migrations for ${selectedVersionsForBlock.join(', ')}`
-            : `Verified ${block.blockName} migrations for ${selectedVersionsForBlock.join(', ')}`);
-    }
-    return { verifiedVersions: targetVersions };
-}
-function recordWorkspaceMigrationTargetAlignment(projectDir, state, recordCheck) {
-    let invalidWorkspaceReason = null;
-    let workspace;
-    try {
-        invalidWorkspaceReason = getInvalidWorkspaceProjectReason(projectDir);
-        workspace = tryResolveWorkspaceProject(projectDir);
-    }
-    catch (error) {
-        recordCheck('fail', 'Workspace migration targets', error instanceof Error ? error.message : String(error));
-        return;
-    }
-    if (!workspace) {
-        if (invalidWorkspaceReason) {
-            recordCheck('fail', 'Workspace migration targets', invalidWorkspaceReason);
-        }
-        return;
-    }
-    try {
-        const inventory = readWorkspaceInventory(workspace.projectDir);
-        const expectedTargets = inventory.blocks.map((block) => `${workspace.workspace.namespace}/${block.slug}`);
-        const configuredTargets = state.blocks.map((block) => block.blockName);
-        const expectedTargetSet = new Set(expectedTargets);
-        const configuredTargetSet = new Set(configuredTargets);
-        const missingTargets = expectedTargets.filter((target) => !configuredTargetSet.has(target));
-        const staleTargets = configuredTargets.filter((target) => !expectedTargetSet.has(target));
-        recordCheck(missingTargets.length === 0 && staleTargets.length === 0 ? 'pass' : 'fail', 'Workspace migration targets', missingTargets.length === 0 && staleTargets.length === 0
-            ? `${expectedTargets.length} workspace block target(s) align with migration config`
-            : [
-                missingTargets.length > 0
-                    ? `Missing from migration config: ${missingTargets.join(', ')}`
-                    : null,
-                staleTargets.length > 0
-                    ? `Not present in scripts/block-config.ts: ${staleTargets.join(', ')}`
-                    : null,
-            ]
-                .filter((detail) => typeof detail === 'string')
-                .join('; '));
-    }
-    catch (error) {
-        recordCheck('fail', 'Workspace migration targets', error instanceof Error ? error.message : String(error));
-    }
-}
-/**
- * Validate the migration workspace without mutating files.
- *
- * @param projectDir Absolute or relative project directory containing the migration workspace.
- * @param options Doctor scope and console rendering options.
- * @returns Structured doctor check results for the selected legacy versions.
- */
-export function doctorProjectMigrations(projectDir, { all = false, fromMigrationVersion, renderLine = console.log, } = {}) {
-    const checks = [];
-    const recordCheck = (status, label, detail) => {
-        checks.push({ detail, label, status });
-        renderLine(`${status === 'pass' ? 'PASS' : 'FAIL'} ${label}: ${detail}`);
-    };
-    let state;
-    try {
-        state = loadMigrationProject(projectDir);
-        const legacySingleBlock = isLegacySingleBlockProject(state);
-        recordCheck('pass', 'Migration config', legacySingleBlock
-            ? `Loaded ${state.blocks[0]?.blockName} @ ${state.config.currentMigrationVersion}`
-            : `Loaded ${state.blocks.length} block target(s) @ ${state.config.currentMigrationVersion}`);
-    }
-    catch (error) {
-        recordCheck('fail', 'Migration config', error instanceof Error ? error.message : String(error));
-        throw new Error('Migration doctor failed.');
-    }
-    const targetVersions = resolveLegacyVersions(state, { all, fromMigrationVersion });
-    const legacySingleBlock = isLegacySingleBlockProject(state);
-    const snapshotVersions = new Set(targetVersions.length > 0
-        ? [state.config.currentMigrationVersion, ...targetVersions]
-        : state.config.supportedMigrationVersions);
-    recordWorkspaceMigrationTargetAlignment(projectDir, state, recordCheck);
-    for (const version of snapshotVersions) {
-        for (const block of state.blocks) {
-            const snapshotRoot = getSnapshotRoot(projectDir, block, version);
-            const blockJsonPath = getSnapshotBlockJsonPath(projectDir, block, version);
-            const manifestPath = getSnapshotManifestPath(projectDir, block, version);
-            const savePath = getSnapshotSavePath(projectDir, block, version);
-            const hasSnapshot = fs.existsSync(snapshotRoot);
-            const snapshotIsOptional = !hasSnapshot && isSnapshotOptionalForBlockVersion(state, block, version);
-            recordCheck(hasSnapshot || snapshotIsOptional ? 'pass' : 'fail', legacySingleBlock ? `Snapshot ${version}` : `Snapshot ${block.blockName} @ ${version}`, hasSnapshot
-                ? path.relative(projectDir, snapshotRoot)
-                : 'Not present for this version');
-            if (!hasSnapshot) {
-                continue;
-            }
-            for (const targetPath of [blockJsonPath, manifestPath, savePath]) {
-                recordCheck(fs.existsSync(targetPath) ? 'pass' : 'fail', legacySingleBlock
-                    ? `Snapshot file ${version}`
-                    : `Snapshot file ${block.blockName} @ ${version}`, fs.existsSync(targetPath)
-                    ? path.relative(projectDir, targetPath)
-                    : `Missing ${path.relative(projectDir, targetPath)}`);
-            }
-        }
-    }
-    try {
-        const generatedEntries = collectGeneratedMigrationEntries(state);
-        const expectedGeneratedFiles = new Map();
-        for (const block of state.blocks) {
-            const blockGeneratedEntries = generatedEntries.filter(({ entry }) => entry.block.key === block.key);
-            const entries = blockGeneratedEntries.map(({ entry }) => entry);
-            const generatedDir = getGeneratedDirForBlock(state.paths, block);
-            expectedGeneratedFiles.set(path.join(generatedDir, 'registry.ts'), renderMigrationRegistryFile(state, block.key, blockGeneratedEntries));
-            expectedGeneratedFiles.set(path.join(generatedDir, 'deprecated.ts'), renderGeneratedDeprecatedFile(state, block.key, entries));
-            expectedGeneratedFiles.set(path.join(generatedDir, 'verify.ts'), renderVerifyFile(state, block.key, entries));
-            expectedGeneratedFiles.set(path.join(generatedDir, 'fuzz.ts'), renderFuzzFile(state, block.key, blockGeneratedEntries));
-        }
-        expectedGeneratedFiles.set(path.join(state.paths.generatedDir, 'index.ts'), renderGeneratedMigrationIndexFile(state, generatedEntries.map(({ entry }) => entry)));
-        expectedGeneratedFiles.set(path.join(projectDir, ROOT_PHP_MIGRATION_REGISTRY), renderPhpMigrationRegistryFile(state, generatedEntries.map(({ entry }) => entry)));
-        for (const [filePath, expectedSource] of expectedGeneratedFiles) {
-            const inSync = fs.existsSync(filePath) && fs.readFileSync(filePath, 'utf8') === expectedSource;
-            recordCheck(inSync ? 'pass' : 'fail', `Generated ${path.relative(projectDir, filePath)}`, inSync
-                ? 'In sync'
-                : 'Run `wp-typia migrate scaffold --from-migration-version <label>` or regenerate artifacts');
-        }
-    }
-    catch (error) {
-        recordCheck('fail', 'Generated artifacts', error instanceof Error ? error.message : String(error));
-    }
-    for (const version of targetVersions) {
-        for (const block of state.blocks) {
-            if (!hasSnapshotForVersion(state, block, version)) {
-                recordCheck('pass', `Snapshot coverage ${block.blockName} @ ${version}`, 'Target not present for this version');
-                continue;
-            }
-            const rulePath = getRuleFilePath(state.paths, block, version, state.config.currentMigrationVersion);
-            const fixturePath = getFixtureFilePath(state.paths, block, version, state.config.currentMigrationVersion);
-            recordCheck(fs.existsSync(rulePath) ? 'pass' : 'fail', legacySingleBlock ? `Rule ${version}` : `Rule ${block.blockName} @ ${version}`, fs.existsSync(rulePath)
-                ? path.relative(projectDir, rulePath)
-                : `Missing ${path.relative(projectDir, rulePath)}`);
-            recordCheck(fs.existsSync(fixturePath) ? 'pass' : 'fail', legacySingleBlock ? `Fixture ${version}` : `Fixture ${block.blockName} @ ${version}`, fs.existsSync(fixturePath)
-                ? path.relative(projectDir, fixturePath)
-                : `Missing ${path.relative(projectDir, fixturePath)}`);
-            if (!fs.existsSync(rulePath) || !fs.existsSync(fixturePath)) {
-                continue;
-            }
-            try {
-                assertRuleHasNoTodos(projectDir, block, version, state.config.currentMigrationVersion);
-                recordCheck('pass', legacySingleBlock
-                    ? `Rule TODOs ${version}`
-                    : `Rule TODOs ${block.blockName} @ ${version}`, 'No TODO MIGRATION markers remain');
-            }
-            catch (error) {
-                recordCheck('fail', legacySingleBlock
-                    ? `Rule TODOs ${version}`
-                    : `Rule TODOs ${block.blockName} @ ${version}`, error instanceof Error ? error.message : String(error));
-            }
-            try {
-                const ruleMetadata = readRuleMetadata(rulePath);
-                recordCheck(ruleMetadata.unresolved.length === 0 ? 'pass' : 'fail', legacySingleBlock
-                    ? `Rule unresolved ${version}`
-                    : `Rule unresolved ${block.blockName} @ ${version}`, ruleMetadata.unresolved.length === 0
-                    ? 'No unresolved entries remain'
-                    : ruleMetadata.unresolved.join(', '));
-            }
-            catch (error) {
-                recordCheck('fail', legacySingleBlock
-                    ? `Rule unresolved ${version}`
-                    : `Rule unresolved ${block.blockName} @ ${version}`, error instanceof Error ? error.message : String(error));
-            }
-            try {
-                const fixtureDocument = readJson(fixturePath);
-                recordCheck(Array.isArray(fixtureDocument.cases) && fixtureDocument.cases.length > 0
-                    ? 'pass'
-                    : 'fail', legacySingleBlock
-                    ? `Fixture parse ${version}`
-                    : `Fixture parse ${block.blockName} @ ${version}`, Array.isArray(fixtureDocument.cases) && fixtureDocument.cases.length > 0
-                    ? `${fixtureDocument.cases.length} case(s)`
-                    : 'Fixture document has no cases');
-                const diff = createMigrationDiff(state, block, version, state.config.currentMigrationVersion);
-                const expectedFixture = createEdgeFixtureDocument(projectDir, block, version, state.config.currentMigrationVersion, diff);
-                const actualCaseNames = new Set((fixtureDocument.cases ?? []).map((fixtureCase) => fixtureCase.name));
-                const missingCases = expectedFixture.cases
-                    .map((fixtureCase) => fixtureCase.name)
-                    .filter((name) => !actualCaseNames.has(name));
-                recordCheck(missingCases.length === 0 ? 'pass' : 'fail', legacySingleBlock
-                    ? `Fixture coverage ${version}`
-                    : `Fixture coverage ${block.blockName} @ ${version}`, missingCases.length === 0
-                    ? 'All expected fixture cases are present'
-                    : `Missing ${missingCases.join(', ')}`);
-                recordCheck('pass', legacySingleBlock
-                    ? `Risk summary ${version}`
-                    : `Risk summary ${block.blockName} @ ${version}`, formatMigrationRiskSummary(createMigrationRiskSummary(diff)));
-            }
-            catch (error) {
-                recordCheck('fail', legacySingleBlock
-                    ? `Fixture parse ${version}`
-                    : `Fixture parse ${block.blockName} @ ${version}`, error instanceof Error ? error.message : String(error));
-            }
-        }
-    }
-    const failedChecks = checks.filter((check) => check.status === 'fail');
-    renderLine(`${failedChecks.length === 0 ? 'PASS' : 'FAIL'} Migration doctor summary: ${checks.length - failedChecks.length}/${checks.length} checks passed`);
-    if (failedChecks.length > 0) {
-        throw new Error('Migration doctor failed.');
-    }
-    return {
-        checkedVersions: targetVersions,
-        checks,
-    };
-}
-/**
- * Generate or refresh migration fixtures for one or more legacy edges.
- *
- * @param projectDir Absolute or relative project directory containing the migration workspace.
- * @param options Fixture generation scope and refresh options.
- * @returns Generated and skipped legacy versions.
- */
-export function fixturesProjectMigrations(projectDir, { all = false, confirmOverwrite, force = false, fromMigrationVersion, isInteractive = isInteractiveTerminal(), renderLine = console.log, toMigrationVersion = 'current', } = {}) {
-    const state = loadMigrationProject(projectDir);
-    const targetMigrationVersion = resolveTargetMigrationVersion(state.config.currentMigrationVersion, toMigrationVersion);
-    const targetVersions = resolveLegacyVersions(state, { all, fromMigrationVersion });
-    if (targetVersions.length === 0) {
-        renderLine('No legacy migration versions configured for fixture generation.');
-        return { generatedVersions: [], skippedVersions: [] };
-    }
-    const generatedVersions = [];
-    const skippedVersions = [];
-    const fixtureTargets = collectFixtureTargets(state, targetVersions, targetMigrationVersion);
-    if (force) {
-        const overwriteTargets = fixtureTargets.filter(({ fixturePath }) => fs.existsSync(fixturePath));
-        if (isInteractive && overwriteTargets.length > 0) {
-            const confirmed = confirmOverwrite?.(`About to overwrite ${overwriteTargets.length} existing migration fixture file(s). Continue?`) ??
-                promptForConfirmation(`About to overwrite ${overwriteTargets.length} existing migration fixture file(s). Continue?`);
-            if (!confirmed) {
-                renderLine(`Cancelled fixture refresh. Kept ${overwriteTargets.length} existing fixture file(s).`);
-                return {
-                    generatedVersions,
-                    skippedVersions: overwriteTargets.map(({ scopedLabel }) => scopedLabel),
-                };
-            }
-        }
-    }
-    for (const { block, fixturePath, scopedLabel, version } of fixtureTargets) {
-        const existed = fs.existsSync(fixturePath);
-        const diff = createMigrationDiff(state, block, version, targetMigrationVersion);
-        const result = ensureEdgeFixtureFile(projectDir, block, version, targetMigrationVersion, diff, { force });
-        if (result.written) {
-            generatedVersions.push(scopedLabel);
-            renderLine(`${existed ? 'Refreshed' : 'Generated'} fixture ${path.relative(projectDir, fixturePath)}`);
-        }
-        else {
-            skippedVersions.push(scopedLabel);
-            renderLine(`Preserved existing fixture ${path.relative(projectDir, fixturePath)} (use --force to refresh)`);
-        }
-    }
-    return {
-        generatedVersions,
-        skippedVersions,
-    };
-}
-/**
- * Run seeded migration fuzz verification against generated fuzz artifacts.
- *
- * @param projectDir Absolute or relative project directory containing the migration workspace.
- * @param options Fuzz scope, iteration count, seed, and console rendering options.
- * @returns Fuzzed legacy versions and the effective seed.
- */
-export function fuzzProjectMigrations(projectDir, { all = false, fromMigrationVersion, iterations = 25, renderLine = console.log, seed, } = {}) {
-    const state = loadMigrationProject(projectDir);
-    const targetVersions = resolveLegacyVersions(state, { all, fromMigrationVersion });
-    const blockEntries = getSelectedEntriesByBlock(state, targetVersions, 'fuzz');
-    const legacySingleBlock = isLegacySingleBlockProject(state);
-    if (targetVersions.length === 0) {
-        renderLine('No legacy migration versions configured for fuzzing.');
-        return { fuzzedVersions: [] };
-    }
-    const tsxBinary = getLocalTsxBinary(projectDir);
-    for (const [blockKey, entries] of Object.entries(blockEntries)) {
-        const block = state.blocks.find((entry) => entry.key === blockKey);
-        if (!block || entries.length === 0) {
-            continue;
-        }
-        for (const entry of entries) {
-            assertRuleHasNoTodos(projectDir, block, entry.fromVersion, state.config.currentMigrationVersion);
-        }
-        const fuzzScriptPath = path.join(getGeneratedDirForBlock(state.paths, block), 'fuzz.ts');
-        if (!fs.existsSync(fuzzScriptPath)) {
-            const selectedVersionsForBlock = entries.map((entry) => entry.fromVersion);
-            throw new Error(`Generated fuzz script is missing for ${block.blockName} (${selectedVersionsForBlock.join(', ')}). ` +
-                `Run \`${formatScaffoldCommand(selectedVersionsForBlock)}\` first, then \`wp-typia migrate doctor --all\` if the workspace should already be scaffolded.`);
-        }
-        const selectedVersionsForBlock = entries.map((entry) => entry.fromVersion);
-        const args = [
-            fuzzScriptPath,
-            ...(all ? ['--all'] : ['--from-migration-version', selectedVersionsForBlock[0]]),
-            '--iterations',
-            String(iterations),
-            ...(seed === undefined ? [] : ['--seed', String(seed)]),
-        ];
-        execFileSync(tsxBinary, args, {
-            cwd: projectDir,
-            shell: process.platform === 'win32',
-            stdio: 'inherit',
-        });
-        renderLine(legacySingleBlock
-            ? `Fuzzed migrations for ${selectedVersionsForBlock.join(', ')}`
-            : `Fuzzed ${block.blockName} migrations for ${selectedVersionsForBlock.join(', ')}`);
-    }
-    return { fuzzedVersions: targetVersions, seed };
-}
-function promptForConfirmation(message) {
-    process.stdout.write(`${message} [y/N]: `);
-    const buffer = Buffer.alloc(1);
-    let answer = '';
-    while (true) {
-        const bytesRead = fs.readSync(process.stdin.fd, buffer, 0, 1, null);
-        if (bytesRead === 0) {
-            break;
-        }
-        const char = buffer.toString('utf8', 0, bytesRead);
-        if (char === '\n' || char === '\r') {
-            break;
-        }
-        answer += char;
-    }
-    const normalized = answer.trim().toLowerCase();
-    return normalized === 'y' || normalized === 'yes';
-}
+export * from './migration-maintenance-verify.js';
+export * from './migration-maintenance-fixtures.js';

package/dist/runtime/migrations.d.ts

@@ -45,9 +45,6 @@ export declare function runMigrationCommand(command: ParsedMigrationArgs, cwd: s
 } | {
     generatedVersions: string[];
     skippedVersions: string[];
-} | {
-    fuzzedVersions: never[];
-    seed?: undefined;
 } | {
     fuzzedVersions: string[];
     seed: number | undefined;

package/dist/runtime/scaffold-apply-utils.d.ts

@@ -8,6 +8,15 @@ export interface InstallDependenciesOptions {
     projectDir: string;
 }
 export declare function ensureDirectory(targetDir: string, allowExisting?: boolean): Promise<void>;
+/**
+ * Builds the generated README markdown for one scaffolded project.
+ *
+ * @param templateId Scaffold template family or template identifier.
+ * @param variables Interpolated scaffold variables used in generated content.
+ * @param packageManager Package manager used to format install and script commands.
+ * @param options Optional README sections enabled by scaffold presets.
+ * @returns Markdown README content for the generated project root.
+ */
 export declare function buildReadme(templateId: string, variables: ScaffoldTemplateVariables, packageManager: PackageManagerId, { withMigrationUi, withTestPreset, withWpEnv, }?: {
     withMigrationUi?: boolean;
     withTestPreset?: boolean;

package/dist/runtime/scaffold-apply-utils.js

@@ -8,7 +8,7 @@ import { applyMigrationUiCapability } from "./migration-ui-capability.js";
 import { getPackageVersions } from "./package-versions.js";
 import { ensureMigrationDirectories, writeInitialMigrationScaffold, writeMigrationConfig, } from "./migration-project.js";
 import { syncPersistenceRestArtifacts, } from "./persistence-rest-artifacts.js";
-import { getCompoundExtensionWorkflowSection, getOptionalOnboardingNote, getOptionalOnboardingSteps, getPhpRestExtensionPointsSection, getTemplateSourceOfTruthNote, } from "./scaffold-onboarding.js";
+import { getCompoundExtensionWorkflowSection, getInitialCommitCommands, getInitialCommitNote, getOptionalOnboardingNote, getOptionalOnboardingSteps, getQuickStartWorkflowNote, getPhpRestExtensionPointsSection, getTemplateSourceOfTruthNote, } from "./scaffold-onboarding.js";
 import { getStarterManifestFiles, stringifyStarterManifest, } from "./starter-manifests.js";
 import { stringifyBuiltInBlockJsonDocument, } from "./built-in-block-artifacts.js";
 import { OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE, } from "./template-registry.js";
@@ -36,10 +36,20 @@ export async function ensureDirectory(targetDir, allowExisting = false) {
         throw new Error(`Target directory is not empty: ${targetDir}`);
     }
 }
+/**
+ * Builds the generated README markdown for one scaffolded project.
+ *
+ * @param templateId Scaffold template family or template identifier.
+ * @param variables Interpolated scaffold variables used in generated content.
+ * @param packageManager Package manager used to format install and script commands.
+ * @param options Optional README sections enabled by scaffold presets.
+ * @returns Markdown README content for the generated project root.
+ */
 export function buildReadme(templateId, variables, packageManager, { withMigrationUi = false, withTestPreset = false, withWpEnv = false, } = {}) {
     const optionalOnboardingSteps = getOptionalOnboardingSteps(packageManager, templateId, {
         compoundPersistenceEnabled: variables.compoundPersistenceEnabled === "true",
     });
+    const initialCommitCommands = getInitialCommitCommands();
     const sourceOfTruthNote = getTemplateSourceOfTruthNote(templateId, {
         compoundPersistenceEnabled: variables.compoundPersistenceEnabled === "true",
     });
@@ -70,20 +80,25 @@ ${variables.description}
 
 ${templateId}
 
-## Development
+## Quick Start
 
 \`\`\`bash
 ${formatInstallCommand(packageManager)}
 ${formatRunScript(packageManager, developmentScript)}
 \`\`\`
 
-## Build
+${getQuickStartWorkflowNote(packageManager, templateId, {
+        compoundPersistenceEnabled,
+    })}
+
+## Build and Verify
 
 \`\`\`bash
 ${formatRunScript(packageManager, "build")}
+${formatRunScript(packageManager, "typecheck")}
 \`\`\`
 
-## Optional First Sync
+## Advanced Sync
 
 \`\`\`bash
 ${optionalOnboardingSteps.join("\n")}
@@ -93,6 +108,14 @@ ${getOptionalOnboardingNote(packageManager, templateId, {
         compoundPersistenceEnabled,
     })}
 
+## Before First Commit
+
+\`\`\`bash
+${initialCommitCommands.join("\n")}
+\`\`\`
+
+${getInitialCommitNote()}
+
 ${sourceOfTruthNote}${publicPersistencePolicyNote ? `\n\n${publicPersistencePolicyNote}` : ""}${migrationSection ? `\n\n${migrationSection}` : ""}${compoundExtensionWorkflowSection ? `\n\n${compoundExtensionWorkflowSection}` : ""}${wpEnvSection ? `\n\n${wpEnvSection}` : ""}${testPresetSection ? `\n\n${testPresetSection}` : ""}${phpRestExtensionPointsSection ? `\n\n${phpRestExtensionPointsSection}` : ""}
 `;
 }

package/dist/runtime/scaffold-onboarding.d.ts

@@ -14,10 +14,22 @@ export declare function getOptionalSyncScriptNames(templateId: string, options?:
  * Formats optional onboarding sync commands for the selected package manager.
  */
 export declare function getOptionalOnboardingSteps(packageManager: PackageManagerId, templateId: string, options?: SyncOnboardingOptions): string[];
+/**
+ * Returns the quick-start note explaining the scaffold's primary local loop.
+ */
+export declare function getQuickStartWorkflowNote(packageManager: PackageManagerId, templateId?: string, options?: SyncOnboardingOptions): string;
 /**
  * Returns the onboarding note explaining when manual sync is optional.
  */
 export declare function getOptionalOnboardingNote(packageManager: PackageManagerId, templateId?: string, options?: SyncOnboardingOptions): string;
+/**
+ * Returns the recommended version-control commands for a fresh scaffold.
+ */
+export declare function getInitialCommitCommands(): string[];
+/**
+ * Returns the version-control note shown after the initial scaffold.
+ */
+export declare function getInitialCommitNote(): string;
 /**
  * Returns source-of-truth guidance for generated artifacts by template mode.
  */

package/dist/runtime/scaffold-onboarding.js

@@ -1,6 +1,11 @@
 import { formatRunScript } from "./package-managers.js";
 import { getPrimaryDevelopmentScript } from "./local-dev-presets.js";
 import { OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE, isBuiltInTemplateId, } from "./template-registry.js";
+const INITIAL_COMMIT_COMMANDS = [
+    "git init",
+    "git add .",
+    'git commit -m "Initial scaffold"',
+];
 function templateHasPersistenceSync(templateId, { compoundPersistenceEnabled = false } = {}) {
     return templateId === "persistence" || (templateId === "compound" && compoundPersistenceEnabled);
 }
@@ -28,6 +33,24 @@ export function getOptionalSyncScriptNames(templateId, options = {}) {
 export function getOptionalOnboardingSteps(packageManager, templateId, options = {}) {
     return getOptionalSyncScriptNames(templateId, options).map((scriptName) => formatRunScript(packageManager, scriptName));
 }
+/**
+ * Returns the quick-start note explaining the scaffold's primary local loop.
+ */
+export function getQuickStartWorkflowNote(packageManager, templateId = "basic", options = {}) {
+    const developmentScript = getPrimaryDevelopmentScript(templateId);
+    const devCommand = formatRunScript(packageManager, developmentScript);
+    const startCommand = formatRunScript(packageManager, "start");
+    if (developmentScript === "start") {
+        return `${startCommand} is the primary local entry point for this template. If the template also exposes a dedicated watch mode or alternate editor workflow, follow that template-specific documentation alongside the generated project scripts.`;
+    }
+    if (developmentScript !== "dev") {
+        return `${devCommand} is the primary local entry point for this template. Use ${startCommand} when you want the scaffold's one-shot startup flow instead of the watch-oriented workflow.`;
+    }
+    if (templateHasPersistenceSync(templateId, options)) {
+        return `${devCommand} keeps the editor, type-derived artifacts, and REST-derived artifacts moving together during local development. Use ${startCommand} when you want a one-shot sync plus editor startup without the long-running watch loop.`;
+    }
+    return `${devCommand} keeps the editor and type-derived artifacts moving together during local development. Use ${startCommand} when you want a one-shot sync plus editor startup without the long-running watch loop.`;
+}
 /**
  * Returns the onboarding note explaining when manual sync is optional.
  */
@@ -46,18 +69,32 @@ export function getOptionalOnboardingNote(packageManager, templateId = "basic",
     const advancedPersistenceNote = templateHasPersistenceSync(templateId, options)
         ? ` ${syncRestCommand} remains available for advanced REST-only refreshes, but it now fails fast when type-derived artifacts are stale; run \`${syncCommand}\` or \`${syncTypesCommand}\` first.`
         : "";
+    const isCustomTemplate = !isBuiltInTemplateId(templateId) &&
+        templateId !== OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE;
     const fallbackCustomTemplateNote = !hasUnifiedSync &&
         syncSteps.length > 0 &&
-        !isBuiltInTemplateId(templateId) &&
-        templateId !== OFFICIAL_WORKSPACE_TEMPLATE_PACKAGE
+        isCustomTemplate
         ? `Run ${syncSteps.join(" then ")} manually before build, typecheck, or commit. ${syncCheckCommand} verifies the current type-derived artifacts without rewriting them.${optionalSyncScripts.includes("sync-rest") ? ` ${syncRestCommand} remains available for REST-only refreshes after ${syncTypesCommand}.` : ""}`
         : null;
     if (fallbackCustomTemplateNote) {
         return fallbackCustomTemplateNote;
     }
-    return `${formatRunScript(packageManager, developmentScript)} ${developmentScript === "dev"
-        ? "watches the relevant sync scripts during local development."
-        : "remains the primary local entry point."} ${formatRunScript(packageManager, "start")} still runs one-shot syncs before starting, while ${formatRunScript(packageManager, "build")} and ${typecheckCommand} verify that generated metadata/schema artifacts are already current through ${syncCheckCommand}. Run ${syncCommand} manually when you want to refresh generated artifacts before build, typecheck, or commit. ${syncTypesCommand} stays warn-only by default; use \`${failOnLossySyncCommand}\` to fail only on lossy WordPress projections, or \`${strictSyncCommand}\` for a CI-friendly JSON report that fails on all warnings.${advancedPersistenceNote} They do not create migration history.`;
+    if (isCustomTemplate && syncSteps.length === 0) {
+        return "No optional sync command was detected for this custom template. Follow the template's own artifact-refresh guidance before build, typecheck, or your first commit.";
+    }
+    return `You usually do not need to run ${syncCommand} during a normal ${formatRunScript(packageManager, developmentScript)} session. Run ${syncCommand} manually when you want a reviewable artifact refresh before ${formatRunScript(packageManager, "build")}, ${typecheckCommand}, or your first commit. ${syncTypesCommand} stays warn-only by default; use \`${failOnLossySyncCommand}\` to fail only on lossy WordPress projections, or \`${strictSyncCommand}\` for the stricter CI-oriented report.${advancedPersistenceNote} They do not create migration history. If this directory is new, create your first Git commit after that refresh.`;
+}
+/**
+ * Returns the recommended version-control commands for a fresh scaffold.
+ */
+export function getInitialCommitCommands() {
+    return [...INITIAL_COMMIT_COMMANDS];
+}
+/**
+ * Returns the version-control note shown after the initial scaffold.
+ */
+export function getInitialCommitNote() {
+    return "Skip `git init` if this directory already lives inside an existing repository. If you want generated artifacts refreshed before the first checkpoint, run your manual sync step first and then create the commit.";
 }
 /**
  * Returns source-of-truth guidance for generated artifacts by template mode.

package/dist/runtime/scaffold.js

@@ -81,7 +81,7 @@ export async function resolvePackageManagerId({ packageManager, yes = false, isI
         return getPackageManager(packageManager).id;
     }
     if (yes) {
-        throw new Error(`Package manager is required when using --yes. Use --package-manager <${PACKAGE_MANAGER_IDS.join("|")}>.`);
+        return "npm";
     }
     if (!isInteractive || !selectPackageManager) {
         throw new Error(`Package manager is required in non-interactive mode. Use --package-manager <${PACKAGE_MANAGER_IDS.join("|")}>.`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-typia/project-tools",
-  "version": "0.16.12",
+  "version": "0.16.13",
   "description": "Project orchestration and programmatic tooling for wp-typia",
   "packageManager": "bun@1.3.11",
   "type": "module",