@evcraddock/slug-cli 0.2.0 → 0.4.0

package/dist/commands.js

@@ -19,8 +19,8 @@ Usage:
   slug [--config <file>] init <directory> --name <name> [--site-title <title>] [--template-url <url>] [--template-dir <dir>] [--json]
   slug [--config <file>] post list [--type article|link|note] [--status draft|published|all] [--tag <slug>] [--json]
   slug [--config <file>] post show <slug> [--json]
-  slug [--config <file>] post create --type article|link|note --slug <slug> --content <text> [--title <text>] [--url <url>] [--excerpt <text>] [--tag <slug>]... [--source-id <id>] [--author-id <id>]... [--json]
-  slug [--config <file>] post edit <slug> [--slug <new-slug>] [--title <text>] [--content <text>] [--url <url>] [--excerpt <text>] [--tag <slug>]... [--source-id <id>] [--author-id <id>]... [--json]
+  slug [--config <file>] post create --type article|link|note --slug <slug> --content <text> [--title <text>] [--url <url>] [--excerpt <text>] [--tag <slug>]... [--source-id <id>] [--credit-contact-id <id>]... [--json]
+  slug [--config <file>] post edit <slug> [--slug <new-slug>] [--title <text>] [--content <text>] [--url <url>] [--excerpt <text>] [--tag <slug>]... [--source-id <id>] [--credit-contact-id <id>]... [--json]
   slug [--config <file>] post delete <slug> [--json]
   slug [--config <file>] post publish <slug> [--json]
   slug [--config <file>] post unpublish <slug> [--json]
@@ -298,17 +298,18 @@ async function assertDirectoryIsMissingOrEmpty(directory) {
         throw createInvalidUsageError(`Cannot inspect target directory: ${directory}`);
     }
 }
-async function copyTemplateSite(source, destination) {
+async function copyTemplateSite(source, destination, relativeDirectory = "") {
     const entries = await readdir(source, { withFileTypes: true });
     for (const entry of entries) {
-        if (shouldExcludeTemplateEntry(entry.name)) {
+        const relativePath = relativeDirectory === "" ? entry.name : join(relativeDirectory, entry.name);
+        if (shouldExcludeTemplateEntry(relativePath, entry.name)) {
             continue;
         }
         const sourcePath = join(source, entry.name);
         const destinationPath = join(destination, entry.name);
         if (entry.isDirectory()) {
             await mkdir(destinationPath, { recursive: true });
-            await copyTemplateSite(sourcePath, destinationPath);
+            await copyTemplateSite(sourcePath, destinationPath, relativePath);
             continue;
         }
         if (entry.isFile()) {
@@ -317,8 +318,15 @@ async function copyTemplateSite(source, destination) {
         }
     }
 }
-function shouldExcludeTemplateEntry(name) {
-    return TEMPLATE_COPY_EXCLUDES.has(name) || name.endsWith(".log") || name.endsWith(".tsbuildinfo");
+const GENERATED_SITE_TEST_EXCLUDES = new Set([
+    join("src", "__tests__", "dev-environment.test.ts"),
+    join("src", "federation", "__tests__", "follow.test.ts"),
+]);
+function shouldExcludeTemplateEntry(relativePath, name) {
+    return (GENERATED_SITE_TEST_EXCLUDES.has(relativePath) ||
+        TEMPLATE_COPY_EXCLUDES.has(name) ||
+        name.endsWith(".log") ||
+        name.endsWith(".tsbuildinfo"));
 }
 async function replaceGeneratedSitePlaceholders(directory, options) {
     await updateJsonFile(join(directory, "package.json"), (value) => ({
@@ -335,22 +343,20 @@ async function replaceGeneratedSitePlaceholders(directory, options) {
     await replaceTextFile(join(directory, "README.md"), [
         ["# Slugkit Template Site", `# ${options.siteTitle}`],
         [
-            "This is the in-repo Slugkit template website. It is used for local CLI/API testing and is the source directory that future `slug init` work should copy into standalone site projects.\n\nGenerated sites should contain this website code, not the `slug` CLI source code.",
-            "This is a standalone Slugkit-compatible website generated from the Slugkit template. This site owns its code and can be customized freely while preserving the Slugkit API contract.",
+            "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.",
         ],
         [
-            "From the repository root:\n\n```bash\nmake dev\n```\n\nFrom this directory:\n\n```bash\nnpm run dev\n```",
-            "From this generated site directory:\n\n```bash\nnpm run dev\n```",
+            "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.",
         ],
         [
-            "Run migrations from the repository root:",
-            "Run migrations from this generated site directory:",
+            "## 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.",
         ],
-        ["npm run db:migrate --workspace @slugkit/template-site", "npm run db:migrate"],
-        ["npm run db:status --workspace @slugkit/template-site", "npm run db:status"],
         [
-            "In repository-local development, run `make garage-setup` once from the repository root to create the local Garage bucket/key and fill the secret values below before normal `make dev` use.",
-            "For local media development, configure these values for a local or remote S3-compatible service before uploading media.",
+            "## 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`.",
         ],
     ]);
 }
@@ -657,8 +663,9 @@ async function runLoginCommand(context, args) {
     const config = await readConfig(context.configPath);
     const apiBaseUrl = normalizeUrl(args[0] ?? config.apiBaseUrl ?? (await promptForValue(context, "API base URL: ")));
     const authUrl = createBrowserAuthUrl(apiBaseUrl);
-    context.writer.stdout("Open this URL to create an API key:");
+    context.writer.stdout("Open this URL to log in and create an API key:");
     context.writer.stdout(authUrl);
+    context.writer.stdout("If a browser does not open, copy the URL into your browser manually.");
     if (context.openUrl !== undefined) {
         try {
             await context.openUrl(authUrl);
@@ -667,6 +674,7 @@ async function runLoginCommand(context, args) {
             context.writer.stdout("Could not open a browser automatically.");
         }
     }
+    context.writer.stdout(`Paste the API key from the website. The CLI will verify it and save it to ${context.configPath}.`);
     const apiKey = (await promptForValue(context, "API key: ")).trim();
     if (apiKey === "") {
         throw createInvalidUsageError("API key is required");
@@ -742,7 +750,7 @@ async function runPostsCreateCommand(context, args) {
         "excerpt",
         "tag",
         "source-id",
-        "author-id",
+        "credit-contact-id",
     ]);
     const body = createPostMutationInput(parsed.options, true);
     const api = await createConfiguredApiContext(context);
@@ -768,7 +776,7 @@ async function runPostsEditCommand(context, args) {
         "excerpt",
         "tag",
         "source-id",
-        "author-id",
+        "credit-contact-id",
     ]);
     const body = createPostMutationInput(parsed.options, false);
     if (Object.keys(body).length === 0) {
@@ -828,7 +836,7 @@ function parsePostFlags(args, allowed) {
         if (value === undefined || value.startsWith("--")) {
             throw createInvalidUsageError(`Option --${key} requires a value`);
         }
-        if (key === "tag" || key === "author-id") {
+        if (key === "tag" || key === "credit-contact-id") {
             const current = options[key];
             options[key] = [...(Array.isArray(current) ? current : []), value];
         }
@@ -851,8 +859,8 @@ function createPostMutationInput(options, requireCreateFields) {
     if (Array.isArray(options.tag)) {
         input.tagSlugs = options.tag;
     }
-    if (Array.isArray(options["author-id"])) {
-        input.authorIds = options["author-id"].map((value) => readPositiveInteger(value, "author-id"));
+    if (Array.isArray(options["credit-contact-id"])) {
+        input.creditContactIds = options["credit-contact-id"].map((value) => readPositiveInteger(value, "credit-contact-id"));
     }
     if (requireCreateFields) {
         for (const key of ["type", "slug", "content"]) {

package/package.json

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