@evcraddock/slug-cli 0.7.0 → 0.8.0

package/dist/commands.js

@@ -344,7 +344,7 @@ function shouldExcludeTemplateEntry(relativePath, name) {
         parts.includes("data") ||
         parts.includes("coverage") ||
         relativePath === "src/__tests__/dev-environment.test.ts" ||
-        relativePath === "src/federation/__tests__/follow.test.ts" ||
+        relativePath === "src/federation/__tests__/follow.integration.test.ts" ||
         relativePath === ".env" ||
         name.endsWith(".log") ||
         name.endsWith(".tsbuildinfo"));
@@ -363,25 +363,24 @@ async function replaceGeneratedSitePlaceholders(directory, options) {
             `intro: ${JSON.stringify(`${options.siteTitle} is ready for posts, feeds, and federation.`)}`,
         ],
     ]);
-    await replaceTextFile(join(directory, "README.md"), [
-        ["# Slugkit Template Site", `# ${options.siteTitle}`],
-        [
-            "This is the in-repo Slugkit template website. It is toolkit source used for local CLI/API development and for `slug init`; it is not itself the deployable website you hand to a site owner. Generated sites should contain this website code without the `slug` CLI source code.\n\nInitialized sites are standalone Slugkit-compatible websites. After `slug init`, the generated site owns its code and may customize routes, templates, styles, assets, and deployment freely while preserving the Slugkit API contract that the `slug` CLI uses.",
-            "This is a standalone Slugkit-compatible website generated from the Slugkit template. This site owns its code and can customize routes, templates, styles, assets, and deployment freely while preserving the Slugkit API contract that the `slug` CLI uses.",
-        ],
-        [
-            "Local toolkit development can run `make garage-setup` from the Slugkit repository root after `make dev` starts Garage. Standalone initialized sites should configure these values for their own local or production S3-compatible service before uploading media.",
-            "Configure these values for your own local or production S3-compatible service before uploading media.",
-        ],
-        [
-            "## In-repository development\n\nWhen working inside the Slugkit toolkit repository, start the full local dev environment from the repository root:\n\n```bash\nmake dev\n```\n\nFrom `template/site`, you can also run the app and Tailwind watcher directly in separate terminals:\n\n```bash\nnpm run dev\nnpm run css:watch\n```\n\nRepository-root workspace commands are useful while developing the template itself:\n\n```bash\nnpm run db:migrate --workspace @slugkit/template-site\nnpm run db:status --workspace @slugkit/template-site\nnpm run test --workspace @slugkit/template-site\n```\n\nStandalone initialized sites should use the non-workspace commands shown in the quick start section.",
-            "## Local development\n\nInstall Overmind if it is not already available, then run the app and Tailwind watcher together from this site directory:\n\n```bash\nmake dev\n```\n\nThe generated `Procfile.dev` runs `npm run dev` for the Hono app and `npm run css:watch` for Tailwind. Use the non-workspace commands shown in the quick start section for migrations and local checks.",
-        ],
-        [
-            "## Related specs\n\n- [Web Spec 08: Template Setup Documentation](../../docs/web-specs/08-template-setup-documentation.md)\n- [CLI Spec 12: Site Init Command](../../docs/cli-specs/12-site-init-command.md)\n- [CLI Specs](../../docs/cli-specs/README.md)\n- [API Route Specs](../../docs/specs/README.md)",
-            "## Related Slugkit references\n\n- Slugkit API documentation is available from a running site at `/api/v1/docs`.\n- The CLI compatibility check is `slug doctor`.\n- The generated site marker is `.slugkit-site.json`.",
-        ],
+    await writeGeneratedSiteReadme(directory, options);
+}
+async function writeGeneratedSiteReadme(directory, options) {
+    const sourcePath = join(directory, "README.generated.md");
+    const source = await readFile(sourcePath, "utf8");
+    const replacements = new Map([
+        ["{{SITE_NAME}}", options.name],
+        ["{{SITE_TITLE}}", options.siteTitle],
     ]);
+    let content = source;
+    for (const [placeholder, value] of replacements) {
+        if (!content.includes(placeholder)) {
+            throw createInvalidUsageError(`Generated README is missing placeholder: ${placeholder}`);
+        }
+        content = content.replaceAll(placeholder, value);
+    }
+    await writeFile(join(directory, "README.md"), content, "utf8");
+    await rm(sourcePath);
 }
 function replaceGeneratedSiteWorkspaceDependencies(value) {
     if (!isRecord(value))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evcraddock/slug-cli",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Command-line tool for Slugkit sites.",
   "private": false,
   "type": "module",