create-ailk 0.27.0 → 0.28.1

package/dist/programmatic.js

@@ -39,6 +39,7 @@ import { classifyModules, isAddition } from "./lib/module-tier.js";
 import { normalizeModules } from "./module-architecture.js";
 import { writePaidSections } from "./paid-sections.js";
 import { RECOGNIZED_SHAPES, RESERVED_SHAPES, } from "./parse-args.js";
+import { RemoveModuleRefusedError, removeModuleFromScaffold, } from "./remove-module.js";
 import { writeSpokeFlowsReadme } from "./seed-flows.js";
 import { SITE_CHROME_PATH, renderSiteChrome, resolveSiteChrome, } from "./site-chrome.js";
 import { SITE_FONTS_PATH, renderSiteFonts } from "./site-fonts.js";
@@ -47,7 +48,7 @@ import { SITE_ROSTER_PATH, planHomeRecord, planSiteManifestDesign, readSiteRoste
 import { SPOKE_CHECKOUT_TEMPLATE_PATHS, dropSpokeCheckoutDependency, spokeCheckoutSite, spokeEnvRowOptions, writeSpokeCheckoutSlice, } from "./spoke-checkout.js";
 import { GATEABLE_SURFACES, MODULE_SURFACES, NAV_CONFIG_PATH, excludedRoutePaths, isUnservedSurfaceContent, renderNavConfig, resolveSurfaces, } from "./surfaces.js";
 import { syncRoutes } from "./sync-routes.js";
-import { BASE_LAYER_DIR, SHAPE_STARTERS, TEMPLATE_MANIFESTS, TemplateError, mergeRoster, resolveTemplate, resolveTemplateLineage, rosterDeclares, templateDelivery, templateTreeDir, } from "./template-manifest.js";
+import { BASE_LAYER_DIR, SHAPE_STARTERS, isOwnTree, shippedManifestPath, TEMPLATE_MANIFESTS, TemplateError, mergeRoster, resolveTemplate, resolveTemplateLineage, rosterDeclares, templateDelivery, templateTreeDir, } from "./template-manifest.js";
 import { TEMPLATE_RECORD_PATH, isRecordable, planTemplateRecord, serializeTemplateRecord, sha256Hex, } from "./template-record.js";
 import { SPOKE_ONLY_FILES, TopologyError, applySpokeTransforms, isSpokeExcluded, normalizeHubSignInUrl, normalizeHubUrl, readSiteTopology, spokeExclusions, spokeDestination, spokeModuleRefusal, spokeModules, writeHubOriginEnv, writeHubSignInEnv, } from "./topology.js";
 import { validateTarget } from "./validate.js";
@@ -134,7 +135,9 @@ function resolveShapeTemplate(shape) {
         ...Object.values(TEMPLATE_MANIFESTS),
         ...Object.values(SHAPE_STARTERS),
     ].filter((manifest) => manifest.shape === shape);
-    const free = ofShape.filter((manifest) => templateDelivery(manifest) === "free");
+    // #10040 D8 — a shape's Free starter is its public site: an alias with no
+    // `marketing` in `requires` (the hub starter) is never a shape's starter.
+    const free = ofShape.filter((manifest) => templateDelivery(manifest) === "free" && manifest.requires.includes("marketing"));
     if (free.length === 0) {
         const names = ofShape.map((manifest) => manifest.name).join(", ");
         throw new TemplateError(`shape "${shape}" has no Free starter yet — its page list lands with #6743. Templates built on this shape: ${names || "none"}.`);
@@ -373,9 +376,12 @@ export async function scaffold(opts) {
     if (opts.template !== undefined) {
         // Alias run — untouched (NFR-4): the union line and its
         // resolvePaidModules({ …, templateName }) call stay exactly as they were.
+        // #10040 D8 — the template's `requires` is unioned in, so the only
+        // alias a `["marketing"]` default changed was one that deliberately
+        // lacks it (the hub starter); every existing alias lists `marketing`.
         modules = normalizeModules([
             ...(template?.requires ?? []),
-            ...(opts.modules ?? ["marketing"]),
+            ...(opts.modules ?? []),
         ]);
         const { paid } = classifyModules(modules);
         bundles = await resolvePaidModules({
@@ -656,7 +662,11 @@ export async function scaffold(opts) {
                     sourceRoot,
                     targetDir: result.targetDir,
                     name: template.name,
-                    templateRequires: template.requires,
+                    // #10040 D8 — a treeless alias installs its SHAPE's tree, whose
+                    // ailk-template.json declares the shape starter's requires.
+                    templateRequires: isOwnTree(template.name)
+                        ? template.requires
+                        : (SHAPE_STARTERS[template.shape]?.requires ?? template.requires),
                     templateExtends: template.extends,
                     versions,
                     markers,
@@ -698,6 +708,13 @@ export async function scaffold(opts) {
         // #6939 — the scaffold's DESIGN.md is the design it wears, not the one
         // its template layer shipped; the site's own header lines are kept.
         writeFileSync(join(result.targetDir, "DESIGN.md"), planDesignMd(resolvedDesign.dir, result.targetDir));
+        // #10040 D8 — a treeless alias (`ownTree: false`) ships no DESIGN.md of
+        // its own, so the kept line would still name the overlay's `_base`;
+        // the scaffold's provenance is the alias.
+        if (template !== undefined && !isOwnTree(template.name)) {
+            const designPath = join(result.targetDir, "DESIGN.md");
+            writeFileSync(designPath, readFileSync(designPath, "utf8").replace(/^([ \t]*)Source template:.*$/m, (_m, indent) => `${indent}Source template: ${template.name}`));
+        }
         // #7720 D4.1 — the faces the design sources, beside site-chrome.ts. A
         // design that sources none renders the overlay's committed default, so
         // the file is left as the template tree wrote it.
@@ -828,6 +845,11 @@ export async function scaffold(opts) {
     // plain alias or `--modules`-keep run, and is never inferred from `modules`.
     // A scaffold with no manifest (the bare overlay, `saas-product`) writes none.
     if (template !== undefined) {
+        // #10040 D8 — a treeless alias installed its SHAPE's tree, whose record
+        // names the shape; the site's roster of record is the alias's own.
+        if (!isOwnTree(template.name)) {
+            writeFileSync(join(result.targetDir, SITE_ROSTER_PATH), readFileSync(join(SITE_TEMPLATES_DIR, shippedManifestPath(template.name)), "utf8"));
+        }
         const roster = readSiteRoster(result.targetDir);
         if (roster !== undefined) {
             writeFileSync(join(result.targetDir, roster.path), planSiteManifest({
@@ -858,6 +880,23 @@ export async function scaffold(opts) {
     // #7536 D3 — the registry follows `apps/web/package.json`, which a module
     // bundle's `patches` (and the template layer) just finished editing.
     writePaidSections(result.targetDir);
+    // #10040 D8 — a template whose resolved module set lacks `marketing` (the
+    // hub starter) is the same scaffold with the public tree removed: one code
+    // path, the command's. Runs after the record and the manifest are written,
+    // so the removed paths retire exactly as they would on a live site.
+    if (template !== undefined && !modules.includes("marketing")) {
+        removeModuleFromScaffold({
+            targetDir: result.targetDir,
+            moduleName: "marketing",
+            force: true,
+            fromScaffold: true,
+            templatesDir: TEMPLATES_DIR,
+            siteTemplatesDir: SITE_TEMPLATES_DIR,
+            versions,
+            markers,
+            version: markers["CREATE_AILK_VERSION"] ?? "",
+        });
+    }
     // #7874 D9 — a spoke's rows again, now the module bundles and the template
     // layer are in the scan; it appends only what those layers added. A
     // commerce spoke also declares what the checkout package reads (#7838 D9).
@@ -1234,6 +1273,36 @@ export async function addModule(opts) {
         siteTemplatesDir: SITE_TEMPLATES_DIR,
     });
 }
+/**
+ * Take a module's public pages off an already-scaffolded site in place
+ * (`create-ailk remove-module`, #10040) — the thin package-rooted wrapper
+ * around `remove-module.ts`'s `removeModuleFromScaffold`, the `addModule`
+ * split. Every refusal is the core's and throws before the first write.
+ */
+export function removeModule(opts) {
+    const targetAbs = resolve(opts.targetDir);
+    if (!existsSync(targetAbs)) {
+        throw new Error(`remove-module target does not exist: ${targetAbs}. Point remove-module at an already-scaffolded repo.`);
+    }
+    if (!statSync(targetAbs).isDirectory()) {
+        throw new Error(`remove-module target is not a directory: ${targetAbs}`);
+    }
+    const markers = buildScaffoldMarkers(basename(targetAbs));
+    const version = markers["CREATE_AILK_VERSION"];
+    if (version === undefined || version === "") {
+        throw new RemoveModuleRefusedError("CREATE_AILK_VERSION is unset: a retired record row needs the running version.");
+    }
+    return removeModuleFromScaffold({
+        targetDir: targetAbs,
+        moduleName: opts.moduleName,
+        ...(opts.force !== undefined ? { force: opts.force } : {}),
+        templatesDir: TEMPLATES_DIR,
+        siteTemplatesDir: SITE_TEMPLATES_DIR,
+        versions: readVersionMap(),
+        markers,
+        version,
+    });
+}
 /** Re-exported so the CLI can name the file it wrote without duplicating it. */
 export { CATALOG_TARGET_PATH };
 /**

package/dist/remove-module.d.ts

@@ -0,0 +1,98 @@
+import type { InstallReportRow } from "./lib/extract-module-bundle.js";
+import { type ModuleName } from "./parse-args.js";
+import type { MarkerMap, WorkspaceVersionMap } from "./substitute.js";
+/** The modules `remove-module` takes (decision 6). */
+export declare const REMOVABLE_MODULES: readonly ModuleName[];
+/**
+ * The `content/<locale>/<type>/` directories a site keeps when it drops
+ * `marketing`: the seeds of the kept legal pages (`HUB_KEPT_ROUTES`).
+ */
+export declare const HUB_KEPT_CONTENT_TYPES: readonly string[];
+/** A refusal the CLI exits 2 on — the same shape `add-module` throws. */
+export declare class RemoveModuleRefusedError extends Error {
+    readonly exitCode = 2;
+    constructor(message: string);
+}
+export interface RemoveModuleOptions {
+    /** The already-scaffolded site. */
+    targetDir: string;
+    moduleName: ModuleName;
+    /** Delete the site's own edits too (decision 5). */
+    force?: boolean;
+    /** The package's `templates/` snapshot — the record's template copies and the overlay seeds. */
+    templatesDir: string;
+    /** The package's `site-templates/` dir — the base layer and the template tree's seeds. */
+    siteTemplatesDir: string;
+    /** Workspace version map, for rendering a template copy the way `copyTemplate` did. */
+    versions: WorkspaceVersionMap;
+    /** The scaffold's marker map (`buildScaffoldMarkers`). */
+    markers: MarkerMap;
+    /** The running create-ailk version — the `version` a new record row carries. */
+    version: string;
+    /**
+     * `scaffold()`'s own call (#10040 D8): the header already lacks the module
+     * because the resolved set never had it, so the carry check is skipped.
+     */
+    fromScaffold?: boolean;
+}
+export interface RemoveModuleResult {
+    targetDir: string;
+    moduleName: ModuleName;
+    /** The module set `architecture.yaml` now declares. */
+    modules: ModuleName[];
+    /** Every path deleted, site-relative, sorted. */
+    removed: string[];
+    /** The deleted paths now carried as retired rows in the record (D1). */
+    retired: string[];
+    /** The site's own files the run deleted under `--force`. */
+    forced: string[];
+    /** Removal-set files kept because a kept file imports them, with the importer. */
+    keptImports: Array<{
+        path: string;
+        importedBy: string;
+    }>;
+    /** Config patches a removed module left in place, for the owner to reverse by hand (D7). */
+    review: Array<{
+        path: string;
+        reason: string;
+    }>;
+    /** Generated files rewritten (nav, flags, registries) or left for review (an edited nav). */
+    report: InstallReportRow[];
+    roster: {
+        state: "trimmed" | "unchanged" | "none";
+        dropped: string[];
+        path: string;
+    };
+}
+/** The directories `remove-module marketing` removes: the public route tree and the non-legal seeds. */
+export declare function marketingRemovalDirs(targetDir: string): string[];
+/**
+ * The removal-set files a KEPT file imports — kept with their own imports,
+ * to a fixed point (#10040). `apps/web/app/[locale]/contact/` holds helpers
+ * the locale layout and `lib/in-page-magnet.ts` import beside its page;
+ * deleting them with the page breaks the kept tree's type-check. Only
+ * `apps/web` code is scanned; a kept file is any `.ts`/`.tsx` outside the
+ * removal set (node_modules, .next and dist excluded).
+ */
+export declare function importedByKept(targetDir: string, removal: string[]): Map<string, string>;
+/** The paths a module's removal deletes, site-relative, only those on disk. */
+export declare function removalSet(targetDir: string, moduleName: ModuleName): string[];
+/**
+ * Removes one module from a scaffolded site. Every refusal is raised before
+ * the first write; the writes that follow (delete → record → architecture →
+ * manifest → generated files) are not atomic, but each is idempotent on its
+ * own inputs, so a run interrupted mid-way converges on the next invocation —
+ * `--force` is then needed only if the first run needed it.
+ */
+export declare function removeModuleFromScaffold(opts: RemoveModuleOptions): RemoveModuleResult;
+/** The report `remove-module` prints. */
+export declare function formatRemoveModuleReport(result: RemoveModuleResult): string;
+export interface RemoveModuleArgs {
+    module: ModuleName | undefined;
+    target: string | undefined;
+    force: boolean;
+    help: boolean;
+}
+export declare const REMOVE_MODULE_HELP = "create-ailk remove-module \u2014 take a module's public pages off an existing site.\n\nUsage:\n  create-ailk remove-module <module> [<target-dir>] [--force]\n\nArguments:\n  <module>                 marketing or docs-blog. Nothing else can be removed.\n  <target-dir>             An already-scaffolded repo (contains\n                           architecture.yaml). Defaults to the current dir.\n\nOptions:\n  --force                  Also delete files the site has edited or authored\n                           inside the module's pages. Without it, such files\n                           are listed and nothing is removed.\n  --help, -h               Print this message.\n\nDeletes the module's route directories and seed content, drops the module\nfrom .ailk-site-manifest.json and architecture.yaml, and records every removed\napp file as retired in .ailk-template-files.json, so create-ailk update and\nsync-routes never bring it back. A site without marketing redirects / to\n/account, serves robots.txt disallowing everything, sends noindex on every page\nand answers 404 at sitemap.xml and llms.txt. Removing marketing while docs-blog\nis installed is refused: remove docs-blog first.\n";
+/** Parse the argv AFTER the `remove-module` word, the `parseAddModuleArgs` shape. */
+export declare function parseRemoveModuleArgs(argv: string[]): RemoveModuleArgs;