argsbarg 3.3.2 → 3.3.4

package/CHANGELOG.md

@@ -7,8 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [3.3.2] - 2026-06-21
+## [3.3.4] - 2026-06-21
+
+
+## [3.3.3] - 2026-06-21
+
+### Added
 
+- **`docs --save`** — write one docs subcommand to `./docs/`; argsbarg-generated markdown (`mcp`, `api`, `skill`) is prefixed with a `Generated by … docs … --save` HTML comment.
+
+### Removed
+
+- **`docs all`** — use individual subcommands (`docs readme`, `docs schema`, `docs api`, …) or `--save` per topic.
 
 ## [3.3.2] - 2026-06-21
 
@@ -252,8 +262,9 @@ const cli = { ... } satisfies CliProgram;  // or : CliProgram
 - Migrate schemas: rename every `children` property to **`commands`**; move positional definitions to **`CliPositional`** objects on `positionals` and strip `positional` / `argMin` / `argMax` from flag definitions under `options` (flags only carry `name`, `description`, `kind`, and optional `shortName`).
 - Imports: use `CliPositional` where needed; replace `CliOptionDef` with `CliOption` or `CliPositional` as appropriate.
 
-[Unreleased]: https://github.com/bdombro/bun-argsbarg/compare/v3.3.2...HEAD
-[3.3.2]: https://github.com/bdombro/bun-argsbarg/releases/tag/v3.3.2
+[Unreleased]: https://github.com/bdombro/bun-argsbarg/compare/v3.3.4...HEAD
+[3.3.4]: https://github.com/bdombro/bun-argsbarg/releases/tag/v3.3.4
+[3.3.3]: https://github.com/bdombro/bun-argsbarg/releases/tag/v3.3.3
 [3.3.2]: https://github.com/bdombro/bun-argsbarg/releases/tag/v3.3.2
 [3.3.1]: https://github.com/bdombro/bun-argsbarg/releases/tag/v3.3.1
 [3.3.0]: https://github.com/bdombro/bun-argsbarg/releases/tag/v3.3.0

package/docs/bundled-docs.md

@@ -30,8 +30,9 @@ myapp docs architecture
 myapp docs schema       # full command tree as JSON
 myapp docs api          # command tree as markdown
 myapp docs skill        # generated Cursor SKILL.md
-myapp docs all          # all user topics; includes auto mcp when MCP enabled
 myapp docs mcp          # auto-generated when mcpServer.enabled
+myapp docs readme --save   # write ./docs/readme.md
+myapp docs schema --save   # write ./docs/schema.json
 ```
 
 ## Configuration
@@ -43,7 +44,7 @@ myapp docs mcp          # auto-generated when mcpServer.enabled
 | `defaultTopic` | first key in `topics` | `fallbackCommand` for bare `myapp docs` |
 | `topics` | *(required)* | Topic key → `{ text, description? }` |
 
-Reserved topic keys in `topics`: **`mcp`**, **`all`**, **`schema`**, **`api`**, **`skill`** (supplied by the built-in).
+Reserved topic keys in `topics`: **`mcp`**, **`all`**, **`schema`**, **`api`**, **`skill`** (reserved — use the matching `docs <name>` subcommand instead).
 
 When `description` is omitted on a topic, ArgsBarg generates leaf help (`readme` → "Print README (user guide).").
 
@@ -89,3 +90,16 @@ All `docs` subcommands are hidden from MCP `tools/list` (`mcpTool: { enabled: fa
 | `mcp` | Callable tools + schema resource |
 
 Do not declare a top-level command named **`docs`** when `docs.enabled` is `true` — it is reserved.
+
+## Save to disk (`--save`)
+
+Pass **`--save`** on `docs` or any docs subcommand to write files under **`./docs/`** (relative to the current working directory). Each saved path is printed on stdout.
+
+| Command | Output |
+| --- | --- |
+| `docs readme --save` | `./docs/readme.md` |
+| `docs schema --save` | `./docs/schema.json` |
+| `docs api --save` | `./docs/api.md` |
+| `docs skill --save` | `./docs/skill.md` |
+
+Argsbarg-generated markdown (`mcp`, `api`, `skill`) includes a `Generated by … docs … --save` HTML comment (`skill` places it after YAML frontmatter so parsers still work). Consumer topic files and `schema.json` are written as-is.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "argsbarg",
-  "version": "3.3.2",
+  "version": "3.3.4",
   "type": "module",
   "engines": {
     "bun": ">=1.3"

package/src/docs/builtin.ts

@@ -1,4 +1,4 @@
-import { CliFallbackMode, type CliLeaf, type CliProgram, type CliRouter } from "../types.ts";
+import { CliFallbackMode, CliOptionKind, type CliLeaf, type CliOption, type CliProgram, type CliRouter } from "../types.ts";
 import {
   DOCS_ROUTER_DESCRIPTION,
   docsEffectiveDefaultTopic,
@@ -8,14 +8,30 @@ import {
   docsUserTopicKeys,
   printDocsTopic,
 } from "./resolve.ts";
+import { saveDocsTopic } from "./save.ts";
+
+const DOCS_SAVE_OPTION: CliOption = {
+  name: "save",
+  description: "Write documentation to ./docs/.",
+  kind: CliOptionKind.Presence,
+};
+
+function runDocsTopic(program: CliProgram, topic: string, ctx: { hasFlag(name: string): boolean }): void {
+  if (ctx.hasFlag("save")) {
+    process.stdout.write(`${saveDocsTopic(program, topic)}\n`);
+    return;
+  }
+  printDocsTopic(program, topic);
+}
 
 function docsLeaf(program: CliProgram, key: string, description: string): CliLeaf {
   return {
     key,
     description,
+    options: [DOCS_SAVE_OPTION],
     mcpTool: { enabled: false },
-    handler: () => {
-      printDocsTopic(program, key);
+    handler: (ctx) => {
+      runDocsTopic(program, key, ctx);
     },
   };
 }
@@ -40,12 +56,12 @@ export function cliBuiltinDocsGroup(program: CliProgram): CliRouter {
     docsLeaf(program, "schema", "Print the full command tree as JSON."),
     docsLeaf(program, "api", "Print the command tree as markdown."),
     docsLeaf(program, "skill", "Print generated Cursor SKILL.md content."),
-    docsLeaf(program, "all", "Print all bundled documentation combined."),
   );
 
   return {
     key: "docs",
     description: docs.description ?? DOCS_ROUTER_DESCRIPTION,
+    options: [DOCS_SAVE_OPTION],
     fallbackCommand: docsEffectiveDefaultTopic(docs),
     fallbackMode: CliFallbackMode.MissingOnly,
     commands: leaves,

package/src/docs/docs.test.ts

@@ -1,11 +1,29 @@
-import { expect, test } from "bun:test";
+import { describe, expect, test, beforeEach, afterEach } from "bun:test";
+import { mkdtempSync, readFileSync, rmSync } from "node:fs";
+import { join } from "node:path";
+import { tmpdir } from "node:os";
 import { cliPresentationRoot } from "../builtins/presentation.ts";
 import { completionBashScript } from "../completion.ts";
 import { cliInvoke } from "../index.ts";
 import type { CliProgram } from "../types.ts";
 import { cliValidateProgram } from "../validate.ts";
-import { combineAllDocs, docsEffectiveDefaultTopic } from "./resolve.ts";
+import { docsEffectiveDefaultTopic } from "./resolve.ts";
 import { generateMcpGuide } from "./mcp-guide.ts";
+import { saveDocsTopic } from "./save.ts";
+
+let workDir: string;
+let prevCwd: string;
+
+beforeEach(() => {
+  workDir = mkdtempSync(join(tmpdir(), "argsbarg-docs-save-"));
+  prevCwd = process.cwd();
+  process.chdir(workDir);
+});
+
+afterEach(() => {
+  process.chdir(prevCwd);
+  rmSync(workDir, { recursive: true, force: true });
+});
 
 function docsFixture(mcp = true): CliProgram {
   return {
@@ -86,6 +104,11 @@ test("docs mcp when MCP enabled", async () => {
   expect(result.stdout).toContain("myapp mcp");
 });
 
+test("docs rejects unknown subcommand", async () => {
+  const result = await cliInvoke(docsFixture(), ["docs", "all"]);
+  expect(result.exitCode).not.toBe(0);
+});
+
 test("docs mcp absent from router when MCP disabled", async () => {
   const root = docsFixture(false);
   const presentation = cliPresentationRoot(root);
@@ -98,14 +121,6 @@ test("docs mcp absent from router when MCP disabled", async () => {
   expect(result.exitCode).not.toBe(0);
 });
 
-test("docs all concatenates user topics and mcp", () => {
-  const program = docsFixture(true);
-  const combined = combineAllDocs(program);
-  expect(combined).toContain("Hello README");
-  expect(combined).toContain("Architecture");
-  expect(combined).toContain("MCP server (myapp)");
-});
-
 test("presentation includes docs subtree", () => {
   const presentation = cliPresentationRoot(docsFixture());
   const docsNode = presentation.commands.find((c) => c.key === "docs");
@@ -165,3 +180,50 @@ test("generateMcpGuide includes schema URI", () => {
   const guide = generateMcpGuide(docsFixture(true));
   expect(guide).toContain("myapp://schema");
 });
+
+test("docs --save writes topic file", async () => {
+  const result = await cliInvoke(docsFixture(), ["docs", "readme", "--save"]);
+  expect(result.exitCode).toBe(0);
+  expect(result.stdout.trim()).toBe("docs/readme.md");
+  const text = readFileSync(join(workDir, "docs/readme.md"), "utf8");
+  expect(text).toContain("Hello README");
+  expect(text).not.toContain("Generated by");
+});
+
+test("docs api --save prepends generated hint", async () => {
+  const result = await cliInvoke(docsFixture(), ["docs", "api", "--save"]);
+  expect(result.exitCode).toBe(0);
+  const text = readFileSync(join(workDir, "docs/api.md"), "utf8");
+  expect(text.startsWith("<!-- Generated by myapp docs api --save; do not edit. -->\n\n")).toBe(
+    true,
+  );
+  expect(text).toContain("CLI API reference");
+});
+
+test("docs skill --save keeps frontmatter first", async () => {
+  const result = await cliInvoke(docsFixture(), ["docs", "skill", "--save"]);
+  expect(result.exitCode).toBe(0);
+  const text = readFileSync(join(workDir, "docs/skill.md"), "utf8");
+  expect(text.startsWith("---\n")).toBe(true);
+  expect(text).toContain("name: myapp");
+  const hint = "<!-- Generated by myapp docs skill --save; do not edit. -->";
+  expect(text.indexOf(hint)).toBeGreaterThan(text.indexOf("---\n", 4));
+});
+
+test("docs schema --save writes JSON file", async () => {
+  const result = await cliInvoke(docsFixture(), ["docs", "schema", "--save"]);
+  expect(result.exitCode).toBe(0);
+  expect(result.stdout.trim()).toBe("docs/schema.json");
+  const text = readFileSync(join(workDir, "docs/schema.json"), "utf8");
+  expect(text).not.toContain("Generated by");
+  const schema = JSON.parse(text);
+  expect(schema.key).toBe("myapp");
+});
+
+test("saveDocsTopic returns relative path", () => {
+  const path = saveDocsTopic(docsFixture(), "api");
+  expect(path).toBe("docs/api.md");
+  const text = readFileSync(join(workDir, "docs/api.md"), "utf8");
+  expect(text).toContain("<!-- Generated by myapp docs api --save; do not edit. -->");
+  expect(text).toContain("CLI API reference");
+});

package/src/docs/resolve.ts

@@ -51,16 +51,6 @@ export function docsTopicDescription(key: string, custom?: string): string {
   return `Print ${label} documentation.`;
 }
 
-/** Ordered keys for `docs all` (user topics, then auto `mcp` when enabled). */
-export function docsPrintOrder(program: CliProgram): string[] {
-  const docs = program.docs!;
-  const order = docsUserTopicKeys(docs);
-  if (docsIncludesMcpTopic(program)) {
-    order.push("mcp");
-  }
-  return order;
-}
-
 /** Markdown body for one docs topic key. */
 export function docsTopicText(program: CliProgram, topic: string): string {
   const docs = program.docs!;
@@ -77,43 +67,22 @@ export function docsTopicText(program: CliProgram, topic: string): string {
   return entry.text;
 }
 
-/** All bundled docs concatenated with horizontal rules. */
-export function combineAllDocs(program: CliProgram): string {
-  return docsPrintOrder(program)
-    .map((key) => docsTopicText(program, key).trim())
-    .join("\n\n---\n\n");
-}
-
-/** Writes CLI schema JSON to stdout (`docs schema`). */
-export function printDocsSchema(program: CliProgram): void {
-  process.stdout.write(cliSchemaJson(program));
-}
-
-/** Writes markdown API reference to stdout (`docs api`). */
-export function printDocsApi(program: CliProgram): void {
-  process.stdout.write(generateApiGuide(program));
-}
-
-/** Writes generated Cursor SKILL.md to stdout (`docs skill`). */
-export function printDocsSkill(program: CliProgram): void {
-  const bundle = generateSkillBundle(program, "cursor");
-  process.stdout.write(`${bundle.skillMd}\n`);
-}
-
-/** Writes one docs topic (or `all`) to stdout. */
-export function printDocsTopic(program: CliProgram, topic: string): void {
+/** Full file body for a docs topic (stdout or `--save`). */
+export function docsTopicContent(program: CliProgram, topic: string): string {
   if (topic === "schema") {
-    printDocsSchema(program);
-    return;
+    return cliSchemaJson(program);
   }
   if (topic === "api") {
-    printDocsApi(program);
-    return;
+    return generateApiGuide(program);
   }
   if (topic === "skill") {
-    printDocsSkill(program);
-    return;
+    return `${generateSkillBundle(program, "cursor").skillMd}\n`;
   }
-  const content = topic === "all" ? combineAllDocs(program) : docsTopicText(program, topic);
-  process.stdout.write(`${content}\n`);
+  const text = docsTopicText(program, topic);
+  return text.endsWith("\n") ? text : `${text}\n`;
+}
+
+/** Writes one docs topic to stdout. */
+export function printDocsTopic(program: CliProgram, topic: string): void {
+  process.stdout.write(docsTopicContent(program, topic));
 }

package/src/docs/save.ts

@@ -0,0 +1,66 @@
+import { mkdirSync, writeFileSync } from "node:fs";
+import { join } from "node:path";
+import type { CliProgram } from "../types.ts";
+import { docsTopicContent } from "./resolve.ts";
+
+/** Relative output directory for `docs --save`. */
+export const DOCS_SAVE_DIR = "docs";
+
+/** Builtin docs topics generated by argsbarg (not consumer `docs.topics`). */
+export const DOCS_GENERATED_SAVE_TOPICS = ["mcp", "api", "skill"] as const;
+
+/** Whether `--save` should prepend a generated-file hint (argsbarg writers only). */
+export function docsTopicIsGeneratedByArgsbarg(topic: string): boolean {
+  return (DOCS_GENERATED_SAVE_TOPICS as readonly string[]).includes(topic);
+}
+
+/** HTML comment for generated markdown saved with `--save`. */
+export function docsSaveGeneratedHint(program: CliProgram, topic: string): string {
+  return `<!-- Generated by ${program.key} docs ${topic} --save; do not edit. -->\n\n`;
+}
+
+const SKILL_FRONTMATTER_RE = /^---\r?\n[\s\S]*?\r?\n---\r?\n/;
+
+/** Inserts save hint without breaking YAML frontmatter (`docs skill`). */
+export function applySaveGeneratedHint(program: CliProgram, topic: string, content: string): string {
+  if (!docsTopicIsGeneratedByArgsbarg(topic)) {
+    return content;
+  }
+  const hint = docsSaveGeneratedHint(program, topic);
+  if (topic === "skill") {
+    const match = content.match(SKILL_FRONTMATTER_RE);
+    if (match) {
+      return `${match[0]}${hint}${content.slice(match[0].length)}`;
+    }
+  }
+  return `${hint}${content}`;
+}
+
+/** File body for `--save` (hint on argsbarg-generated markdown only). */
+export function docsTopicContentForSave(program: CliProgram, topic: string): string {
+  return applySaveGeneratedHint(program, topic, docsTopicContent(program, topic));
+}
+
+/** Filename for a saved docs topic. */
+export function docsSaveFilename(topic: string): string {
+  if (topic === "schema") {
+    return "schema.json";
+  }
+  return `${topic}.md`;
+}
+
+/** Relative path under cwd for a saved docs topic. */
+export function docsSaveRelativePath(topic: string): string {
+  return join(DOCS_SAVE_DIR, docsSaveFilename(topic));
+}
+
+/** Writes one docs topic under `./docs/`; returns relative path written. */
+export function saveDocsTopic(program: CliProgram, topic: string): string {
+  const dir = join(process.cwd(), DOCS_SAVE_DIR);
+  mkdirSync(dir, { recursive: true });
+
+  const rel = docsSaveRelativePath(topic);
+  const abs = join(process.cwd(), rel);
+  writeFileSync(abs, docsTopicContentForSave(program, topic), "utf8");
+  return rel;
+}