@ykdz/template 0.0.18 → 0.0.20

package/dist/cli.js

@@ -4,8 +4,8 @@ import path from "node:path";
 import { createInterface } from "node:readline/promises";
 import { builtInPresetProjectionSourceRoots, builtInPresets, findBuiltInPresetSourceManifestPreset, loadBuiltInPresetSourceManifest, projectBuiltInPresetSourcePreset, } from "@ykdz/template-builtin-source";
 import { assembleGenerationContext, } from "@ykdz/template-core/generation-context";
+import { formatNextStepInstructionsForCli, generatedFollowUpDocumentOperation, planNextStepInstructions, } from "@ykdz/template-core/next-step-instructions";
 import { addPackage } from "@ykdz/template-core/package-addition";
-import { planNextStepInstructionsForProjection, } from "@ykdz/template-core/preset-projection";
 import { validateBuiltInPresetSourceManifest, validatePresetSourceManifest, } from "@ykdz/template-core/preset-source";
 import { blueprintForPresetSourcePreset } from "@ykdz/template-core/projection-capabilities";
 import { renderNewProject } from "@ykdz/template-core/renderer";
@@ -35,6 +35,7 @@ function usage() {
         "  --yes            Accept defaults for non-interactive generation",
         "  --dry-run        Print the planned generation without writing files",
         "  --json           Print machine-readable output",
+        "  --no-todo        Do not write the generated follow-up TODO.md document",
         "",
         "Add package options:",
         "  --preset <name>     Package preset to add",
@@ -87,6 +88,7 @@ function parseInitOptions(args) {
     let yes = false;
     let dryRun = false;
     let json = false;
+    let todo = true;
     let scope;
     for (let index = 2; index < args.length; index += 1) {
         const arg = args[index];
@@ -102,6 +104,10 @@ function parseInitOptions(args) {
             json = true;
             continue;
         }
+        if (arg === "--no-todo") {
+            todo = false;
+            continue;
+        }
         if (arg === "--scope") {
             const value = args[index + 1];
             if (!value) {
@@ -125,7 +131,7 @@ function parseInitOptions(args) {
     if (!dir) {
         throw new Error("init requires a target directory");
     }
-    return { dir, preset, yes, dryRun, json, scope };
+    return { dir, preset, yes, dryRun, json, todo, scope };
 }
 function normalizeNpmScope(value) {
     if (value !== value.trim() || /\s/.test(value)) {
@@ -188,19 +194,36 @@ function formatBlueprintSummary(targetDir, blueprint) {
         ...blueprint.features.map((feature) => `    - ${feature}`),
     ].join("\n");
 }
-function formatProjectionNextSteps(targetDir, projectionPlan) {
-    const steps = planNextStepInstructionsForProjection({
+function planProjectionNextSteps(targetDir, projectionPlan) {
+    return planNextStepInstructions({
         targetDir,
-        plan: projectionPlan,
+        projectionPlan,
     });
-    return [
-        "Next Step Instructions:",
-        "",
-        ...steps.flatMap((step, index) => [
-            `  ${index + 1}. ${step.label}`,
-            `     ${step.display}`,
-        ]),
-    ].join("\n");
+}
+function followUpDocumentPlan(options) {
+    return options.todo ? { enabled: true, path: "TODO.md" } : { enabled: false };
+}
+function displayPathFromCwd(filePath) {
+    const absolutePath = path.resolve(filePath);
+    const relativePath = path.relative(process.cwd(), absolutePath);
+    if (relativePath &&
+        !relativePath.startsWith("..") &&
+        !path.isAbsolute(relativePath)) {
+        return relativePath;
+    }
+    return absolutePath;
+}
+function followUpDocumentDisplayPath(options) {
+    return displayPathFromCwd(path.join(options.dir, "TODO.md"));
+}
+function formatFollowUpDocumentReport(options) {
+    const rows = [
+        ["Enabled", options.todo ? "yes" : "no"],
+    ];
+    if (options.todo) {
+        rows.push(["Path", followUpDocumentDisplayPath(options)]);
+    }
+    return ["Generated Follow-Up Document:", "", ...formatFieldRows(rows)].join("\n");
 }
 function toolchainReport(toolchain) {
     return {
@@ -256,11 +279,15 @@ async function generateInitProject(options, generationContext) {
         preset,
         context: generationContext,
     });
+    const nextStepPlan = planProjectionNextSteps(options.dir, plan);
+    const operations = options.todo
+        ? [...plan.operations, generatedFollowUpDocumentOperation(nextStepPlan)]
+        : [...plan.operations];
     await renderNewProject({
         sourceRoot: plan.sourceRoot,
         sourceRoots: plan.sourceRoots,
         targetRoot: options.dir,
-        operations: [...plan.operations],
+        operations,
     });
 }
 function printInitComplete(options, blueprint, generationContext) {
@@ -271,10 +298,9 @@ function printInitComplete(options, blueprint, generationContext) {
     if (!projectionPlan) {
         throw new Error(`Missing Preset Projection plan: ${blueprint.preset}`);
     }
-    const nextSteps = planNextStepInstructionsForProjection({
-        targetDir: options.dir,
-        plan: projectionPlan,
-    });
+    const nextStepPlan = planProjectionNextSteps(options.dir, projectionPlan);
+    const nextSteps = nextStepPlan.steps;
+    const followUpDocument = followUpDocumentPlan(options);
     if (options.json) {
         printJson({
             command: "init",
@@ -285,6 +311,7 @@ function printInitComplete(options, blueprint, generationContext) {
                 ? { toolchain: toolchainReport(generationContext.toolchain) }
                 : {}),
             nextSteps,
+            followUpDocument,
         });
         return;
     }
@@ -301,7 +328,12 @@ function printInitComplete(options, blueprint, generationContext) {
         console.log(formatToolchainReport(generationContext.toolchain));
     }
     console.log("");
-    console.log(formatProjectionNextSteps(options.dir, projectionPlan));
+    if (options.todo) {
+        console.log(`Follow-up checklist written to ${followUpDocumentDisplayPath(options)}`);
+    }
+    else {
+        console.log(formatNextStepInstructionsForCli(nextStepPlan));
+    }
 }
 function isInteractiveTerminal() {
     return process.stdin.isTTY && process.stdout.isTTY;
@@ -467,10 +499,9 @@ async function main(args) {
             if (!projectionPlan) {
                 throw new Error(`Missing Preset Projection plan: ${blueprint.preset}`);
             }
-            const nextSteps = planNextStepInstructionsForProjection({
-                targetDir: options.dir,
-                plan: projectionPlan,
-            });
+            const nextStepPlan = planProjectionNextSteps(options.dir, projectionPlan);
+            const nextSteps = nextStepPlan.steps;
+            const followUpDocument = followUpDocumentPlan(options);
             if (options.json) {
                 printJson({
                     command: "init",
@@ -481,6 +512,7 @@ async function main(args) {
                         ? { toolchain: toolchainReport(generationContext.toolchain) }
                         : {}),
                     nextSteps,
+                    followUpDocument,
                 });
                 return;
             }
@@ -490,7 +522,12 @@ async function main(args) {
                 console.log(formatToolchainReport(generationContext.toolchain));
             }
             console.log("");
-            console.log(formatProjectionNextSteps(options.dir, projectionPlan));
+            if (options.todo) {
+                console.log(formatFollowUpDocumentReport(options));
+            }
+            else {
+                console.log(formatNextStepInstructionsForCli(nextStepPlan));
+            }
             return;
         }
         if (!options.yes && (options.json || !isInteractiveTerminal())) {

package/node_modules/@ykdz/template-builtin-source/dist/templates/registry.js

@@ -1,4 +1,3 @@
-import { honoApiPresetProjection } from "./hono-api/projection.js";
 import { rustBinPresetProjection } from "./rust-bin/projection.js";
 import { tsLibPresetProjection } from "./ts-lib/projection.js";
 import { vikeAppPresetProjection } from "./vike-app/projection.js";
@@ -6,7 +5,6 @@ import { vueAppPresetProjection } from "./vue-app/projection.js";
 import { vueHonoAppPresetProjection } from "./vue-hono-app/projection.js";
 const testOnlyPresetProjections = [
     tsLibPresetProjection,
-    honoApiPresetProjection,
     vueAppPresetProjection,
     vikeAppPresetProjection,
     vueHonoAppPresetProjection,

package/node_modules/@ykdz/template-builtin-source/dist/templates/vike-app/projection.js

@@ -5,7 +5,7 @@ import { PackageAdditionSupport, } from "@ykdz/template-shared";
 export const vikeAppPresetMetadata = {
     name: "vike-app",
     title: "Vike app",
-    description: "Single-package Vike, Hono, Telefunc, Drizzle, and Vue application.",
+    description: "Vike, Hono, Telefunc, Drizzle, and Vue workspace with a separate database package.",
     generation: "supported",
     supportedPackageManagers: ["pnpm"],
     supportedProjectKinds: ["multi-package"],
@@ -27,6 +27,9 @@ function projectNameFromDir(targetDir) {
 function scopedPackageName(packageScope) {
     return `@${packageScope}/web`;
 }
+function scopedDbPackageName(packageScope) {
+    return `@${packageScope}/db`;
+}
 export function vikeAppBlueprint(options = { targetDir: process.cwd() }) {
     const projectName = projectNameFromDir(options.targetDir);
     return {
@@ -35,7 +38,15 @@ export function vikeAppBlueprint(options = { targetDir: process.cwd() }) {
         packageManager: "pnpm",
         projectKind: "multi-package",
         features: [...vikeAppPresetMetadata.features],
-        packages: [{ name: scopedPackageName(projectName), path: "apps/web" }],
+        packages: [
+            { name: scopedPackageName(projectName), path: "apps/web" },
+            {
+                name: scopedDbPackageName(projectName),
+                path: "packages/db",
+                role: "shared-library",
+                sourcePreset: "ts-lib",
+            },
+        ],
     };
 }
 export const vikeAppPresetProjection = {

package/node_modules/@ykdz/template-builtin-source/dist/templates/vue-app/projection.js

@@ -1,5 +1,4 @@
 import { existsSync } from "node:fs";
-import { readFile } from "node:fs/promises";
 import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { builtInPresetProjectionSourceRoots, loadBuiltInPresetProjectionDeclaration, } from "@ykdz/template-builtin-source";
@@ -59,66 +58,6 @@ export function projectVueAppPackageScripts() {
         "typecheck:run": "vue-tsc --build --noEmit --pretty false",
     };
 }
-function isNodeError(error) {
-    return error instanceof Error && "code" in error;
-}
-function localPortsFromText(text) {
-    return [
-        ...text.matchAll(/port:\s*(\d+)/g),
-        ...text.matchAll(/--port\s+(\d+)/g),
-        ...text.matchAll(/https?:\/\/(?:localhost|127\.0\.0\.1):(\d+)/g),
-    ].map((match) => Number(match[1]));
-}
-async function usedPlaywrightPorts(root, blueprint) {
-    const ports = new Set();
-    for (const projectPackage of blueprint.packages ?? []) {
-        try {
-            const configText = await readFile(path.join(root, projectPackage.path, "playwright.config.ts"), "utf8");
-            for (const port of localPortsFromText(configText)) {
-                ports.add(port);
-            }
-        }
-        catch (error) {
-            if (!isNodeError(error) || error.code !== "ENOENT") {
-                throw error;
-            }
-        }
-    }
-    return ports;
-}
-async function nextVuePreviewPort(root, blueprint) {
-    const usedPorts = await usedPlaywrightPorts(root, blueprint);
-    let port = 4173;
-    while (usedPorts.has(port)) {
-        port += 1;
-    }
-    return port;
-}
-function vueAppPlaywrightConfig(previewPort) {
-    return `import { defineConfig, devices } from "@playwright/test";
-
-const previewUrl = "http://127.0.0.1:${previewPort}";
-
-export default defineConfig({
-  testDir: "./test/e2e",
-  use: {
-    baseURL: previewUrl,
-    trace: "on-first-retry"
-  },
-  webServer: {
-    command: "pnpm run preview --host 127.0.0.1 --port ${previewPort}",
-    reuseExistingServer: !process.env.CI,
-    url: previewUrl
-  },
-  projects: [
-    {
-      name: "chromium",
-      use: { ...devices["Desktop Chrome"] }
-    }
-  ]
-});
-`;
-}
 function packageAdditionOperations(packagePath, packageNameValue, nodeVersion) {
     return [
         {
@@ -184,8 +123,8 @@ function packageAdditionOperations(packagePath, packageNameValue, nodeVersion) {
                     exactOptionalPropertyTypes: true,
                     forceConsistentCasingInFileNames: true,
                     isolatedModules: true,
-                    module: "ESNext",
-                    moduleResolution: "Bundler",
+                    module: "esnext",
+                    moduleResolution: "bundler",
                     noEmitOnError: true,
                     noFallthroughCasesInSwitch: true,
                     noImplicitOverride: true,
@@ -225,8 +164,8 @@ function packageAdditionOperations(packagePath, packageNameValue, nodeVersion) {
                     exactOptionalPropertyTypes: true,
                     forceConsistentCasingInFileNames: true,
                     isolatedModules: true,
-                    module: "ESNext",
-                    moduleResolution: "Bundler",
+                    module: "esnext",
+                    moduleResolution: "bundler",
                     noEmitOnError: true,
                     lib: ["ESNext", "DOM", "DOM.Iterable"],
                     noFallthroughCasesInSwitch: true,
@@ -289,9 +228,8 @@ function packageAdditionOperations(packagePath, packageNameValue, nodeVersion) {
         },
     ];
 }
-async function packageAdditionPlan({ root, blueprint, packageName: packageNameValue, packagePath, nodeVersion, }) {
+async function packageAdditionPlan({ packageName: packageNameValue, packagePath, nodeVersion, }) {
     const [workspaceCollection] = packagePath.split("/");
-    const previewPort = await nextVuePreviewPort(root, blueprint);
     return {
         packagePath,
         workspacePackageGlob: `${workspaceCollection}/*`,
@@ -300,12 +238,6 @@ async function packageAdditionPlan({ root, blueprint, packageName: packageNameVa
         sourceRoot: templateSourceRoot(),
         sourceRoots: { sharedOxc: sharedOxcSourceRoot() },
         operations: packageAdditionOperations(packagePath, packageNameValue, nodeVersion),
-        textFiles: [
-            {
-                path: `${packagePath}/playwright.config.ts`,
-                text: vueAppPlaywrightConfig(previewPort),
-            },
-        ],
     };
 }
 function templateSourceRoot() {

package/node_modules/@ykdz/template-builtin-source/dist/templates/vue-hono-app/projection.js

@@ -7,7 +7,7 @@ import { PackageAdditionSupport, } from "@ykdz/template-shared";
 export const vueHonoAppPresetMetadata = {
     name: "vue-hono-app",
     title: "Vue Hono app",
-    description: "Full-stack Vue and Hono workspace with Hono RPC typing.",
+    description: "Full-stack Vue and Hono workspace with separated app package boundaries.",
     generation: "supported",
     supportedPackageManagers: ["pnpm"],
     supportedProjectKinds: ["multi-package"],
@@ -87,7 +87,8 @@ export function vueHonoAppBlueprint(options) {
 }
 export function projectVueHonoRootPackageScripts() {
     return {
-        check: renderRootCheckCommand(planVueHonoRootChecks()),
+        check: `pnpm run check:boundaries && ${renderRootCheckCommand(planVueHonoRootChecks())}`,
+        "check:boundaries": "turbo boundaries --no-color",
         "check:run": 'node -e ""',
         dev: "turbo run dev --parallel",
         fix: renderFixCommand(planVueHonoRootFixes()),

package/node_modules/@ykdz/template-builtin-source/package.json

@@ -9,24 +9,41 @@
     "!templates/registry.ts",
     "!templates/projection-plans.ts",
     "!templates/*/projection.ts",
+    "!templates/*/behavior.test.ts",
     "!templates/shared/oxc/tsconfig.json",
     "!templates/**/node_modules"
   ],
   "type": "module",
   "exports": {
     ".": {
+      "source": {
+        "types": "./src/index.ts",
+        "default": "./src/index.ts"
+      },
       "types": "./dist/src/index.d.ts",
       "default": "./dist/src/index.js"
     },
     "./registry": {
+      "source": {
+        "types": "./templates/registry.ts",
+        "default": "./templates/registry.ts"
+      },
       "types": "./dist/templates/registry.d.ts",
       "default": "./dist/templates/registry.js"
     },
     "./projection-plans": {
+      "source": {
+        "types": "./templates/projection-plans.ts",
+        "default": "./templates/projection-plans.ts"
+      },
       "types": "./dist/templates/projection-plans.d.ts",
       "default": "./dist/templates/projection-plans.js"
     },
     "./templates/*": {
+      "source": {
+        "types": "./templates/*.ts",
+        "default": "./templates/*.ts"
+      },
       "types": "./dist/templates/*.d.ts",
       "default": "./dist/templates/*.js"
     }
@@ -41,8 +58,8 @@
     "check:templates:static-source": "rustup run stable rustfmt --check templates/rust-bin/src/main.rs",
     "format:check": "oxfmt --list-different --config ../../oxfmt.config.ts .",
     "format:write": "oxfmt --write --config ../../oxfmt.config.ts .",
-    "lint": "oxlint --quiet --format=unix --config ../../oxlint.config.ts src templates/projection-plans.ts templates/registry.ts templates/*/projection.ts",
-    "lint:fix": "oxlint --format=unix --config ../../oxlint.config.ts src templates/projection-plans.ts templates/registry.ts templates/*/projection.ts --fix",
+    "lint": "oxlint --quiet --format=unix --config ../../oxlint.config.ts src templates/projection-plans.ts templates/registry.ts templates/*/projection.ts templates/*/behavior.test.ts",
+    "lint:fix": "oxlint --format=unix --config ../../oxlint.config.ts src templates/projection-plans.ts templates/registry.ts templates/*/projection.ts templates/*/behavior.test.ts --fix",
     "typecheck": "tsc -p tsconfig.json --noEmit --pretty false"
   },
   "dependencies": {
@@ -52,9 +69,25 @@
     "valibot": "catalog:"
   },
   "devDependencies": {
+    "@hono/node-server": "catalog:",
+    "@playwright/test": "catalog:",
+    "@tailwindcss/vite": "catalog:",
     "@types/node": "catalog:",
+    "@vikejs/hono": "catalog:",
+    "@vitejs/plugin-vue": "catalog:",
+    "drizzle-kit": "catalog:",
+    "drizzle-orm": "catalog:",
+    "hono": "catalog:",
     "oxfmt": "catalog:",
     "oxlint": "catalog:",
-    "oxlint-tsgolint": "catalog:"
+    "oxlint-tsgolint": "catalog:",
+    "pinia": "catalog:",
+    "telefunc": "catalog:",
+    "vike": "catalog:",
+    "vike-vue": "catalog:",
+    "vite": "catalog:",
+    "vitest": "catalog:",
+    "vue": "catalog:",
+    "yaml": "catalog:"
   }
 }