docspack 0.0.1 → 0.1.1

package/dist/init/detect.js

@@ -0,0 +1,120 @@
+import { readdir, readFile, stat } from "node:fs/promises";
+import { join } from "node:path";
+const DOC_DIRS = ["docs", "documentation", "website/docs", "content/docs", "src/content/docs"];
+const OPENAPI_FILES = [
+    "openapi.json",
+    "api/openapi.json",
+    "spec/openapi.json",
+    "docs/openapi.json",
+];
+const LLMS_TXT_FILES = ["llms.txt", "public/llms.txt", "static/llms.txt"];
+const MARKDOWN = /\.(md|mdx|markdown)$/i;
+export async function detectProject(cwd) {
+    const manifest = await readJson(join(cwd, "package.json"));
+    const name = typeof manifest?.name === "string" ? manifest.name : undefined;
+    const version = typeof manifest?.version === "string" ? manifest.version : undefined;
+    const license = typeof manifest?.license === "string" ? manifest.license : undefined;
+    const docs = await findDocsDir(cwd);
+    const openapi = await findOpenApi(cwd);
+    const llmsTxt = await findFirstFile(cwd, LLMS_TXT_FILES);
+    const repository = await gitRemote(cwd);
+    return {
+        ...(name === undefined ? {} : { libraryName: name }),
+        ...(version === undefined ? {} : { libraryVersion: version }),
+        ...(docs === undefined ? {} : { docsDir: docs.dir, docsFiles: docs.files }),
+        ...(openapi === undefined ? {} : { openapi }),
+        ...(llmsTxt === undefined ? {} : { llmsTxt }),
+        ...(repository === undefined ? {} : { repository }),
+        ...(license === undefined ? {} : { license: await detectLicense(cwd, license) }),
+        packageManager: await detectPackageManager(cwd),
+        workspace: manifest?.workspaces !== undefined || (await exists(join(cwd, "pnpm-workspace.yaml"))),
+    };
+}
+async function findDocsDir(cwd) {
+    for (const candidate of DOC_DIRS) {
+        const dir = join(cwd, candidate);
+        const files = await countMarkdown(dir);
+        if (files > 0)
+            return { dir: candidate, files };
+    }
+    return undefined;
+}
+async function countMarkdown(dir) {
+    let found;
+    try {
+        found = await readdir(dir, { recursive: true, withFileTypes: true });
+    }
+    catch {
+        return 0;
+    }
+    return found.filter((entry) => entry.isFile() && MARKDOWN.test(entry.name)).length;
+}
+/** Only counts as an OpenAPI document if it actually declares itself as one. */
+async function findOpenApi(cwd) {
+    for (const candidate of OPENAPI_FILES) {
+        const parsed = await readJson(join(cwd, candidate));
+        if (parsed === undefined)
+            continue;
+        if (typeof parsed.openapi === "string" || typeof parsed.swagger === "string")
+            return candidate;
+    }
+    return undefined;
+}
+async function findFirstFile(cwd, candidates) {
+    for (const candidate of candidates) {
+        if (await exists(join(cwd, candidate)))
+            return candidate;
+    }
+    return undefined;
+}
+async function detectPackageManager(cwd) {
+    if (await exists(join(cwd, "pnpm-lock.yaml")))
+        return "pnpm";
+    if ((await exists(join(cwd, "bun.lock"))) || (await exists(join(cwd, "bun.lockb"))))
+        return "bun";
+    if (await exists(join(cwd, "yarn.lock")))
+        return "yarn";
+    return "npm";
+}
+async function detectLicense(cwd, declared) {
+    return declared.length > 0 || (await exists(join(cwd, "LICENSE"))) ? declared : declared;
+}
+/** Reads the origin URL straight out of .git/config rather than spawning git. */
+async function gitRemote(cwd) {
+    let config;
+    try {
+        config = await readFile(join(cwd, ".git", "config"), "utf8");
+    }
+    catch {
+        return undefined;
+    }
+    const section = /\[remote "origin"\]([\s\S]*?)(?:\n\[|$)/.exec(config);
+    const url = section?.[1] === undefined ? undefined : /url\s*=\s*(\S+)/.exec(section[1])?.[1];
+    if (url === undefined)
+        return undefined;
+    const ssh = /^git@([^:]+):(.+?)(?:\.git)?$/.exec(url);
+    if (ssh?.[1] !== undefined && ssh[2] !== undefined)
+        return `https://${ssh[1]}/${ssh[2]}`;
+    return url.replace(/\.git$/, "");
+}
+async function readJson(path) {
+    try {
+        const parsed = JSON.parse(await readFile(path, "utf8"));
+        return typeof parsed === "object" && parsed !== null
+            ? parsed
+            : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+async function exists(path) {
+    try {
+        await stat(path);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+//# sourceMappingURL=detect.js.map

package/dist/init/detect.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"detect.js","sourceRoot":"","sources":["../../src/init/detect.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC3D,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAkBjC,MAAM,QAAQ,GAAG,CAAC,MAAM,EAAE,eAAe,EAAE,cAAc,EAAE,cAAc,EAAE,kBAAkB,CAAC,CAAC;AAC/F,MAAM,aAAa,GAAG;IACpB,cAAc;IACd,kBAAkB;IAClB,mBAAmB;IACnB,mBAAmB;CACpB,CAAC;AACF,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,iBAAiB,EAAE,iBAAiB,CAAC,CAAC;AAC1E,MAAM,QAAQ,GAAG,uBAAuB,CAAC;AAEzC,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAW;IAC7C,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC;IAC3D,MAAM,IAAI,GAAG,OAAO,QAAQ,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5E,MAAM,OAAO,GAAG,OAAO,QAAQ,EAAE,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IACrF,MAAM,OAAO,GAAG,OAAO,QAAQ,EAAE,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAErF,MAAM,IAAI,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACzD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,GAAG,CAAC,CAAC;IAExC,OAAO;QACL,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC;QACpD,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,OAAO,EAAE,CAAC;QAC7D,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;QAC3E,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;QAC7C,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC;QAC7C,GAAG,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC;QACnD,GAAG,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC,GAAG,EAAE,OAAO,CAAC,EAAE,CAAC;QAChF,cAAc,EAAE,MAAM,oBAAoB,CAAC,GAAG,CAAC;QAC/C,SAAS,EACP,QAAQ,EAAE,UAAU,KAAK,SAAS,IAAI,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC,CAAC;KACzF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,WAAW,CAAC,GAAW;IACpC,KAAK,MAAM,SAAS,IAAI,QAAQ,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACjC,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,KAAK,GAAG,CAAC;YAAE,OAAO,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IAClD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAW;IACtC,IAAI,KAAe,CAAC;IACpB,IAAI,CAAC;QACH,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;IACvE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;AACrF,CAAC;AAED,gFAAgF;AAChF,KAAK,UAAU,WAAW,CAAC,GAAW;IACpC,KAAK,MAAM,SAAS,IAAI,aAAa,EAAE,CAAC;QACtC,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;QACpD,IAAI,MAAM,KAAK,SAAS;YAAE,SAAS;QACnC,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ,IAAI,OAAO,MAAM,CAAC,OAAO,KAAK,QAAQ;YAAE,OAAO,SAAS,CAAC;IACjG,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,aAAa,CAC1B,GAAW,EACX,UAA6B;IAE7B,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAAE,OAAO,SAAS,CAAC;IAC3D,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,oBAAoB,CAAC,GAAW;IAC7C,IAAI,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IAC7D,IAAI,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC;QAAE,OAAO,KAAK,CAAC;IAClG,IAAI,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAAE,OAAO,MAAM,CAAC;IACxD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,KAAK,UAAU,aAAa,CAAC,GAAW,EAAE,QAAgB;IACxD,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC3F,CAAC;AAED,iFAAiF;AACjF,KAAK,UAAU,SAAS,CAAC,GAAW;IAClC,IAAI,MAAc,CAAC;IACnB,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;IAC/D,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,OAAO,GAAG,yCAAyC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvE,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAC7F,IAAI,GAAG,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAExC,MAAM,GAAG,GAAG,+BAA+B,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACtD,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,SAAS;QAAE,OAAO,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACzF,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACnC,CAAC;AAED,KAAK,UAAU,QAAQ,CAAC,IAAY;IAClC,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;QACjE,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI;YAClD,CAAC,CAAE,MAAkC;YACrC,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,KAAK,UAAU,MAAM,CAAC,IAAY;IAChC,IAAI,CAAC;QACH,MAAM,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC"}

package/dist/init/plan.d.ts

@@ -0,0 +1,43 @@
+import type { Detected } from "./detect.js";
+export type InitMode = "standalone" | "in-repo";
+export type InitTemplate = "full" | "minimal";
+export type InputKind = "from" | "openapi" | "mirror" | "seeded";
+export interface InitOptions {
+    readonly name?: string;
+    readonly version?: string;
+    readonly out?: string;
+    readonly mode?: InitMode;
+    readonly from?: string;
+    readonly openapi?: string;
+    readonly mirror?: string;
+    readonly community?: boolean;
+    readonly workflow?: boolean;
+    readonly template?: InitTemplate;
+    /** Version of docspack recorded as the package's devDependency. */
+    readonly docspackVersion: string;
+}
+export interface PlannedFile {
+    /** POSIX-style path relative to the package directory. */
+    readonly path: string;
+    readonly contents: string;
+}
+export interface InitPlan {
+    readonly name: string;
+    readonly version: string;
+    /** Package directory, relative to where init was run. */
+    readonly dir: string;
+    readonly input: {
+        readonly kind: InputKind;
+        readonly value: string;
+    };
+    readonly files: readonly PlannedFile[];
+    readonly notes: readonly string[];
+}
+/**
+ * Computes the whole scaffold from options and what was detected. Pure on purpose: `--dry-run`
+ * prints exactly what a real run would write, and tests can assert the file set without a disk.
+ */
+export declare function planInit(options: InitOptions, detected: Detected): InitPlan;
+/** `@acme/sdk` becomes `@acme/docspack`; an unscoped `acme` becomes `@acme/docspack`. */
+export declare function proposePackageName(detected: Detected, community: boolean): string;
+//# sourceMappingURL=plan.d.ts.map

package/dist/init/plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../src/init/plan.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5C,MAAM,MAAM,QAAQ,GAAG,YAAY,GAAG,SAAS,CAAC;AAChD,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,SAAS,CAAC;AAC9C,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEjE,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;IAC5B,QAAQ,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACjC,mEAAmE;IACnE,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED,MAAM,WAAW,WAAW;IAC1B,0DAA0D;IAC1D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,yDAAyD;IACzD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE;QAAE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC;IACrE,QAAQ,CAAC,KAAK,EAAE,SAAS,WAAW,EAAE,CAAC;IACvC,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;CACnC;AAID;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAiE3E;AAED,yFAAyF;AACzF,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,GAAG,MAAM,CAiBjF"}

package/dist/init/plan.js

@@ -0,0 +1,145 @@
+import { posix } from "node:path";
+import { DocspackError } from "../errors.js";
+import { isCommunityPackage, isDocsPackage } from "../spec.js";
+import { docSeeds, gitignore, packageJson, readme, workflow } from "./templates.js";
+const SLUG = /[^a-z0-9-]+/g;
+/**
+ * Computes the whole scaffold from options and what was detected. Pure on purpose: `--dry-run`
+ * prints exactly what a real run would write, and tests can assert the file set without a disk.
+ */
+export function planInit(options, detected) {
+    const community = options.community === true || (options.name !== undefined && isCommunityPackage(options.name));
+    const name = options.name ?? proposePackageName(detected, community);
+    assertPackageName(name);
+    const notes = [];
+    const version = options.version ?? detected.libraryVersion ?? "0.1.0";
+    if (options.version === undefined && detected.libraryVersion === undefined) {
+        notes.push("No library version was detected, so the package starts at 0.1.0.");
+    }
+    else if (options.version === undefined && detected.libraryVersion !== undefined) {
+        notes.push(`Version ${version} matches ${detected.libraryName ?? "the surrounding package"}; keep them in step on every release.`);
+    }
+    const mode = options.mode ?? "standalone";
+    const dir = options.out ?? (mode === "in-repo" ? "packages/docspack" : "docspack");
+    const input = resolveInput(options, detected, dir, notes);
+    const template = options.template ?? "full";
+    const files = [
+        {
+            path: "package.json",
+            contents: packageJson({
+                name,
+                version,
+                ...(detected.libraryName === undefined ? {} : { libraryName: detected.libraryName }),
+                ...(detected.repository === undefined ? {} : { repository: detected.repository }),
+                ...(detected.license === undefined ? {} : { license: detected.license }),
+                build: buildConfigFor(input),
+                docspackVersion: options.docspackVersion,
+            }),
+        },
+        { path: ".gitignore", contents: gitignore() },
+    ];
+    if (template === "full") {
+        files.push({
+            path: "README.md",
+            contents: readme(name, detected.libraryName),
+        });
+    }
+    if (input.kind === "seeded") {
+        files.push(...docSeeds(detected.libraryName ?? name));
+        notes.push("docs/ was seeded with three templates. Replace the TODO markers before publishing; `docspack doctor --strict` fails while they remain.");
+    }
+    if (options.workflow === true) {
+        files.push({
+            path: ".github/workflows/publish-docspack.yml",
+            contents: workflow(name, workflowArgs(input)),
+        });
+        notes.push("The release workflow needs an NPM_TOKEN secret with publish rights to the scope.");
+    }
+    if (!community) {
+        const scope = name.slice(0, name.indexOf("/"));
+        notes.push(`Publishing to ${scope} requires owning that npm scope.`);
+    }
+    return { name, version, dir, input, files, notes };
+}
+/** `@acme/sdk` becomes `@acme/docspack`; an unscoped `acme` becomes `@acme/docspack`. */
+export function proposePackageName(detected, community) {
+    const library = detected.libraryName;
+    if (library === undefined) {
+        throw new DocspackError("Could not work out a package name", {
+            hint: "Run inside a project with a package.json, or pass --name @acme/docspack.",
+        });
+    }
+    const bare = library.startsWith("@") ? (library.split("/")[1] ?? library.slice(1)) : library;
+    const slug = bare
+        .toLowerCase()
+        .replace(SLUG, "-")
+        .replace(/^-+|-+$/g, "");
+    if (community)
+        return `@docspack-community/${slug}`;
+    const scope = library.startsWith("@") ? library.slice(1, library.indexOf("/")) : slug;
+    return `@${scope}/docspack`;
+}
+function assertPackageName(name) {
+    if (!isDocsPackage(name)) {
+        throw new DocspackError(`"${name}" is not a name docspack will discover`, {
+            hint: "Use @vendor/docspack for a package you own, or @docspack-community/<name> otherwise.",
+        });
+    }
+}
+function resolveInput(options, detected, dir, notes) {
+    const chosen = [options.from, options.openapi, options.mirror].filter((value) => value !== undefined);
+    if (chosen.length > 1) {
+        throw new DocspackError("Choose one input: --from, --openapi or --mirror");
+    }
+    if (options.mirror !== undefined) {
+        if (!isCommunityPackage(options.name ?? "")) {
+            notes.push("A mirror republishes someone else's documentation; publish it under @docspack-community rather than the vendor's scope.");
+        }
+        return { kind: "mirror", value: options.mirror };
+    }
+    if (options.openapi !== undefined)
+        return { kind: "openapi", value: relativeToPackage(options.openapi, dir) };
+    if (options.from !== undefined)
+        return { kind: "from", value: relativeToPackage(options.from, dir) };
+    if (detected.docsDir !== undefined) {
+        notes.push(`Found ${detected.docsFiles} Markdown files in ${detected.docsDir}/.`);
+        return { kind: "from", value: relativeToPackage(detected.docsDir, dir) };
+    }
+    if (detected.openapi !== undefined) {
+        notes.push(`Found an OpenAPI document at ${detected.openapi}.`);
+        return { kind: "openapi", value: relativeToPackage(detected.openapi, dir) };
+    }
+    return { kind: "seeded", value: "./docs" };
+}
+/**
+ * Build inputs are recorded relative to the package directory, because that is where
+ * `docspack build` runs from.
+ */
+function relativeToPackage(target, dir) {
+    if (/^https?:\/\//i.test(target))
+        return target;
+    const normalized = target.replace(/\\/g, "/").replace(/^\.\//, "");
+    const relative = posix.relative(dir.replace(/\\/g, "/"), normalized);
+    return relative.startsWith(".") ? relative : `./${relative}`;
+}
+function buildConfigFor(input) {
+    switch (input.kind) {
+        case "openapi":
+            return { openapi: input.value };
+        case "mirror":
+            return { source: input.value };
+        default:
+            return { from: input.value, maxChunkTokens: 800 };
+    }
+}
+function workflowArgs(input) {
+    switch (input.kind) {
+        case "openapi":
+            return ` --openapi ${input.value}`;
+        case "mirror":
+            return ` ${input.value}`;
+        default:
+            return ` --from ${input.value}`;
+    }
+}
+//# sourceMappingURL=plan.js.map

package/dist/init/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../src/init/plan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAE/D,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAqCpF,MAAM,IAAI,GAAG,cAAc,CAAC;AAE5B;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,OAAoB,EAAE,QAAkB;IAC/D,MAAM,SAAS,GACb,OAAO,CAAC,SAAS,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,kBAAkB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACjG,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACrE,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAExB,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,QAAQ,CAAC,cAAc,IAAI,OAAO,CAAC;IACtE,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QAC3E,KAAK,CAAC,IAAI,CAAC,kEAAkE,CAAC,CAAC;IACjF,CAAC;SAAM,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,QAAQ,CAAC,cAAc,KAAK,SAAS,EAAE,CAAC;QAClF,KAAK,CAAC,IAAI,CACR,WAAW,OAAO,YAAY,QAAQ,CAAC,WAAW,IAAI,yBAAyB,uCAAuC,CACvH,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAa,OAAO,CAAC,IAAI,IAAI,YAAY,CAAC;IACpD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC;IACnF,MAAM,KAAK,GAAG,YAAY,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IAC1D,MAAM,QAAQ,GAAiB,OAAO,CAAC,QAAQ,IAAI,MAAM,CAAC;IAE1D,MAAM,KAAK,GAAkB;QAC3B;YACE,IAAI,EAAE,cAAc;YACpB,QAAQ,EAAE,WAAW,CAAC;gBACpB,IAAI;gBACJ,OAAO;gBACP,GAAG,CAAC,QAAQ,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,WAAW,EAAE,CAAC;gBACpF,GAAG,CAAC,QAAQ,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACjF,GAAG,CAAC,QAAQ,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACxE,KAAK,EAAE,cAAc,CAAC,KAAK,CAAC;gBAC5B,eAAe,EAAE,OAAO,CAAC,eAAe;aACzC,CAAC;SACH;QACD,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,EAAE;KAC9C,CAAC;IAEF,IAAI,QAAQ,KAAK,MAAM,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,WAAW;YACjB,QAAQ,EAAE,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAC;SAC7C,CAAC,CAAC;IACL,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,WAAW,IAAI,IAAI,CAAC,CAAC,CAAC;QACtD,KAAK,CAAC,IAAI,CACR,wIAAwI,CACzI,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC;YACT,IAAI,EAAE,wCAAwC;YAC9C,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC;SAC9C,CAAC,CAAC;QACH,KAAK,CAAC,IAAI,CAAC,kFAAkF,CAAC,CAAC;IACjG,CAAC;IAED,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,iBAAiB,KAAK,kCAAkC,CAAC,CAAC;IACvE,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;AACrD,CAAC;AAED,yFAAyF;AACzF,MAAM,UAAU,kBAAkB,CAAC,QAAkB,EAAE,SAAkB;IACvE,MAAM,OAAO,GAAG,QAAQ,CAAC,WAAW,CAAC;IACrC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,IAAI,aAAa,CAAC,mCAAmC,EAAE;YAC3D,IAAI,EAAE,0EAA0E;SACjF,CAAC,CAAC;IACL,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC7F,MAAM,IAAI,GAAG,IAAI;SACd,WAAW,EAAE;SACb,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC;SAClB,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC3B,IAAI,SAAS;QAAE,OAAO,uBAAuB,IAAI,EAAE,CAAC;IAEpD,MAAM,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACtF,OAAO,IAAI,KAAK,WAAW,CAAC;AAC9B,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAY;IACrC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,aAAa,CAAC,IAAI,IAAI,wCAAwC,EAAE;YACxE,IAAI,EAAE,sFAAsF;SAC7F,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CACnB,OAAoB,EACpB,QAAkB,EAClB,GAAW,EACX,KAAe;IAEf,MAAM,MAAM,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CACnE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAC/B,CAAC;IACF,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,aAAa,CAAC,iDAAiD,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QACjC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CACR,yHAAyH,CAC1H,CAAC;QACJ,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;IACnD,CAAC;IACD,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;QAC/B,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;IAC7E,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;IAEvE,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,SAAS,QAAQ,CAAC,SAAS,sBAAsB,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;QAClF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;IAC3E,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,gCAAgC,QAAQ,CAAC,OAAO,GAAG,CAAC,CAAC;QAChE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,iBAAiB,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;IAC9E,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC7C,CAAC;AAED;;;GAGG;AACH,SAAS,iBAAiB,CAAC,MAAc,EAAE,GAAW;IACpD,IAAI,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC;QAAE,OAAO,MAAM,CAAC;IAChD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;IACnE,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,UAAU,CAAC,CAAC;IACrE,OAAO,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;AAC/D,CAAC;AAED,SAAS,cAAc,CAAC,KAGvB;IACC,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;QAClC,KAAK,QAAQ;YACX,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;QACjC;YACE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,EAAE,CAAC;IACtD,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAyC;IAC7D,QAAQ,KAAK,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,SAAS;YACZ,OAAO,cAAc,KAAK,CAAC,KAAK,EAAE,CAAC;QACrC,KAAK,QAAQ;YACX,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE,CAAC;QAC3B;YACE,OAAO,WAAW,KAAK,CAAC,KAAK,EAAE,CAAC;IACpC,CAAC;AACH,CAAC"}

package/dist/init/run.d.ts

@@ -0,0 +1,28 @@
+import { type BuildResult } from "../build.js";
+import { type DoctorReport } from "../doctor.js";
+import { Prompter } from "../prompt.js";
+import { type Detected } from "./detect.js";
+import { type InitOptions, type InitPlan } from "./plan.js";
+import { type WrittenFile } from "./write.js";
+export interface RunInitOptions extends InitOptions {
+    readonly cwd: string;
+    /** Skip every prompt and use flags plus detected defaults. */
+    readonly yes?: boolean;
+    readonly dryRun?: boolean;
+    readonly force?: boolean;
+    /** Run the first build after scaffolding. Defaults to true. */
+    readonly build?: boolean;
+    readonly prompter?: Prompter;
+    readonly onProgress?: (message: string) => void;
+}
+export interface InitResult {
+    readonly detected: Detected;
+    readonly plan: InitPlan;
+    readonly written: readonly WrittenFile[];
+    readonly build?: BuildResult;
+    readonly doctor?: DoctorReport;
+    readonly cancelled: boolean;
+}
+/** detect → propose → confirm → write → build → doctor. */
+export declare function runInit(options: RunInitOptions): Promise<InitResult>;
+//# sourceMappingURL=run.d.ts.map

package/dist/init/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/init/run.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,WAAW,EAAgB,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,KAAK,YAAY,EAAa,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,QAAQ,EAAgC,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAa,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzD,MAAM,WAAW,cAAe,SAAQ,WAAW;IACjD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,8DAA8D;IAC9D,QAAQ,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC;IACvB,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,+DAA+D;IAC/D,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,QAAQ,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAC7B,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,UAAU;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC;IAC5B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,OAAO,EAAE,SAAS,WAAW,EAAE,CAAC;IACzC,QAAQ,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,MAAM,CAAC,EAAE,YAAY,CAAC;IAC/B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;CAC7B;AAED,2DAA2D;AAC3D,wBAAsB,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,CAoC1E"}

package/dist/init/run.js

@@ -0,0 +1,96 @@
+import { join } from "node:path";
+import { buildPackage } from "../build.js";
+import { runDoctor } from "../doctor.js";
+import { Prompter } from "../prompt.js";
+import { detectProject } from "./detect.js";
+import { planInit, proposePackageName } from "./plan.js";
+import { applyPlan } from "./write.js";
+/** detect → propose → confirm → write → build → doctor. */
+export async function runInit(options) {
+    const detected = await detectProject(options.cwd);
+    const prompter = options.prompter ?? new Prompter();
+    const interactive = options.yes !== true && prompter.interactive;
+    const answers = interactive ? await ask(prompter, options, detected) : options;
+    const plan = planInit(answers, detected);
+    if (interactive) {
+        prompter.note("");
+        for (const note of plan.notes)
+            prompter.note(`  · ${note}`);
+        prompter.note("");
+        if (!(await prompter.confirm(`Write ${plan.files.length} files to ${plan.dir}/?`))) {
+            prompter.close();
+            return { detected, plan, written: [], cancelled: true };
+        }
+        prompter.close();
+    }
+    const written = await applyPlan(options.cwd, plan, {
+        ...(options.force === undefined ? {} : { force: options.force }),
+        ...(options.dryRun === undefined ? {} : { dryRun: options.dryRun }),
+    });
+    if (options.dryRun === true || options.build === false) {
+        return { detected, plan, written, cancelled: false };
+    }
+    const dir = join(options.cwd, plan.dir);
+    const built = await buildPackage({
+        out: dir,
+        ...(options.onProgress === undefined ? {} : { onProgress: options.onProgress }),
+    });
+    const doctor = await runDoctor({ dir });
+    return { detected, plan, written, build: built, doctor, cancelled: false };
+}
+async function ask(prompter, options, detected) {
+    const community = options.community === true;
+    const proposed = options.name ??
+        (detected.libraryName === undefined ? undefined : proposePackageName(detected, community));
+    if (detected.libraryName !== undefined) {
+        const where = [
+            `${detected.libraryName}${detected.libraryVersion === undefined ? "" : `@${detected.libraryVersion}`}`,
+            detected.docsDir === undefined
+                ? undefined
+                : `${detected.docsDir}/ (${detected.docsFiles} files)`,
+            detected.openapi,
+        ].filter((part) => part !== undefined);
+        prompter.note(`Detected  ${where.join(" · ")}\n`);
+    }
+    const name = await prompter.text("Package name", proposed ?? "@acme/docspack");
+    const version = await prompter.text("Version", options.version ?? detected.libraryVersion ?? "0.1.0");
+    const input = await selectInput(prompter, options, detected);
+    const out = await prompter.text("Directory", options.out ?? "docspack");
+    const workflow = await prompter.confirm("Add the release workflow?", options.workflow !== false);
+    return {
+        ...options,
+        name,
+        version,
+        out,
+        workflow,
+        ...input,
+    };
+}
+async function selectInput(prompter, options, detected) {
+    if (options.from !== undefined)
+        return { from: options.from };
+    if (options.openapi !== undefined)
+        return { openapi: options.openapi };
+    if (options.mirror !== undefined)
+        return { mirror: options.mirror };
+    const choices = [];
+    if (detected.docsDir !== undefined) {
+        choices.push({
+            value: { from: detected.docsDir },
+            label: `${detected.docsDir}/`,
+            hint: `${detected.docsFiles} Markdown files`,
+        });
+    }
+    if (detected.openapi !== undefined) {
+        choices.push({
+            value: { openapi: detected.openapi },
+            label: detected.openapi,
+            hint: "one chunk per operation",
+        });
+    }
+    choices.push({ value: {}, label: "start from templates", hint: "seeds docs/ with three files" });
+    if (choices.length === 1)
+        return {};
+    return prompter.select("Documentation source", choices);
+}
+//# sourceMappingURL=run.js.map

package/dist/init/run.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.js","sourceRoot":"","sources":["../../src/init/run.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAoB,YAAY,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAqB,SAAS,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,EAAiB,aAAa,EAAE,MAAM,aAAa,CAAC;AAC3D,OAAO,EAAmC,QAAQ,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAC;AAC1F,OAAO,EAAE,SAAS,EAAoB,MAAM,YAAY,CAAC;AAuBzD,2DAA2D;AAC3D,MAAM,CAAC,KAAK,UAAU,OAAO,CAAC,OAAuB;IACnD,MAAM,QAAQ,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,QAAQ,EAAE,CAAC;IACpD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,KAAK,IAAI,IAAI,QAAQ,CAAC,WAAW,CAAC;IAEjE,MAAM,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;IAC/E,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAEzC,IAAI,WAAW,EAAE,CAAC;QAChB,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClB,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK;YAAE,QAAQ,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QAC5D,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAClB,IAAI,CAAC,CAAC,MAAM,QAAQ,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,KAAK,CAAC,MAAM,aAAa,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC;YACnF,QAAQ,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;QAC1D,CAAC;QACD,QAAQ,CAAC,KAAK,EAAE,CAAC;IACnB,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE;QACjD,GAAG,CAAC,OAAO,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;QAChE,GAAG,CAAC,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;KACpE,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,MAAM,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,KAAK,KAAK,EAAE,CAAC;QACvD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;IACvD,CAAC;IAED,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACxC,MAAM,KAAK,GAAG,MAAM,YAAY,CAAC;QAC/B,GAAG,EAAE,GAAG;QACR,GAAG,CAAC,OAAO,CAAC,UAAU,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC;KAChF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;IAExC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;AAC7E,CAAC;AAED,KAAK,UAAU,GAAG,CAChB,QAAkB,EAClB,OAAuB,EACvB,QAAkB;IAElB,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,KAAK,IAAI,CAAC;IAC7C,MAAM,QAAQ,GACZ,OAAO,CAAC,IAAI;QACZ,CAAC,QAAQ,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;IAE7F,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG;YACZ,GAAG,QAAQ,CAAC,WAAW,GAAG,QAAQ,CAAC,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,cAAc,EAAE,EAAE;YACtG,QAAQ,CAAC,OAAO,KAAK,SAAS;gBAC5B,CAAC,CAAC,SAAS;gBACX,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,MAAM,QAAQ,CAAC,SAAS,SAAS;YACxD,QAAQ,CAAC,OAAO;SACjB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAkB,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;QACvD,QAAQ,CAAC,IAAI,CAAC,aAAa,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,IAAI,gBAAgB,CAAC,CAAC;IAC/E,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,CACjC,SAAS,EACT,OAAO,CAAC,OAAO,IAAI,QAAQ,CAAC,cAAc,IAAI,OAAO,CACtD,CAAC;IAEF,MAAM,KAAK,GAAG,MAAM,WAAW,CAAC,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC7D,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC;IACxE,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,2BAA2B,EAAE,OAAO,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC;IAEjG,OAAO;QACL,GAAG,OAAO;QACV,IAAI;QACJ,OAAO;QACP,GAAG;QACH,QAAQ;QACR,GAAG,KAAK;KACT,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,QAAkB,EAClB,OAAuB,EACvB,QAAkB;IAElB,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;IAC9D,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,CAAC;IACvE,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,CAAC;IAEpE,MAAM,OAAO,GAIP,EAAE,CAAC;IACT,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,CAAC,OAAO,EAAE;YACjC,KAAK,EAAE,GAAG,QAAQ,CAAC,OAAO,GAAG;YAC7B,IAAI,EAAE,GAAG,QAAQ,CAAC,SAAS,iBAAiB;SAC7C,CAAC,CAAC;IACL,CAAC;IACD,IAAI,QAAQ,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE;YACpC,KAAK,EAAE,QAAQ,CAAC,OAAO;YACvB,IAAI,EAAE,yBAAyB;SAChC,CAAC,CAAC;IACL,CAAC;IACD,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,sBAAsB,EAAE,IAAI,EAAE,8BAA8B,EAAE,CAAC,CAAC;IAEjG,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,OAAO,QAAQ,CAAC,MAAM,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;AAC1D,CAAC"}

package/dist/init/templates.d.ts

@@ -0,0 +1,24 @@
+export interface PackageJsonInput {
+    readonly name: string;
+    readonly version: string;
+    readonly libraryName?: string;
+    readonly repository?: string;
+    readonly license?: string;
+    readonly build: Record<string, string | number>;
+    readonly docspackVersion: string;
+}
+/** Marker the doctor looks for, so a half-filled template cannot be published as documentation. */
+export declare const PLACEHOLDER = "TODO:";
+export declare function packageJson(input: PackageJsonInput): string;
+export declare function readme(name: string, libraryName: string | undefined): string;
+export declare function gitignore(): string;
+/**
+ * Three seeds that map onto how retrieval works: one chunk should answer one question. The
+ * guidance in them is what `docspack doctor` checks, so following it keeps the package clean.
+ */
+export declare function docSeeds(subject: string): {
+    path: string;
+    contents: string;
+}[];
+export declare function workflow(name: string, buildArgs: string): string;
+//# sourceMappingURL=templates.d.ts.map

package/dist/init/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/init/templates.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAChD,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;CAClC;AAED,mGAAmG;AACnG,eAAO,MAAM,WAAW,UAAU,CAAC;AAEnC,wBAAgB,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,MAAM,CA8B3D;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,CAkC5E;AAED,wBAAgB,SAAS,IAAI,MAAM,CAKlC;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,EAAE,CAyD9E;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CA4ChE"}