@evcraddock/slug-cli 0.6.3 → 0.6.4

package/README.md

@@ -25,7 +25,7 @@ Create a standalone site with:
 slug init ./my-site --name my-site --site-title "My Site"
 ```
 
-Run `slug init --help` for template options. By default, `slug init` consumes the package-backed `@evcraddock/slug-template` default template. `--template-dir` and `--template-url` remain available for local or remote template testing, and `--template` reserves the selection path for future named or external template packages.
+Run `slug init --help` for template options. By default, `slug init` downloads the default template zip artifact. `--template-dir` remains available for local template development, `--template-url` supports alternate remote zip artifacts, and `--template` reserves the selection path for future named templates.
 
 ## Login and configuration
 

package/dist/commands.d.ts

@@ -9,7 +9,6 @@ export interface CommandContext {
     fetchImpl?: typeof fetch;
     openUrl?: (url: string) => Promise<void> | void;
     prompt?: (message: string) => Promise<string> | string;
-    templateSiteDirectory?: string | null;
     templateAssetBaseUrl?: string;
 }
 export interface CommandResult {

package/dist/commands.js

@@ -1,11 +1,8 @@
-import { readFileSync } from "node:fs";
 import { mkdir, mkdtemp, readFile, readdir, rm, stat, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import { dirname, basename, extname, join, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
-import { x as extractTarball } from "tar";
+import AdmZip from "adm-zip";
 import { SLUGKIT_API_MAJOR_VERSION, SLUGKIT_API_NAME, compareSlugkitApiVersions, normalizeApiBaseUrl, readSlugkitApiMajorVersion, } from "@evcraddock/slug-core";
-import { GENERATED_SITE_SLUGKIT_DEPENDENCIES, SLUGKIT_TEMPLATE_PACKAGE_NAME, getTemplateMetadata, getTemplateRoot, isTemplateEntryIncluded, } from "@evcraddock/slug-template";
 import { isValidSiteName, readConfig, removeConfigSite, setConfigSiteApiBaseUrl, setConfigSiteApiKey, toDisplayConfig, writeConfig, } from "./config.js";
 import { CliError, createInvalidUsageError, ExitCode } from "./errors.js";
 import { SlugHttpClient } from "./http.js";
@@ -134,9 +131,16 @@ async function runVersionCommand(context, args) {
     return { exitCode: ExitCode.Ok };
 }
 const SUPPORTED_API_MAJOR_VERSION = SLUGKIT_API_MAJOR_VERSION;
-const SITE_TEMPLATE_PACKAGE_NAME = getTemplateMetadata().templateSitePackageName;
-const DEFAULT_TEMPLATE_METADATA = getTemplateMetadata();
-const DEFAULT_TEMPLATE_NAME = DEFAULT_TEMPLATE_METADATA.name;
+const SITE_TEMPLATE_PACKAGE_NAME = "@slugkit/template-site";
+const DEFAULT_TEMPLATE_NAME = "default";
+const DEFAULT_TEMPLATE_URL = "https://forge.caradoc.com/erik/slugkit/releases/download/slugkit-template-latest/slugkit-site-template.zip";
+const GENERATED_SITE_SLUGKIT_DEPENDENCIES = {
+    "@evcraddock/slug-api": "0.1.1",
+    "@evcraddock/slug-auth": "0.1.0",
+    "@evcraddock/slug-core": "0.1.1",
+    "@evcraddock/slug-federation": "0.1.0",
+    "@evcraddock/slug-media": "0.1.0",
+};
 const INIT_HELP_TEXT = `slug init - create a standalone Slugkit-compatible website
 
 Usage:
@@ -146,12 +150,12 @@ Options:
   --name <name>          npm package name for the generated site.
   --site-title <title>   Human-readable site title. Defaults to a title derived from --name.
   --template <name>      Template name or package. Defaults to ${DEFAULT_TEMPLATE_NAME}.
-  --template-url <url>   Download a template tarball from a custom URL.
+  --template-url <url>   Download a template zip artifact from a custom URL.
   --template-dir <dir>   Copy a template from a local directory.
   --json                 Print command output as JSON.
   --help, -h             Show this help.
 
-By default, slug init uses ${SLUGKIT_TEMPLATE_PACKAGE_NAME}. Template packages are initialization sources only; generated sites do not depend on them at runtime.`;
+By default, slug init downloads the default template zip artifact. Set SLUGKIT_TEMPLATE_URL or pass --template-url to use a different zip artifact. Generated sites do not depend on the template artifact at runtime.`;
 const SITE_INIT_NEXT_STEPS = [
     "Install dependencies",
     "Copy and edit .env",
@@ -331,8 +335,18 @@ async function copyTemplateSite(source, destination, relativeDirectory = "") {
         }
     }
 }
-function shouldExcludeTemplateEntry(relativePath, _name) {
-    return !isTemplateEntryIncluded(relativePath);
+function shouldExcludeTemplateEntry(relativePath, name) {
+    const parts = relativePath.split(/[\\/]+/u).filter(Boolean);
+    return (parts.includes("node_modules") ||
+        parts.includes("dist") ||
+        parts.includes("build") ||
+        parts.includes("data") ||
+        parts.includes("coverage") ||
+        relativePath === "src/__tests__/dev-environment.test.ts" ||
+        relativePath === "src/federation/__tests__/follow.test.ts" ||
+        relativePath === ".env" ||
+        name.endsWith(".log") ||
+        name.endsWith(".tsbuildinfo"));
 }
 async function replaceGeneratedSitePlaceholders(directory, options) {
     await updateJsonFile(join(directory, "package.json"), (value) => ({
@@ -394,20 +408,20 @@ async function writeGeneratedSiteMarker(directory, options) {
         slugkitSite: true,
         name: options.name,
         siteTitle: options.siteTitle,
-        template: `${SLUGKIT_TEMPLATE_PACKAGE_NAME}/${DEFAULT_TEMPLATE_NAME}`,
+        template: DEFAULT_TEMPLATE_NAME,
         generatedAt: new Date().toISOString(),
-        packageMetadata: createGeneratedSitePackageMetadata(DEFAULT_TEMPLATE_METADATA),
+        packageMetadata: createGeneratedSitePackageMetadata(),
     };
     await writeFile(join(directory, ".slugkit-site.json"), `${JSON.stringify(marker, null, 2)}\n`, "utf8");
 }
-function createGeneratedSitePackageMetadata(metadata) {
+function createGeneratedSitePackageMetadata() {
     return {
         template: {
-            packageName: metadata.packageName,
-            name: metadata.name,
-            version: metadata.version,
+            packageName: "zip-artifact",
+            name: DEFAULT_TEMPLATE_NAME,
+            version: "downloaded",
         },
-        packages: { ...metadata.includedSlugkitPackages },
+        packages: { ...GENERATED_SITE_SLUGKIT_DEPENDENCIES },
         advisoryOnly: true,
         migrationNotesUrl: "https://slugkit.com/docs/package-updates",
     };
@@ -421,20 +435,20 @@ async function resolveInitTemplateSource(context, options) {
     if (options.templateUrl !== undefined) {
         return downloadTemplateSite(context, options.templateUrl);
     }
-    if (options.template !== undefined) {
-        return resolveNamedTemplateSource(options.template);
+    if (options.template !== undefined && options.template !== DEFAULT_TEMPLATE_NAME) {
+        throw createInvalidUsageError(`Unsupported template: ${options.template}. Use --template-url for external template zip artifacts.`);
     }
-    const localTemplateDirectory = findTemplateSiteDirectory(context.templateSiteDirectory);
-    if (localTemplateDirectory !== undefined) {
-        return { directory: localTemplateDirectory };
-    }
-    return { directory: getTemplateRoot() };
+    return downloadTemplateSite(context, getDefaultTemplateUrl(context));
 }
-function resolveNamedTemplateSource(template) {
-    if (template === DEFAULT_TEMPLATE_NAME || template === SLUGKIT_TEMPLATE_PACKAGE_NAME) {
-        return { directory: getTemplateRoot() };
+function getDefaultTemplateUrl(context) {
+    if (context.templateAssetBaseUrl !== undefined) {
+        return `${context.templateAssetBaseUrl.replace(/\/+$/u, "")}/slugkit-site-template.zip`;
+    }
+    const environmentUrl = process.env.SLUGKIT_TEMPLATE_URL?.trim();
+    if (environmentUrl !== undefined && environmentUrl !== "") {
+        return environmentUrl;
     }
-    throw createInvalidUsageError(`Unsupported template: ${template}. This CLI currently includes ${DEFAULT_TEMPLATE_NAME}; future releases may resolve external template packages.`);
+    return DEFAULT_TEMPLATE_URL;
 }
 async function downloadTemplateSite(context, templateUrl) {
     let parsedUrl;
@@ -453,17 +467,42 @@ async function downloadTemplateSite(context, templateUrl) {
         throw new CliError(`Failed to download Slugkit template from ${parsedUrl.toString()}: HTTP ${response.status}`, ExitCode.NetworkError);
     }
     const tempDirectory = await mkdtemp(join(tmpdir(), "slug-template-"));
-    const archivePath = join(tempDirectory, "template.tgz");
+    const archivePath = join(tempDirectory, "template.zip");
     const extractDirectory = join(tempDirectory, "template");
     await mkdir(extractDirectory, { recursive: true });
     await writeFile(archivePath, Buffer.from(await response.arrayBuffer()));
-    await extractTarball({ file: archivePath, cwd: extractDirectory });
-    await assertTemplateSiteDirectory(extractDirectory);
+    new AdmZip(archivePath).extractAllTo(extractDirectory, true);
+    const templateDirectory = await findExtractedTemplateDirectory(extractDirectory);
+    await assertTemplateSiteDirectory(templateDirectory);
     return {
-        directory: extractDirectory,
+        directory: templateDirectory,
         cleanup: () => rm(tempDirectory, { force: true, recursive: true }),
     };
 }
+async function findExtractedTemplateDirectory(extractDirectory) {
+    if (await isTemplateSiteDirectory(extractDirectory)) {
+        return extractDirectory;
+    }
+    const entries = await readdir(extractDirectory, { withFileTypes: true });
+    for (const entry of entries) {
+        if (!entry.isDirectory())
+            continue;
+        const candidate = join(extractDirectory, entry.name);
+        if (await isTemplateSiteDirectory(candidate)) {
+            return candidate;
+        }
+    }
+    return extractDirectory;
+}
+async function isTemplateSiteDirectory(directory) {
+    try {
+        const packageJson = JSON.parse(await readFile(join(directory, "package.json"), "utf8"));
+        return packageJson.name === SITE_TEMPLATE_PACKAGE_NAME;
+    }
+    catch {
+        return false;
+    }
+}
 async function assertTemplateSiteDirectory(directory) {
     try {
         const packageJson = JSON.parse(await readFile(join(directory, "package.json"), "utf8"));
@@ -478,32 +517,6 @@ async function assertTemplateSiteDirectory(directory) {
         throw createInvalidUsageError(`Template directory is not readable: ${directory}`);
     }
 }
-function findTemplateSiteDirectory(templateSiteDirectory) {
-    if (templateSiteDirectory !== undefined) {
-        if (templateSiteDirectory === null) {
-            return undefined;
-        }
-        return templateSiteDirectory;
-    }
-    const commandsDirectory = dirname(fileURLToPath(import.meta.url));
-    const candidates = [
-        resolve(commandsDirectory, "..", "..", "template", "site"),
-        resolve(process.cwd(), "template", "site"),
-        resolve(process.cwd(), "..", "template", "site"),
-    ];
-    for (const candidate of candidates) {
-        try {
-            const packageJson = JSON.parse(readFileSync(join(candidate, "package.json"), "utf8"));
-            if (packageJson.name === SITE_TEMPLATE_PACKAGE_NAME) {
-                return candidate;
-            }
-        }
-        catch {
-            // Try the next candidate.
-        }
-    }
-    return undefined;
-}
 function isNodeErrorWithCode(error, code) {
     return isRecord(error) && error.code === code;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@evcraddock/slug-cli",
-  "version": "0.6.3",
+  "version": "0.6.4",
   "description": "Command-line tool for Slugkit sites.",
   "private": false,
   "type": "module",
@@ -27,7 +27,6 @@
   },
   "dependencies": {
     "@evcraddock/slug-core": "0.1.1",
-    "@evcraddock/slug-template": "0.1.3",
-    "tar": "^7.5.16"
+    "adm-zip": "^0.5.18"
   }
 }