clyops-doc 0.11.0 → 0.12.0

package/dist/model.d.ts

@@ -11,6 +11,7 @@ export type Block = {
     items: {
         term: string;
         text: string;
+        schema?: string;
     }[];
 } | {
     kind: 'h';
@@ -101,6 +102,11 @@ export declare function synopsis(name: string, leaf: Leaf): string;
 export declare function optionLabel(o: SchemaOption): string;
 /** An option's description with its notes, as help annotates it (spec section 7). */
 export declare function optionText(o: SchemaOption): string;
+/**
+ * A `json:SCHEMA` input's schema as indented JSON, without `$schema`; none for an input
+ * without one or one that only references a URL, which `accepts:` already names.
+ */
+export declare function schemaText(item: SchemaOption | SchemaArgument): string | undefined;
 /** The first sentence of a description (its first line at most), for the NAME line. */
 export declare function firstSentence(text: string): string;
 /** Today in UTC, or SOURCE_DATE_EPOCH's date for reproducible builds. */

package/dist/model.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAA4B,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE9H,mGAAmG;AACnG,MAAM,MAAM,KAAK,GACb;IAAoC,IAAI,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7D;IAAkD,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7E;IAAqD,IAAI,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,GAC1G;IAAqD,IAAI,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9E;IAA4F,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,CAAC;AAE3J,yCAAyC;AACzC,MAAM,WAAW,OAAO;IACtB,kEAAkE;IAClE,KAAK,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,6DAA6D;AAC7D,MAAM,WAAW,GAAG;IAClB,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,wGAAwG;IACxG,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,uDAAuD;AACvD,MAAM,WAAW,UAAU;IACzB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8GAA8G;IAC9G,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,8FAA8F;AAC9F,MAAM,WAAW,IAAI;IACnB,+FAA+F;IAC/F,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,8DAA8D;IAC9D,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,oCAAoC;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,kCAAkC;IAClC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;IAC3B,mCAAmC;IACnC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAC5B,iFAAiF;IACjF,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,kDAAkD;IAClD,WAAW,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;IACnD,+CAA+C;IAC/C,gBAAgB,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACnF;AAED,kGAAkG;AAClG,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,CAiC7C;AAED,0DAA0D;AAC1D,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,CAIzD;AAED,uEAAuE;AACvE,wBAAgB,WAAW,CAAC,CAAC,EAAE,YAAY,GAAG,MAAM,CAGnD;AAED,qFAAqF;AACrF,wBAAgB,UAAU,CAAC,CAAC,EAAE,YAAY,GAAG,MAAM,CASlD;AAkDD,uFAAuF;AACvF,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAIlD;AAED,yEAAyE;AACzE,wBAAgB,WAAW,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,MAAM,CAIxE;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,GAAG,CAkFnE;AAqBD,yFAAyF;AACzF,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAM,EAAO,GAAG,MAAM,CAEnE;AAED,sGAAsG;AACtG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,CAQ7D;AAED,oEAAoE;AACpE,MAAM,WAAW,SAAS;IACxB,oEAAoE;IACpE,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,IAAI,GAAE,UAAe,GAAG,GAAG,CAe5G"}
+{"version":3,"file":"model.d.ts","sourceRoot":"","sources":["../src/model.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,cAAc,EAA4B,YAAY,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE9H,mGAAmG;AACnG,MAAM,MAAM,KAAK,GACb;IAAoC,IAAI,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7D;IAAkD,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC7E;IAAiH,IAAI,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,GACvL;IAAqD,IAAI,EAAE,GAAG,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC9E;IAA4F,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,CAAC;AAE3J,yCAAyC;AACzC,MAAM,WAAW,OAAO;IACtB,kEAAkE;IAClE,KAAK,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,MAAM,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,6DAA6D;AAC7D,MAAM,WAAW,GAAG;IAClB,sEAAsE;IACtE,IAAI,EAAE,MAAM,CAAC;IACb,wGAAwG;IACxG,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,OAAO,EAAE,MAAM,CAAC;IAChB,8BAA8B;IAC9B,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB;AAED,uDAAuD;AACvD,MAAM,WAAW,UAAU;IACzB,+DAA+D;IAC/D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8BAA8B;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,8GAA8G;IAC9G,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,8FAA8F;AAC9F,MAAM,WAAW,IAAI;IACnB,+FAA+F;IAC/F,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,mCAAmC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,4BAA4B;IAC5B,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,8DAA8D;IAC9D,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,oCAAoC;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,kCAAkC;IAClC,KAAK,EAAE,YAAY,GAAG,IAAI,CAAC;IAC3B,mCAAmC;IACnC,MAAM,EAAE,YAAY,GAAG,IAAI,CAAC;IAC5B,iFAAiF;IACjF,KAAK,EAAE,UAAU,EAAE,CAAC;IACpB,kDAAkD;IAClD,WAAW,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,EAAE,CAAA;KAAE,EAAE,CAAC;IACnD,+CAA+C;IAC/C,gBAAgB,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACnF;AAED,kGAAkG;AAClG,wBAAgB,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,CAiC7C;AAED,0DAA0D;AAC1D,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,CAIzD;AAED,uEAAuE;AACvE,wBAAgB,WAAW,CAAC,CAAC,EAAE,YAAY,GAAG,MAAM,CAGnD;AAED,qFAAqF;AACrF,wBAAgB,UAAU,CAAC,CAAC,EAAE,YAAY,GAAG,MAAM,CASlD;AAUD;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,YAAY,GAAG,cAAc,GAAG,MAAM,GAAG,SAAS,CAQlF;AA+CD,uFAAuF;AACvF,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAIlD;AAED,yEAAyE;AACzE,wBAAgB,WAAW,CAAC,GAAG,GAAE,MAAM,CAAC,UAAwB,GAAG,MAAM,CAIxE;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,GAAE,UAAe,GAAG,GAAG,CAkFnE;AAqBD,yFAAyF;AACzF,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,GAAE,MAAM,EAAO,GAAG,MAAM,CAEnE;AAED,sGAAsG;AACtG,wBAAgB,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,CAQ7D;AAED,oEAAoE;AACpE,MAAM,WAAW,SAAS;IACxB,oEAAoE;IACpE,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,8BAA8B;IAC9B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,IAAI,GAAE,UAAe,GAAG,GAAG,CAe5G"}

package/dist/model.js

@@ -78,6 +78,26 @@ function argumentText(a) {
         notes.push(`accepts: ${describeRule(a.validation)}`);
     return notes.length ? `${a.description}${a.description ? ' ' : ''}(${notes.join('; ')})` : a.description;
 }
+/**
+ * A `json:SCHEMA` input's schema as indented JSON, without `$schema`; none for an input
+ * without one or one that only references a URL, which `accepts:` already names.
+ */
+export function schemaText(item) {
+    const schema = item.schema;
+    if (!item.validation.startsWith('json:') || schema === null || schema === undefined)
+        return undefined;
+    if (typeof schema !== 'object' || Array.isArray(schema))
+        return JSON.stringify(schema);
+    const { $schema: _version, ...rest } = schema;
+    const keys = Object.keys(rest);
+    if (keys.length === 0 || (keys.length === 1 && keys[0] === '$ref'))
+        return undefined;
+    return JSON.stringify(rest, null, 2);
+}
+const withSchema = (item, term, text) => {
+    const schema = schemaText(item);
+    return schema ? { term, text, schema } : { term, text };
+};
 function stream(s) {
     return [s.description, s.contentType && `(${s.contentType})`].filter(Boolean).join(' ') || 'Declared, without a description.';
 }
@@ -108,8 +128,8 @@ function leafParts(leaf) {
         ...leaf.requiredCommands.map((r) => `Needs ${r.command} on PATH: ${r.description}${r.installHint ? ` (${r.installHint})` : ''}.`),
     ].filter(Boolean);
     return {
-        args: dl(leaf.arguments.map((a) => ({ term: a.isVariadic ? `<${a.name}...>` : `<${a.name}>`, text: argumentText(a) }))),
-        options: dl(leaf.options.filter((o) => o.name !== 'help').map((o) => ({ term: optionLabel(o), text: optionText(o) }))),
+        args: dl(leaf.arguments.map((a) => withSchema(a, a.isVariadic ? `<${a.name}...>` : `<${a.name}>`, argumentText(a)))),
+        options: dl(leaf.options.filter((o) => o.name !== 'help').map((o) => withSchema(o, optionLabel(o), optionText(o)))),
         streams: dl(streams),
         notes: notes.map((text) => ({ kind: 'p', text })),
     };

package/dist/render.js

@@ -24,7 +24,7 @@ function manBlock(b) {
         case 'pre':
             return ['.PP', '.nf', '.RS 4', troff(b.text), '.RE', '.fi'];
         case 'dl':
-            return b.items.flatMap((i) => ['.TP', `\\fB${troff(i.term)}\\fR`, troff(i.text)]);
+            return b.items.flatMap((i) => ['.TP', `\\fB${troff(i.term)}\\fR`, troff(i.text), ...(i.schema ? ['.RS', '.PP', 'JSON Schema:', '.nf', troff(i.schema), '.fi', '.RE'] : [])]);
         case 'refs':
             return ['.PP', ...b.items.map((r, n) => `.BR ${arg(r.page)} ${arg(`(${r.section})${n < b.items.length - 1 ? ',' : ''}`)}`)];
     }
@@ -72,10 +72,10 @@ function code(text) {
     const fence = '`'.repeat(run);
     return run > 1 ? `${fence} ${text} ${fence}` : `${fence}${text}${fence}`;
 }
-function fenced(text) {
+function fenced(text, info = '') {
     const run = Math.max(2, ...(text.match(/`+/g) ?? []).map((m) => m.length)) + 1;
     const fence = '`'.repeat(run);
-    return [fence, text, fence];
+    return [fence + info, text, fence];
 }
 function markdownBlock(b) {
     switch (b.kind) {
@@ -86,7 +86,7 @@ function markdownBlock(b) {
         case 'pre':
             return [...fenced(b.text), ''];
         case 'dl':
-            return [...b.items.map((i) => `- ${code(i.term)}: ${markdownText(i.text)}`), ''];
+            return [...b.items.flatMap((i) => [`- ${code(i.term)}: ${markdownText(i.text)}`, ...(i.schema ? ['', '  JSON Schema:', '', ...fenced(i.schema, 'json').join('\n').split('\n').map((l) => `  ${l}`), ''] : [])]), ''];
         case 'refs':
             return [b.items.map((r) => `[${markdownText(`${r.page}(${r.section})`)}](${encodeURI(r.page)}.md)`).join(', '), ''];
     }
@@ -123,7 +123,7 @@ function htmlBlock(b) {
         case 'pre':
             return `<pre><code>${htmlText(b.text)}</code></pre>`;
         case 'dl':
-            return `<dl>\n${b.items.map((i) => `<dt><code>${htmlText(i.term)}</code></dt>\n<dd>${htmlText(i.text)}</dd>`).join('\n')}\n</dl>`;
+            return `<dl>\n${b.items.map((i) => `<dt><code>${htmlText(i.term)}</code></dt>\n<dd>${htmlText(i.text)}${i.schema ? `\n<details><summary>JSON Schema</summary><pre><code>${htmlText(i.schema)}</code></pre></details>` : ''}</dd>`).join('\n')}\n</dl>`;
         case 'refs':
             return `<p>${b.items.map((r) => `<a href="${htmlText(encodeURI(r.page))}.html"><code>${htmlText(r.page)}</code>(${htmlText(r.section)})</a>`).join(', ')}</p>`;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clyops-doc",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Documentation (man pages, Markdown, HTML) from any clyops tool's --help-json-schema.",
   "license": "MIT",
   "repository": {
@@ -36,9 +36,9 @@
     "src"
   ],
   "dependencies": {
-    "clyops": "0.11.0",
-    "clyops-schema": "0.11.0",
-    "clyops-tools": "0.11.0"
+    "clyops": "0.12.0",
+    "clyops-schema": "0.12.0",
+    "clyops-tools": "0.12.0"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",

package/src/model.ts

@@ -7,7 +7,7 @@ import type { Schema, SchemaArgument, SchemaBody, SchemaConfig, SchemaOption, Sc
 export type Block =
   | { /** A paragraph of plain text. */ kind: 'p'; text: string }
   | { /** Text shown as is, in a fixed-width font. */ kind: 'pre'; text: string }
-  | { /** A list of terms, each with its description. */ kind: 'dl'; items: { term: string; text: string }[] }
+  | { /** A list of terms, each with its description and, for a `json:SCHEMA` input, its schema as indented JSON. */ kind: 'dl'; items: { term: string; text: string; schema?: string }[] }
   | { /** A subsection heading, e.g. one per command. */ kind: 'h'; text: string }
   | { /** Other pages, as SEE ALSO lists them: `page(section)`, linked in Markdown and HTML. */ kind: 'refs'; items: { page: string; section: string }[] };
 
@@ -148,6 +148,25 @@ function argumentText(a: SchemaArgument): string {
   return notes.length ? `${a.description}${a.description ? ' ' : ''}(${notes.join('; ')})` : a.description;
 }
 
+/**
+ * A `json:SCHEMA` input's schema as indented JSON, without `$schema`; none for an input
+ * without one or one that only references a URL, which `accepts:` already names.
+ */
+export function schemaText(item: SchemaOption | SchemaArgument): string | undefined {
+  const schema = item.schema;
+  if (!item.validation.startsWith('json:') || schema === null || schema === undefined) return undefined;
+  if (typeof schema !== 'object' || Array.isArray(schema)) return JSON.stringify(schema);
+  const { $schema: _version, ...rest } = schema as Record<string, unknown>;
+  const keys = Object.keys(rest);
+  if (keys.length === 0 || (keys.length === 1 && keys[0] === '$ref')) return undefined;
+  return JSON.stringify(rest, null, 2);
+}
+
+const withSchema = (item: SchemaOption | SchemaArgument, term: string, text: string) => {
+  const schema = schemaText(item);
+  return schema ? { term, text, schema } : { term, text };
+};
+
 function stream(s: SchemaStream): string {
   return [s.description, s.contentType && `(${s.contentType})`].filter(Boolean).join(' ') || 'Declared, without a description.';
 }
@@ -167,7 +186,7 @@ const EFFECTS: Record<string, string> = {
 
 /** A leaf's parts: its arguments, options and streams as definition lists, and notes as text. */
 function leafParts(leaf: Leaf): { args?: Block; options?: Block; streams?: Block; notes: Block[] } {
-  const dl = (items: { term: string; text: string }[]): Block | undefined => (items.length ? { kind: 'dl', items } : undefined);
+  const dl = (items: { term: string; text: string; schema?: string }[]): Block | undefined => (items.length ? { kind: 'dl', items } : undefined);
   const streams = [
     ...(leaf.stdin ? [{ term: 'stdin', text: stream(leaf.stdin) }] : []),
     ...(leaf.stdout ? [{ term: 'stdout', text: stream(leaf.stdout) }] : []),
@@ -181,8 +200,8 @@ function leafParts(leaf: Leaf): { args?: Block; options?: Block; streams?: Block
     ...leaf.requiredCommands.map((r) => `Needs ${r.command} on PATH: ${r.description}${r.installHint ? ` (${r.installHint})` : ''}.`),
   ].filter(Boolean);
   return {
-    args: dl(leaf.arguments.map((a) => ({ term: a.isVariadic ? `<${a.name}...>` : `<${a.name}>`, text: argumentText(a) }))),
-    options: dl(leaf.options.filter((o) => o.name !== 'help').map((o) => ({ term: optionLabel(o), text: optionText(o) }))),
+    args: dl(leaf.arguments.map((a) => withSchema(a, a.isVariadic ? `<${a.name}...>` : `<${a.name}>`, argumentText(a)))),
+    options: dl(leaf.options.filter((o) => o.name !== 'help').map((o) => withSchema(o, optionLabel(o), optionText(o)))),
     streams: dl(streams),
     notes: notes.map((text) => ({ kind: 'p', text })),
   };

package/src/render.ts

@@ -33,7 +33,7 @@ function manBlock(b: Block): string[] {
     case 'pre':
       return ['.PP', '.nf', '.RS 4', troff(b.text), '.RE', '.fi'];
     case 'dl':
-      return b.items.flatMap((i) => ['.TP', `\\fB${troff(i.term)}\\fR`, troff(i.text)]);
+      return b.items.flatMap((i) => ['.TP', `\\fB${troff(i.term)}\\fR`, troff(i.text), ...(i.schema ? ['.RS', '.PP', 'JSON Schema:', '.nf', troff(i.schema), '.fi', '.RE'] : [])]);
     case 'refs':
       return ['.PP', ...b.items.map((r, n) => `.BR ${arg(r.page)} ${arg(`(${r.section})${n < b.items.length - 1 ? ',' : ''}`)}`)];
   }
@@ -86,10 +86,10 @@ function code(text: string): string {
   return run > 1 ? `${fence} ${text} ${fence}` : `${fence}${text}${fence}`;
 }
 
-function fenced(text: string): string[] {
+function fenced(text: string, info = ''): string[] {
   const run = Math.max(2, ...(text.match(/`+/g) ?? []).map((m) => m.length)) + 1;
   const fence = '`'.repeat(run);
-  return [fence, text, fence];
+  return [fence + info, text, fence];
 }
 
 function markdownBlock(b: Block): string[] {
@@ -101,7 +101,7 @@ function markdownBlock(b: Block): string[] {
     case 'pre':
       return [...fenced(b.text), ''];
     case 'dl':
-      return [...b.items.map((i) => `- ${code(i.term)}: ${markdownText(i.text)}`), ''];
+      return [...b.items.flatMap((i) => [`- ${code(i.term)}: ${markdownText(i.text)}`, ...(i.schema ? ['', '  JSON Schema:', '', ...fenced(i.schema, 'json').join('\n').split('\n').map((l) => `  ${l}`), ''] : [])]), ''];
     case 'refs':
       return [b.items.map((r) => `[${markdownText(`${r.page}(${r.section})`)}](${encodeURI(r.page)}.md)`).join(', '), ''];
   }
@@ -142,7 +142,7 @@ function htmlBlock(b: Block): string {
     case 'pre':
       return `<pre><code>${htmlText(b.text)}</code></pre>`;
     case 'dl':
-      return `<dl>\n${b.items.map((i) => `<dt><code>${htmlText(i.term)}</code></dt>\n<dd>${htmlText(i.text)}</dd>`).join('\n')}\n</dl>`;
+      return `<dl>\n${b.items.map((i) => `<dt><code>${htmlText(i.term)}</code></dt>\n<dd>${htmlText(i.text)}${i.schema ? `\n<details><summary>JSON Schema</summary><pre><code>${htmlText(i.schema)}</code></pre></details>` : ''}</dd>`).join('\n')}\n</dl>`;
     case 'refs':
       return `<p>${b.items.map((r) => `<a href="${htmlText(encodeURI(r.page))}.html"><code>${htmlText(r.page)}</code>(${htmlText(r.section)})</a>`).join(', ')}</p>`;
   }