politty 0.2.2 → 0.3.1

package/dist/docs/index.d.cts

@@ -11,7 +11,53 @@ import * as fs from "node:fs";
  */
 declare function resolveLazyCommand(cmd: AnyCommand | (() => Promise<AnyCommand>)): Promise<AnyCommand>;
 //#endregion
+//#region src/docs/render-args.d.ts
+/**
+ * Args shape type (Record of string keys to Zod schemas)
+ * This matches the typical structure of `commonArgs`, `workspaceArgs`, etc.
+ */
+type ArgsShape = Record<string, z.ZodType>;
+/**
+ * Options for rendering args table
+ */
+type ArgsTableOptions = {
+  /** Columns to include in the table (default: all columns) */columns?: ("option" | "alias" | "description" | "required" | "default" | "env")[];
+};
+/**
+ * Render args definition as a markdown options table
+ *
+ * This function takes raw args definitions (like `commonArgs`) and
+ * renders them as a markdown table suitable for documentation.
+ *
+ * @example
+ * import { renderArgsTable } from "politty/docs";
+ * import { commonArgs, workspaceArgs } from "./args";
+ *
+ * const table = renderArgsTable({
+ *   ...commonArgs,
+ *   ...workspaceArgs,
+ * });
+ * // | Option | Alias | Description | Default |
+ * // |--------|-------|-------------|---------|
+ * // | `--env-file <ENV_FILE>` | `-e` | Path to environment file | - |
+ * // ...
+ *
+ * @param args - Args shape (Record of string keys to Zod schemas with arg() metadata)
+ * @param options - Rendering options
+ * @returns Rendered markdown table string
+ */
+declare function renderArgsTable(args: ArgsShape, options?: ArgsTableOptions): string;
+//#endregion
 //#region src/docs/types.d.ts
+/** Heading level for markdown headings (1-6) */
+type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+/**
+ * Options for rendering command index
+ */
+type CommandIndexOptions = {
+  /** Base heading level (default: 3, which renders as ###) */headingLevel?: HeadingLevel; /** Only include leaf commands (commands without subcommands). Default: true */
+  leafOnly?: boolean;
+};
 /**
  * Command information for rendering
  */
@@ -214,7 +260,7 @@ type SimpleRenderFunction = (context: SimpleRenderContext) => string;
  */
 interface DefaultRendererOptions {
   /** Heading level (default: 1) */
-  headingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
+  headingLevel?: HeadingLevel;
   /** Option display style */
   optionStyle?: "table" | "list";
   /** Generate anchor links to subcommands */
@@ -238,6 +284,26 @@ interface DefaultRendererOptions {
   /** Custom renderer for examples section */
   renderExamples?: ExamplesRenderFunction;
 }
+/**
+ * Root document configuration
+ * The root document contains global options tables and command index sections.
+ */
+interface RootDocConfig {
+  /** Output file path */
+  path: string;
+  /**
+   * Global options configuration.
+   * ArgsShape directly, or { args, options } for render options.
+   */
+  globalOptions?: ArgsShape | {
+    args: ArgsShape;
+    options?: ArgsTableOptions;
+  };
+  /** Heading level for the file header (default: 1) */
+  headingLevel?: HeadingLevel;
+  /** Index section rendering options */
+  index?: CommandIndexOptions;
+}
 /**
  * Per-file configuration with custom renderer
  */
@@ -270,6 +336,12 @@ type FileMapping = Record<string, string[] | FileConfig>;
 interface GenerateDocConfig {
   /** Command to generate documentation for */
   command: AnyCommand;
+  /**
+   * Root document configuration.
+   * The root document contains global options tables and command index sections.
+   * Title and description are derived from `command.name` and `command.description`.
+   */
+  rootDoc?: RootDocConfig;
   /** File output configuration (command path -> file mapping) */
   files: FileMapping;
   /** Command paths to ignore (including their subcommands) */
@@ -324,6 +396,32 @@ declare function commandStartMarker(commandPath: string): string;
  * Generate end marker for a command section
  */
 declare function commandEndMarker(commandPath: string): string;
+/**
+ * Marker prefix for global options sections in generated documentation
+ * Format: <!-- politty:global-options:start --> ... <!-- politty:global-options:end -->
+ */
+declare const GLOBAL_OPTIONS_MARKER_PREFIX = "politty:global-options";
+/**
+ * Generate start marker for a global options section
+ */
+declare function globalOptionsStartMarker(): string;
+/**
+ * Generate end marker for a global options section
+ */
+declare function globalOptionsEndMarker(): string;
+/**
+ * Marker prefix for index sections in generated documentation
+ * Format: <!-- politty:index:start --> ... <!-- politty:index:end -->
+ */
+declare const INDEX_MARKER_PREFIX = "politty:index";
+/**
+ * Generate start marker for an index section
+ */
+declare function indexStartMarker(): string;
+/**
+ * Generate end marker for an index section
+ */
+declare function indexEndMarker(): string;
 //#endregion
 //#region src/docs/default-renderers.d.ts
 /**
@@ -492,43 +590,6 @@ declare function assertDocMatch(config: GenerateDocConfig): Promise<void>;
  */
 declare function initDocFile(config: Pick<GenerateDocConfig, "files"> | string, fileSystem?: DeleteFileFs): void;
 //#endregion
-//#region src/docs/render-args.d.ts
-/**
- * Args shape type (Record of string keys to Zod schemas)
- * This matches the typical structure of `commonArgs`, `workspaceArgs`, etc.
- */
-type ArgsShape = Record<string, z.ZodType>;
-/**
- * Options for rendering args table
- */
-type ArgsTableOptions = {
-  /** Columns to include in the table (default: all columns) */columns?: ("option" | "alias" | "description" | "required" | "default" | "env")[];
-};
-/**
- * Render args definition as a markdown options table
- *
- * This function takes raw args definitions (like `commonArgs`) and
- * renders them as a markdown table suitable for documentation.
- *
- * @example
- * import { renderArgsTable } from "politty/docs";
- * import { commonArgs, workspaceArgs } from "./args";
- *
- * const table = renderArgsTable({
- *   ...commonArgs,
- *   ...workspaceArgs,
- * });
- * // | Option | Alias | Description | Default |
- * // |--------|-------|-------------|---------|
- * // | `--env-file <ENV_FILE>` | `-e` | Path to environment file | - |
- * // ...
- *
- * @param args - Args shape (Record of string keys to Zod schemas with arg() metadata)
- * @param options - Rendering options
- * @returns Rendered markdown table string
- */
-declare function renderArgsTable(args: ArgsShape, options?: ArgsTableOptions): string;
-//#endregion
 //#region src/docs/render-index.d.ts
 /**
  * Configuration for a command category
@@ -539,13 +600,6 @@ type CommandCategory = {
   commands: string[]; /** Path to documentation file for links (e.g., "./cli/application.md") */
   docPath: string;
 };
-/**
- * Options for rendering command index
- */
-type CommandIndexOptions = {
-  /** Base heading level (default: 3, which renders as ###) */headingLevel?: 1 | 2 | 3 | 4 | 5 | 6; /** Only include leaf commands (commands without subcommands). Default: true */
-  leafOnly?: boolean;
-};
 /**
  * Render command index from categories
  *
@@ -578,5 +632,5 @@ type CommandIndexOptions = {
  */
 declare function renderCommandIndex(command: AnyCommand, categories: CommandCategory[], options?: CommandIndexOptions): Promise<string>;
 //#endregion
-export { type ArgsShape, type ArgsTableOptions, type ArgumentsRenderContext, type ArgumentsRenderFunction, COMMAND_MARKER_PREFIX, type CommandCategory, type CommandIndexOptions, type CommandInfo, type DefaultRendererOptions, type DeleteFileFs, type ExampleCommandConfig, type ExampleConfig, type ExampleExecutionResult, type ExamplesRenderContext, type ExamplesRenderFunction, type ExamplesRenderOptions, type FileConfig, type FileMapping, type FormatterFunction, type GenerateDocConfig, type GenerateDocResult, type OptionsRenderContext, type OptionsRenderFunction, type RenderContentOptions, type RenderFunction, type SectionRenderFunction, type SimpleRenderContext, type SimpleRenderFunction, type SubCommandInfo, type SubcommandsRenderContext, type SubcommandsRenderFunction, type SubcommandsRenderOptions, UPDATE_GOLDEN_ENV, assertDocMatch, buildCommandInfo, collectAllCommands, commandEndMarker, commandStartMarker, compareWithExisting, createCommandRenderer, defaultRenderers, executeExamples, formatDiff, generateDoc, initDocFile, renderArgsTable, renderArgumentsList, renderArgumentsListFromArray, renderArgumentsTable, renderArgumentsTableFromArray, renderCommandIndex, renderExamplesDefault, renderOptionsList, renderOptionsListFromArray, renderOptionsTable, renderOptionsTableFromArray, renderSubcommandsTable, renderSubcommandsTableFromArray, renderUsage, resolveLazyCommand, writeFile };
+export { type ArgsShape, type ArgsTableOptions, type ArgumentsRenderContext, type ArgumentsRenderFunction, COMMAND_MARKER_PREFIX, type CommandCategory, type CommandIndexOptions, type CommandInfo, type DefaultRendererOptions, type DeleteFileFs, type ExampleCommandConfig, type ExampleConfig, type ExampleExecutionResult, type ExamplesRenderContext, type ExamplesRenderFunction, type ExamplesRenderOptions, type FileConfig, type FileMapping, type FormatterFunction, GLOBAL_OPTIONS_MARKER_PREFIX, type GenerateDocConfig, type GenerateDocResult, type HeadingLevel, INDEX_MARKER_PREFIX, type OptionsRenderContext, type OptionsRenderFunction, type RenderContentOptions, type RenderFunction, type RootDocConfig, type SectionRenderFunction, type SimpleRenderContext, type SimpleRenderFunction, type SubCommandInfo, type SubcommandsRenderContext, type SubcommandsRenderFunction, type SubcommandsRenderOptions, UPDATE_GOLDEN_ENV, assertDocMatch, buildCommandInfo, collectAllCommands, commandEndMarker, commandStartMarker, compareWithExisting, createCommandRenderer, defaultRenderers, executeExamples, formatDiff, generateDoc, globalOptionsEndMarker, globalOptionsStartMarker, indexEndMarker, indexStartMarker, initDocFile, renderArgsTable, renderArgumentsList, renderArgumentsListFromArray, renderArgumentsTable, renderArgumentsTableFromArray, renderCommandIndex, renderExamplesDefault, renderOptionsList, renderOptionsListFromArray, renderOptionsTable, renderOptionsTableFromArray, renderSubcommandsTable, renderSubcommandsTableFromArray, renderUsage, resolveLazyCommand, writeFile };
 //# sourceMappingURL=index.d.cts.map

package/dist/docs/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/executor/subcommand-router.ts","../../src/docs/types.ts","../../src/docs/default-renderers.ts","../../src/docs/doc-comparator.ts","../../src/docs/doc-generator.ts","../../src/docs/example-executor.ts","../../src/docs/golden-test.ts","../../src/docs/render-args.ts","../../src/docs/render-index.ts"],"mappings":";;;;;;;;;AAQA;;iBAAsB,kBAAA,CACpB,GAAA,EAAK,UAAA,UAAoB,OAAA,CAAQ,UAAA,KAChC,OAAA,CAAQ,UAAA;;;;;;UCJM,WAAA;EDEuB;ECAtC,IAAA;EDCK;ECCL,WAAA;EDDyB;ECGzB,eAAA;EDFC;ECID,WAAA;EDJQ;ECMR,KAAA;EDPyB;ECSzB,cAAA,EAAgB,iBAAA;EDThB;ECWA,OAAA,EAAS,iBAAA;EDVA;ECYT,WAAA,EAAa,cAAA;EDZM;ECcnB,SAAA,EAAW,eAAA;;EAEX,OAAA,EAAS,UAAA;EApBM;EAsBf,KAAA;;EAEA,QAAA;EAVS;EAYT,OAAA,GAAU,MAAA;EARC;EAUX,QAAA,GAAW,OAAA;EAFD;EAIV,cAAA,GAAiB,sBAAA;AAAA;;;;UAMF,cAAA;EA9Bf;EAgCA,IAAA;EA5BA;EA8BA,WAAA;EA5BgB;EA8BhB,QAAA;AAAA;;;;UAMe,sBAAA;EA5Bf;EA8BA,GAAA;EA5BA;EA8BA,IAAA;EA1BA;EA4BA,cAAA;EA1BA;EA4BA,MAAA;EA1BA;EA4BA,MAAA;EA5BuC;EA8BvC,OAAA;AAAA;;;;;UAOe,oBAAA;EAzBf;EA2BA,IAAA,gBAAoB,OAAA;EA3BZ;EA6BR,OAAA,gBAAuB,OAAA;AAAA;;;;;;;;;;;AAJzB;;KAmBY,aAAA,GAAgB,MAAA,SAAe,oBAAA;;;;KAK/B,cAAA,IAAkB,IAAA,EAAM,WAAA;;;;AALpC;;;;KAcY,qBAAA,IAAyB,cAAA,UAAwB,IAAA,EAAM,WAAA;AATnE;;;AAAA,UAciB,oBAAA;EAd8B;EAgB7C,KAAA;EAP+B;EAS/B,WAAA;AAAA;;;;UAMe,oBAAA;EAf6D;EAiB5E,OAAA,EAAS,iBAAA;EAZ0B;EAcnC,MAAA,GAAS,OAAA,EAAS,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAZ9C;EAcA,OAAA;EANe;EAQf,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,qBAAA,IAAyB,OAAA,EAAS,oBAAA;;;;UAK7B,sBAAA;EAPE;EASjB,IAAA,EAAM,iBAAA;EAfG;EAiBT,MAAA,GAAS,IAAA,EAAM,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAfzB;EAiBlB,OAAA;EAjB8C;EAmB9C,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,uBAAA,IAA2B,OAAA,EAAS,sBAAA;;;;UAK/B,wBAAA;EApBgB;EAsB/B,eAAA;EAtB4C;EAwB5C,WAAA;AAAA;;;;UAMe,wBAAA;EArB4B;EAuB3C,WAAA,EAAa,cAAA;EAnBI;EAqBjB,MAAA,GAAS,WAAA,EAAa,cAAA,IAAkB,IAAA,GAAO,wBAAA;EA3B/C;EA6BA,OAAA;EA3BA;EA6BA,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,yBAAA,IAA6B,OAAA,EAAS,wBAAA;;;;UAKjC,qBAAA;EAhCE;EAkCjB,WAAA;EAhCU;EAkCV,UAAA;;EAEA,aAAA;AAAA;AA/BF;;;AAAA,UAqCiB,qBAAA;EAjCJ;EAmCX,QAAA,EAAU,OAAA;EA7B6B;EA+BvC,OAAA,GAAU,sBAAA;EA7BG;EA+Bb,MAAA,GACE,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;EAhCsC;EAmC/C,OAAA;EA/BiB;EAiCjB,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,sBAAA,IAA0B,OAAA,EAAS,qBAAA;;;;UAK9B,mBAAA;EA5CyB;EA8CxC,OAAA;EA1CA;EA4CA,OAAA;EA5CiB;EA8CjB,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,oBAAA,IAAwB,OAAA,EAAS,mBAAA;;;;UAK5B,sBAAA;EA9CqB;EAgDpC,YAAA;EAhDoC;EAkDpC,WAAA;EA9CA;EAgDA,eAAA;EA9Ca;EAgDb,wBAAA;EA1Ce;EA4Cf,iBAAA,GAAoB,oBAAA;;EAEpB,WAAA,GAAc,oBAAA;EA1CJ;EA4CV,eAAA,GAAkB,uBAAA;EAxCN;EA0CZ,aAAA,GAAgB,qBAAA;EApCV;EAsCN,iBAAA,GAAoB,yBAAA;EAtCH;EAwCjB,WAAA,GAAc,oBAAA;EApDJ;EAsDV,YAAA,GAAe,oBAAA;EApDL;EAsDV,cAAA,GAAiB,sBAAA;AAAA;;;;UAMF,UAAA;EAvDb;EAyDF,QAAA;EApDA;EAsDA,MAAA,GAAS,cAAA;EAtDQ;EAwDjB,KAAA;EAtDU;EAwDV,WAAA;AAAA;;;AAnDF;;;;;;;;;;KAkEY,WAAA,GAAc,MAAA,oBAA0B,UAAA;;;;UAKnC,iBAAA;EA1DA;EA4Df,OAAA,EAAS,UAAA;;EAET,KAAA,EAAO,WAAA;EAlDO;EAoDd,OAAA;EAhDgB;EAkDhB,MAAA,GAAS,sBAAA;EA9CK;EAgDd,SAAA,GAAY,iBAAA;EA5CK;EA8CjB,QAAA,GAAW,aAAA;EA9C4B;;;;;EAoDvC,cAAA;AAAA;;;;UAMe,iBAAA;EAlEf;EAoEA,OAAA;EAlEA;EAoEA,KAAA,EAAO,KAAA;IAlEP,gBAoEE,IAAA,UAlEF;IAoEE,MAAA,4CAlEF;IAoEE,IAAA;EAAA;EApEqC;EAuEvC,KAAA;AAAA;;;;;KAOU,iBAAA,IAAqB,OAAA,sBAA6B,OAAA;;;;cAKjD,iBAAA;AAtDb;;;;AAAA,cA4Da,qBAAA;AAvDb;;;AAAA,iBA4DgB,kBAAA,CAAmB,WAAA;;;;iBAOnB,gBAAA,CAAiB,WAAA;;;;;ADnVjC;iBE8BgB,WAAA,CAAY,IAAA,EAAM,WAAA;;;;iBAyBlB,oBAAA,CAAqB,IAAA,EAAM,WAAA;;;;iBAqB3B,mBAAA,CAAoB,IAAA,EAAM,WAAA;;;;;;;;;;;;AD9E1C;;;iBCwIgB,kBAAA,CAAmB,IAAA,EAAM,WAAA;;;;;;;;;;;;iBAuDzB,iBAAA,CAAkB,IAAA,EAAM,WAAA;;;;iBAqDxB,sBAAA,CAAuB,IAAA,EAAM,WAAA,EAAa,eAAA;;;;iBAwC1C,2BAAA,CAA4B,OAAA,EAAS,iBAAA;;;;iBA8CrC,0BAAA,CAA2B,OAAA,EAAS,iBAAA;;;;iBAsBpC,6BAAA,CAA8B,IAAA,EAAM,iBAAA;;;;iBAqBpC,4BAAA,CAA6B,IAAA,EAAM,iBAAA;;;ADjVnD;iBCmWgB,+BAAA,CACd,WAAA,EAAa,cAAA,IACb,IAAA,EAAM,WAAA,EACN,eAAA;;;;;;;;AD1VF;;;;;;;;iBC+YgB,qBAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;;;;iBAuDO,qBAAA,CAAsB,OAAA,GAAS,sBAAA,GAA8B,cAAA;;;;cAoNhE,gBAAA;EDxoBS,yDC0oBA,sBAAA,KAAsB,cAAA,EDxoBnB;8BAAO;;;;;;;;UEvEf,aAAA;EHEK;EGApB,KAAA;;EAEA,IAAA;EHDiC;EGGjC,UAAA;AAAA;;;;iBAMc,mBAAA,CAAoB,gBAAA,UAA0B,QAAA,WAAmB,aAAA;;;;iBA6BjE,UAAA,CAAW,QAAA,UAAkB,MAAA;;;;iBAsE7B,SAAA,CAAU,QAAA,UAAkB,OAAA;;;;UA4B3B,YAAA;EACf,UAAA,SAAmB,EAAA,CAAG,UAAA;EACtB,UAAA,SAAmB,EAAA,CAAG,UAAA;AAAA;;;;;;iBC3IF,gBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,UACA,WAAA,cACC,OAAA,CAAQ,WAAA;;;;;iBAuCW,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,YACC,OAAA,CAAQ,GAAA,SAAY,WAAA;;;;;;AJ9CvB;;;;;;iBKKsB,eAAA,CACpB,QAAA,EAAU,OAAA,IACV,MAAA,EAAQ,oBAAA,EACR,WAAA,EAAa,UAAA,EACb,WAAA,cACC,OAAA,CAAQ,sBAAA;;;;;;iBC8lBW,WAAA,CAAY,MAAA,EAAQ,iBAAA,GAAoB,OAAA,CAAQ,iBAAA;;;;;iBAwQhD,cAAA,CAAe,MAAA,EAAQ,iBAAA,GAAoB,OAAA;;;;;;;;iBA6BjD,WAAA,CACd,MAAA,EAAQ,IAAA,CAAK,iBAAA,qBACb,UAAA,GAAa,YAAA;;;;;;;KC/4BH,SAAA,GAAY,MAAA,SAAe,CAAA,CAAE,OAAA;;;;KAK7B,gBAAA;EPJe,6DOMzB,OAAA;AAAA;;;;;;;;;;;;;;ANTF;;;;;;;;;;iBMgDgB,eAAA,CAAgB,IAAA,EAAM,SAAA,EAAW,OAAA,GAAU,gBAAA;;;;;;KCjC/C,eAAA;ERbU,oDQepB,KAAA;EAEA,WAAA,URhBiC;EQkBjC,QAAA,YRjBS;EQmBT,OAAA;AAAA;;;;KAMU,mBAAA;ER1BV,4DQ4BA,YAAA,0BR3BS;EQ6BT,QAAA;AAAA;;;;APjCF;;;;;;;;;;;;;;;;;;;;;;;;;;;iBO+JsB,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,UAAA,EAAY,eAAA,IACZ,OAAA,GAAU,mBAAA,GACT,OAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/executor/subcommand-router.ts","../../src/docs/render-args.ts","../../src/docs/types.ts","../../src/docs/default-renderers.ts","../../src/docs/doc-comparator.ts","../../src/docs/doc-generator.ts","../../src/docs/example-executor.ts","../../src/docs/golden-test.ts","../../src/docs/render-index.ts"],"mappings":";;;;;;;;;AAQA;;iBAAsB,kBAAA,CACpB,GAAA,EAAK,UAAA,UAAoB,OAAA,CAAQ,UAAA,KAChC,OAAA,CAAQ,UAAA;;;;;;;KCFC,SAAA,GAAY,MAAA,SAAe,CAAA,CAAE,OAAA;;;;KAK7B,gBAAA;EDJe,6DCMzB,OAAA;AAAA;;;;;;;;;;;;;;AAPF;;;;;;;;;AAKA;iBAyCgB,eAAA,CAAgB,IAAA,EAAM,SAAA,EAAW,OAAA,GAAU,gBAAA;;;;KCjD/C,YAAA;AFGZ;;;AAAA,KEEY,mBAAA;EFDuB,4DEGjC,YAAA,GAAe,YAAA,EFFN;EEIT,QAAA;AAAA;;;;UAMe,WAAA;EFXf;EEaA,IAAA;EFZS;EEcT,WAAA;EFdmB;EEgBnB,eAAA;;EAEA,WAAA;EDpBU;ECsBV,KAAA;;EAEA,cAAA,EAAgB,iBAAA;EDxBM;EC0BtB,OAAA,EAAS,iBAAA;ED1B8B;EC4BvC,WAAA,EAAa,cAAA;ED5BiC;EC8B9C,SAAA,EAAW,eAAA;EDzBe;EC2B1B,OAAA,EAAS,UAAA;EDzBT;EC2BA,KAAA;EDYc;ECVd,QAAA;;EAEA,OAAA,GAAU,MAAA;EDQ0B;ECNpC,QAAA,GAAW,OAAA;EDM8C;ECJzD,cAAA,GAAiB,sBAAA;AAAA;;;;UAMF,cAAA;EAnDL;EAqDV,IAAA;;EAEA,WAAA;EAvDsB;EAyDtB,QAAA;AAAA;;;;UAMe,sBAAA;EAtDf;EAwDA,GAAA;EAxDQ;EA0DR,IAAA;EApD0B;EAsD1B,cAAA;EA1CgB;EA4ChB,MAAA;EAxCa;EA0Cb,MAAA;EAtCS;EAwCT,OAAA;AAAA;;;;;UAOe,oBAAA;EA7Df;EA+DA,IAAA,gBAAoB,OAAA;EA3DpB;EA6DA,OAAA,gBAAuB,OAAA;AAAA;;;;;;;;;;;;;KAeb,aAAA,GAAgB,MAAA,SAAe,oBAAA;;;;KAK/B,cAAA,IAAkB,IAAA,EAAM,WAAA;;AAvDpC;;;;;;KAgEY,qBAAA,IAAyB,cAAA,UAAwB,IAAA,EAAM,WAAA;;;AApDnE;UAyDiB,oBAAA;;EAEf,KAAA;EAzDA;EA2DA,WAAA;AAAA;;;;UAMe,oBAAA;EAvDR;EAyDP,OAAA,EAAS,iBAAA;EAlD0B;EAoDnC,MAAA,GAAS,OAAA,EAAS,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAhDhB;EAkD9B,OAAA;EApDoB;EAsDpB,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,qBAAA,IAAyB,OAAA,EAAS,oBAAA;;AAvC9C;;UA4CiB,sBAAA;EA5CW;EA8C1B,IAAA,EAAM,iBAAA;EAzCI;EA2CV,MAAA,GAAS,IAAA,EAAM,iBAAA,IAAqB,IAAA,GAAO,oBAAA;;EAE3C,OAAA;EA7C6C;EA+C7C,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,uBAAA,IAA2B,OAAA,EAAS,sBAAA;;;;UAK/B,wBAAA;EA7C6D;EA+C5E,eAAA;EA1Ce;EA4Cf,WAAA;AAAA;;;AAlCF;UAwCiB,wBAAA;;EAEf,WAAA,EAAa,cAAA;EAtCK;EAwClB,MAAA,GAAS,WAAA,EAAa,cAAA,IAAkB,IAAA,GAAO,wBAAA;EApCzC;EAsCN,OAAA;EAtCiB;EAwCjB,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,yBAAA,IAA6B,OAAA,EAAS,wBAAA;;;;UAKjC,qBAAA;EAjDf;EAmDA,WAAA;EAjDM;EAmDN,UAAA;EAnDiB;EAqDjB,aAAA;AAAA;;;;UAMe,qBAAA;EApDsB;EAsDrC,QAAA,EAAU,OAAA;EApDJ;EAsDN,OAAA,GAAU,sBAAA;EApDiC;EAsD3C,MAAA,GACE,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;EArDQ;EAwDjB,OAAA;EA9DA;EAgEA,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,sBAAA,IAA0B,OAAA,EAAS,qBAAA;;;;UAK9B,mBAAA;EAjEf;EAmEA,OAAA;EAnEiB;EAqEjB,OAAA;EAnEU;EAqEV,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,oBAAA,IAAwB,OAAA,EAAS,mBAAA;;AAlE7C;;UAuEiB,sBAAA;EArEf;EAuEA,YAAA,GAAe,YAAA;EA/DA;EAiEf,WAAA;;EAEA,eAAA;EA/DsB;EAiEtB,wBAAA;EA7DM;EA+DN,iBAAA,GAAoB,oBAAA;EA/DH;EAiEjB,WAAA,GAAc,oBAAA;EAvED;EAyEb,eAAA,GAAkB,uBAAA;EAvEI;EAyEtB,aAAA,GAAgB,qBAAA;EAzE+B;EA2E/C,iBAAA,GAAoB,yBAAA;EAzEpB;EA2EA,WAAA,GAAc,oBAAA;EAzER;EA2EN,YAAA,GAAe,oBAAA;EA3EE;EA6EjB,cAAA,GAAiB,sBAAA;AAAA;;;;AAtEnB;UA6EiB,aAAA;;EAEf,IAAA;EA7EA;;;;EAkFA,aAAA,GAAgB,SAAA;IAAc,IAAA,EAAM,SAAA;IAAW,OAAA,GAAU,gBAAA;EAAA;EAtE/C;EAwEV,YAAA,GAAe,YAAA;EAnEH;EAqEZ,KAAA,GAAQ,mBAAA;AAAA;;;;UAMO,UAAA;EAhFL;EAkFV,QAAA;EAhFU;EAkFV,MAAA,GAAS,cAAA;EA/EG;EAiFZ,KAAA;EAhFY;EAkFZ,WAAA;AAAA;;;;;;;AA1EF;;;;;AAKA;KAoFY,WAAA,GAAc,MAAA,oBAA0B,UAAA;;;;UAKnC,iBAAA;EAnFf;EAqFA,OAAA,EAAS,UAAA;EArFQ;;AAEnB;;;EAyFE,OAAA,GAAU,aAAA;EAzFoD;EA2F9D,KAAA,EAAO,WAAA;EAtF8B;EAwFrC,OAAA;EAtFe;EAwFf,MAAA,GAAS,sBAAA;EA9EK;EAgFd,SAAA,GAAY,iBAAA;EA5EI;EA8EhB,QAAA,GAAW,aAAA;EA1EG;;;;;EAgFd,cAAA;AAAA;;;;UAMe,iBAAA;EAhGK;EAkGpB,OAAA;EAhGc;EAkGd,KAAA,EAAO,KAAA;IAhGW,gBAkGhB,IAAA,UAhGc;IAkGd,MAAA,4CAhGkB;IAkGlB,IAAA;EAAA;EA9FF;EAiGA,KAAA;AAAA;;;;AAxFF;KA+FY,iBAAA,IAAqB,OAAA,sBAA6B,OAAA;;;;cAKjD,iBAAA;;;;;cAMA,qBAAA;;;;iBAKG,kBAAA,CAAmB,WAAA;;;;iBAOnB,gBAAA,CAAiB,WAAA;;;;;cAQpB,4BAAA;;;;iBAKG,wBAAA,CAAA;;;;iBAOA,sBAAA,CAAA;;;AAlGhB;;cA0Ga,mBAAA;;;AArGb;iBA0GgB,gBAAA,CAAA;;;;iBAOA,cAAA,CAAA;;;;;AFjahB;iBG8BgB,WAAA,CAAY,IAAA,EAAM,WAAA;;;;iBAyBlB,oBAAA,CAAqB,IAAA,EAAM,WAAA;;;;iBAqB3B,mBAAA,CAAoB,IAAA,EAAM,WAAA;;;;;;;;;;;;AF5E1C;;;iBEsIgB,kBAAA,CAAmB,IAAA,EAAM,WAAA;;;;;;AFjIzC;;;;;AAyCA;iBE+IgB,iBAAA,CAAkB,IAAA,EAAM,WAAA;;;;iBAqDxB,sBAAA,CAAuB,IAAA,EAAM,WAAA,EAAa,eAAA;;;;iBAwC1C,2BAAA,CAA4B,OAAA,EAAS,iBAAA;;;;iBA8CrC,0BAAA,CAA2B,OAAA,EAAS,iBAAA;;;;iBAsBpC,6BAAA,CAA8B,IAAA,EAAM,iBAAA;AD5VpD;;;AAAA,iBCiXgB,4BAAA,CAA6B,IAAA,EAAM,iBAAA;;;;iBAkBnC,+BAAA,CACd,WAAA,EAAa,cAAA,IACb,IAAA,EAAM,WAAA,EACN,eAAA;;AD5XF;;;;;;;;;;;;;;iBCibgB,qBAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;;;;iBAuDO,qBAAA,CAAsB,OAAA,GAAS,sBAAA,GAA8B,cAAA;;;;cAoNhE,gBAAA;ED/qBE,yDCirBO,sBAAA,KAAsB,cAAA,ED/qB/B;8BAEF;;;;;;;;UElCM,aAAA;EJEK;EIApB,KAAA;;EAEA,IAAA;EJDiC;EIGjC,UAAA;AAAA;;;;iBAMc,mBAAA,CAAoB,gBAAA,UAA0B,QAAA,WAAmB,aAAA;;;;iBA6BjE,UAAA,CAAW,QAAA,UAAkB,MAAA;;;;iBAsE7B,SAAA,CAAU,QAAA,UAAkB,OAAA;;;;UA4B3B,YAAA;EACf,UAAA,SAAmB,EAAA,CAAG,UAAA;EACtB,UAAA,SAAmB,EAAA,CAAG,UAAA;AAAA;;;;;;iBC3IF,gBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,UACA,WAAA,cACC,OAAA,CAAQ,WAAA;;;;;iBAuCW,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,YACC,OAAA,CAAQ,GAAA,SAAY,WAAA;;;;;;AL9CvB;;;;;;iBMKsB,eAAA,CACpB,QAAA,EAAU,OAAA,IACV,MAAA,EAAQ,oBAAA,EACR,WAAA,EAAa,UAAA,EACb,WAAA,cACC,OAAA,CAAQ,sBAAA;;;;;;iBC0pCW,WAAA,CAAY,MAAA,EAAQ,iBAAA,GAAoB,OAAA,CAAQ,iBAAA;;;;;iBAiYhD,cAAA,CAAe,MAAA,EAAQ,iBAAA,GAAoB,OAAA;;;;;;;;iBA6BjD,WAAA,CACd,MAAA,EAAQ,IAAA,CAAK,iBAAA,qBACb,UAAA,GAAa,YAAA;;;;;;KCvjDH,eAAA;ERb4B,oDQetC,KAAA,URdK;EQgBL,WAAA,URhByB;EQkBzB,QAAA,YRjBC;EQmBD,OAAA;AAAA;;;;;;;;;;;APrBF;;;;;;;;;AAKA;;;;;AAyCA;;;;;;iBOuGsB,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,UAAA,EAAY,eAAA,IACZ,OAAA,GAAU,mBAAA,GACT,OAAA"}

package/dist/docs/index.d.ts

@@ -11,7 +11,53 @@ import * as fs from "node:fs";
  */
 declare function resolveLazyCommand(cmd: AnyCommand | (() => Promise<AnyCommand>)): Promise<AnyCommand>;
 //#endregion
+//#region src/docs/render-args.d.ts
+/**
+ * Args shape type (Record of string keys to Zod schemas)
+ * This matches the typical structure of `commonArgs`, `workspaceArgs`, etc.
+ */
+type ArgsShape = Record<string, z.ZodType>;
+/**
+ * Options for rendering args table
+ */
+type ArgsTableOptions = {
+  /** Columns to include in the table (default: all columns) */columns?: ("option" | "alias" | "description" | "required" | "default" | "env")[];
+};
+/**
+ * Render args definition as a markdown options table
+ *
+ * This function takes raw args definitions (like `commonArgs`) and
+ * renders them as a markdown table suitable for documentation.
+ *
+ * @example
+ * import { renderArgsTable } from "politty/docs";
+ * import { commonArgs, workspaceArgs } from "./args";
+ *
+ * const table = renderArgsTable({
+ *   ...commonArgs,
+ *   ...workspaceArgs,
+ * });
+ * // | Option | Alias | Description | Default |
+ * // |--------|-------|-------------|---------|
+ * // | `--env-file <ENV_FILE>` | `-e` | Path to environment file | - |
+ * // ...
+ *
+ * @param args - Args shape (Record of string keys to Zod schemas with arg() metadata)
+ * @param options - Rendering options
+ * @returns Rendered markdown table string
+ */
+declare function renderArgsTable(args: ArgsShape, options?: ArgsTableOptions): string;
+//#endregion
 //#region src/docs/types.d.ts
+/** Heading level for markdown headings (1-6) */
+type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
+/**
+ * Options for rendering command index
+ */
+type CommandIndexOptions = {
+  /** Base heading level (default: 3, which renders as ###) */headingLevel?: HeadingLevel; /** Only include leaf commands (commands without subcommands). Default: true */
+  leafOnly?: boolean;
+};
 /**
  * Command information for rendering
  */
@@ -214,7 +260,7 @@ type SimpleRenderFunction = (context: SimpleRenderContext) => string;
  */
 interface DefaultRendererOptions {
   /** Heading level (default: 1) */
-  headingLevel?: 1 | 2 | 3 | 4 | 5 | 6;
+  headingLevel?: HeadingLevel;
   /** Option display style */
   optionStyle?: "table" | "list";
   /** Generate anchor links to subcommands */
@@ -238,6 +284,26 @@ interface DefaultRendererOptions {
   /** Custom renderer for examples section */
   renderExamples?: ExamplesRenderFunction;
 }
+/**
+ * Root document configuration
+ * The root document contains global options tables and command index sections.
+ */
+interface RootDocConfig {
+  /** Output file path */
+  path: string;
+  /**
+   * Global options configuration.
+   * ArgsShape directly, or { args, options } for render options.
+   */
+  globalOptions?: ArgsShape | {
+    args: ArgsShape;
+    options?: ArgsTableOptions;
+  };
+  /** Heading level for the file header (default: 1) */
+  headingLevel?: HeadingLevel;
+  /** Index section rendering options */
+  index?: CommandIndexOptions;
+}
 /**
  * Per-file configuration with custom renderer
  */
@@ -270,6 +336,12 @@ type FileMapping = Record<string, string[] | FileConfig>;
 interface GenerateDocConfig {
   /** Command to generate documentation for */
   command: AnyCommand;
+  /**
+   * Root document configuration.
+   * The root document contains global options tables and command index sections.
+   * Title and description are derived from `command.name` and `command.description`.
+   */
+  rootDoc?: RootDocConfig;
   /** File output configuration (command path -> file mapping) */
   files: FileMapping;
   /** Command paths to ignore (including their subcommands) */
@@ -324,6 +396,32 @@ declare function commandStartMarker(commandPath: string): string;
  * Generate end marker for a command section
  */
 declare function commandEndMarker(commandPath: string): string;
+/**
+ * Marker prefix for global options sections in generated documentation
+ * Format: <!-- politty:global-options:start --> ... <!-- politty:global-options:end -->
+ */
+declare const GLOBAL_OPTIONS_MARKER_PREFIX = "politty:global-options";
+/**
+ * Generate start marker for a global options section
+ */
+declare function globalOptionsStartMarker(): string;
+/**
+ * Generate end marker for a global options section
+ */
+declare function globalOptionsEndMarker(): string;
+/**
+ * Marker prefix for index sections in generated documentation
+ * Format: <!-- politty:index:start --> ... <!-- politty:index:end -->
+ */
+declare const INDEX_MARKER_PREFIX = "politty:index";
+/**
+ * Generate start marker for an index section
+ */
+declare function indexStartMarker(): string;
+/**
+ * Generate end marker for an index section
+ */
+declare function indexEndMarker(): string;
 //#endregion
 //#region src/docs/default-renderers.d.ts
 /**
@@ -492,43 +590,6 @@ declare function assertDocMatch(config: GenerateDocConfig): Promise<void>;
  */
 declare function initDocFile(config: Pick<GenerateDocConfig, "files"> | string, fileSystem?: DeleteFileFs): void;
 //#endregion
-//#region src/docs/render-args.d.ts
-/**
- * Args shape type (Record of string keys to Zod schemas)
- * This matches the typical structure of `commonArgs`, `workspaceArgs`, etc.
- */
-type ArgsShape = Record<string, z.ZodType>;
-/**
- * Options for rendering args table
- */
-type ArgsTableOptions = {
-  /** Columns to include in the table (default: all columns) */columns?: ("option" | "alias" | "description" | "required" | "default" | "env")[];
-};
-/**
- * Render args definition as a markdown options table
- *
- * This function takes raw args definitions (like `commonArgs`) and
- * renders them as a markdown table suitable for documentation.
- *
- * @example
- * import { renderArgsTable } from "politty/docs";
- * import { commonArgs, workspaceArgs } from "./args";
- *
- * const table = renderArgsTable({
- *   ...commonArgs,
- *   ...workspaceArgs,
- * });
- * // | Option | Alias | Description | Default |
- * // |--------|-------|-------------|---------|
- * // | `--env-file <ENV_FILE>` | `-e` | Path to environment file | - |
- * // ...
- *
- * @param args - Args shape (Record of string keys to Zod schemas with arg() metadata)
- * @param options - Rendering options
- * @returns Rendered markdown table string
- */
-declare function renderArgsTable(args: ArgsShape, options?: ArgsTableOptions): string;
-//#endregion
 //#region src/docs/render-index.d.ts
 /**
  * Configuration for a command category
@@ -539,13 +600,6 @@ type CommandCategory = {
   commands: string[]; /** Path to documentation file for links (e.g., "./cli/application.md") */
   docPath: string;
 };
-/**
- * Options for rendering command index
- */
-type CommandIndexOptions = {
-  /** Base heading level (default: 3, which renders as ###) */headingLevel?: 1 | 2 | 3 | 4 | 5 | 6; /** Only include leaf commands (commands without subcommands). Default: true */
-  leafOnly?: boolean;
-};
 /**
  * Render command index from categories
  *
@@ -578,5 +632,5 @@ type CommandIndexOptions = {
  */
 declare function renderCommandIndex(command: AnyCommand, categories: CommandCategory[], options?: CommandIndexOptions): Promise<string>;
 //#endregion
-export { type ArgsShape, type ArgsTableOptions, type ArgumentsRenderContext, type ArgumentsRenderFunction, COMMAND_MARKER_PREFIX, type CommandCategory, type CommandIndexOptions, type CommandInfo, type DefaultRendererOptions, type DeleteFileFs, type ExampleCommandConfig, type ExampleConfig, type ExampleExecutionResult, type ExamplesRenderContext, type ExamplesRenderFunction, type ExamplesRenderOptions, type FileConfig, type FileMapping, type FormatterFunction, type GenerateDocConfig, type GenerateDocResult, type OptionsRenderContext, type OptionsRenderFunction, type RenderContentOptions, type RenderFunction, type SectionRenderFunction, type SimpleRenderContext, type SimpleRenderFunction, type SubCommandInfo, type SubcommandsRenderContext, type SubcommandsRenderFunction, type SubcommandsRenderOptions, UPDATE_GOLDEN_ENV, assertDocMatch, buildCommandInfo, collectAllCommands, commandEndMarker, commandStartMarker, compareWithExisting, createCommandRenderer, defaultRenderers, executeExamples, formatDiff, generateDoc, initDocFile, renderArgsTable, renderArgumentsList, renderArgumentsListFromArray, renderArgumentsTable, renderArgumentsTableFromArray, renderCommandIndex, renderExamplesDefault, renderOptionsList, renderOptionsListFromArray, renderOptionsTable, renderOptionsTableFromArray, renderSubcommandsTable, renderSubcommandsTableFromArray, renderUsage, resolveLazyCommand, writeFile };
+export { type ArgsShape, type ArgsTableOptions, type ArgumentsRenderContext, type ArgumentsRenderFunction, COMMAND_MARKER_PREFIX, type CommandCategory, type CommandIndexOptions, type CommandInfo, type DefaultRendererOptions, type DeleteFileFs, type ExampleCommandConfig, type ExampleConfig, type ExampleExecutionResult, type ExamplesRenderContext, type ExamplesRenderFunction, type ExamplesRenderOptions, type FileConfig, type FileMapping, type FormatterFunction, GLOBAL_OPTIONS_MARKER_PREFIX, type GenerateDocConfig, type GenerateDocResult, type HeadingLevel, INDEX_MARKER_PREFIX, type OptionsRenderContext, type OptionsRenderFunction, type RenderContentOptions, type RenderFunction, type RootDocConfig, type SectionRenderFunction, type SimpleRenderContext, type SimpleRenderFunction, type SubCommandInfo, type SubcommandsRenderContext, type SubcommandsRenderFunction, type SubcommandsRenderOptions, UPDATE_GOLDEN_ENV, assertDocMatch, buildCommandInfo, collectAllCommands, commandEndMarker, commandStartMarker, compareWithExisting, createCommandRenderer, defaultRenderers, executeExamples, formatDiff, generateDoc, globalOptionsEndMarker, globalOptionsStartMarker, indexEndMarker, indexStartMarker, initDocFile, renderArgsTable, renderArgumentsList, renderArgumentsListFromArray, renderArgumentsTable, renderArgumentsTableFromArray, renderCommandIndex, renderExamplesDefault, renderOptionsList, renderOptionsListFromArray, renderOptionsTable, renderOptionsTableFromArray, renderSubcommandsTable, renderSubcommandsTableFromArray, renderUsage, resolveLazyCommand, writeFile };
 //# sourceMappingURL=index.d.ts.map

package/dist/docs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/executor/subcommand-router.ts","../../src/docs/types.ts","../../src/docs/default-renderers.ts","../../src/docs/doc-comparator.ts","../../src/docs/doc-generator.ts","../../src/docs/example-executor.ts","../../src/docs/golden-test.ts","../../src/docs/render-args.ts","../../src/docs/render-index.ts"],"mappings":";;;;;;;;;AAQA;;iBAAsB,kBAAA,CACpB,GAAA,EAAK,UAAA,UAAoB,OAAA,CAAQ,UAAA,KAChC,OAAA,CAAQ,UAAA;;;;;;UCJM,WAAA;EDEuB;ECAtC,IAAA;EDCK;ECCL,WAAA;EDDyB;ECGzB,eAAA;EDFC;ECID,WAAA;EDJQ;ECMR,KAAA;EDPyB;ECSzB,cAAA,EAAgB,iBAAA;EDThB;ECWA,OAAA,EAAS,iBAAA;EDVA;ECYT,WAAA,EAAa,cAAA;EDZM;ECcnB,SAAA,EAAW,eAAA;;EAEX,OAAA,EAAS,UAAA;EApBM;EAsBf,KAAA;;EAEA,QAAA;EAVS;EAYT,OAAA,GAAU,MAAA;EARC;EAUX,QAAA,GAAW,OAAA;EAFD;EAIV,cAAA,GAAiB,sBAAA;AAAA;;;;UAMF,cAAA;EA9Bf;EAgCA,IAAA;EA5BA;EA8BA,WAAA;EA5BgB;EA8BhB,QAAA;AAAA;;;;UAMe,sBAAA;EA5Bf;EA8BA,GAAA;EA5BA;EA8BA,IAAA;EA1BA;EA4BA,cAAA;EA1BA;EA4BA,MAAA;EA1BA;EA4BA,MAAA;EA5BuC;EA8BvC,OAAA;AAAA;;;;;UAOe,oBAAA;EAzBf;EA2BA,IAAA,gBAAoB,OAAA;EA3BZ;EA6BR,OAAA,gBAAuB,OAAA;AAAA;;;;;;;;;;;AAJzB;;KAmBY,aAAA,GAAgB,MAAA,SAAe,oBAAA;;;;KAK/B,cAAA,IAAkB,IAAA,EAAM,WAAA;;;;AALpC;;;;KAcY,qBAAA,IAAyB,cAAA,UAAwB,IAAA,EAAM,WAAA;AATnE;;;AAAA,UAciB,oBAAA;EAd8B;EAgB7C,KAAA;EAP+B;EAS/B,WAAA;AAAA;;;;UAMe,oBAAA;EAf6D;EAiB5E,OAAA,EAAS,iBAAA;EAZ0B;EAcnC,MAAA,GAAS,OAAA,EAAS,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAZ9C;EAcA,OAAA;EANe;EAQf,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,qBAAA,IAAyB,OAAA,EAAS,oBAAA;;;;UAK7B,sBAAA;EAPE;EASjB,IAAA,EAAM,iBAAA;EAfG;EAiBT,MAAA,GAAS,IAAA,EAAM,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAfzB;EAiBlB,OAAA;EAjB8C;EAmB9C,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,uBAAA,IAA2B,OAAA,EAAS,sBAAA;;;;UAK/B,wBAAA;EApBgB;EAsB/B,eAAA;EAtB4C;EAwB5C,WAAA;AAAA;;;;UAMe,wBAAA;EArB4B;EAuB3C,WAAA,EAAa,cAAA;EAnBI;EAqBjB,MAAA,GAAS,WAAA,EAAa,cAAA,IAAkB,IAAA,GAAO,wBAAA;EA3B/C;EA6BA,OAAA;EA3BA;EA6BA,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,yBAAA,IAA6B,OAAA,EAAS,wBAAA;;;;UAKjC,qBAAA;EAhCE;EAkCjB,WAAA;EAhCU;EAkCV,UAAA;;EAEA,aAAA;AAAA;AA/BF;;;AAAA,UAqCiB,qBAAA;EAjCJ;EAmCX,QAAA,EAAU,OAAA;EA7B6B;EA+BvC,OAAA,GAAU,sBAAA;EA7BG;EA+Bb,MAAA,GACE,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;EAhCsC;EAmC/C,OAAA;EA/BiB;EAiCjB,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,sBAAA,IAA0B,OAAA,EAAS,qBAAA;;;;UAK9B,mBAAA;EA5CyB;EA8CxC,OAAA;EA1CA;EA4CA,OAAA;EA5CiB;EA8CjB,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,oBAAA,IAAwB,OAAA,EAAS,mBAAA;;;;UAK5B,sBAAA;EA9CqB;EAgDpC,YAAA;EAhDoC;EAkDpC,WAAA;EA9CA;EAgDA,eAAA;EA9Ca;EAgDb,wBAAA;EA1Ce;EA4Cf,iBAAA,GAAoB,oBAAA;;EAEpB,WAAA,GAAc,oBAAA;EA1CJ;EA4CV,eAAA,GAAkB,uBAAA;EAxCN;EA0CZ,aAAA,GAAgB,qBAAA;EApCV;EAsCN,iBAAA,GAAoB,yBAAA;EAtCH;EAwCjB,WAAA,GAAc,oBAAA;EApDJ;EAsDV,YAAA,GAAe,oBAAA;EApDL;EAsDV,cAAA,GAAiB,sBAAA;AAAA;;;;UAMF,UAAA;EAvDb;EAyDF,QAAA;EApDA;EAsDA,MAAA,GAAS,cAAA;EAtDQ;EAwDjB,KAAA;EAtDU;EAwDV,WAAA;AAAA;;;AAnDF;;;;;;;;;;KAkEY,WAAA,GAAc,MAAA,oBAA0B,UAAA;;;;UAKnC,iBAAA;EA1DA;EA4Df,OAAA,EAAS,UAAA;;EAET,KAAA,EAAO,WAAA;EAlDO;EAoDd,OAAA;EAhDgB;EAkDhB,MAAA,GAAS,sBAAA;EA9CK;EAgDd,SAAA,GAAY,iBAAA;EA5CK;EA8CjB,QAAA,GAAW,aAAA;EA9C4B;;;;;EAoDvC,cAAA;AAAA;;;;UAMe,iBAAA;EAlEf;EAoEA,OAAA;EAlEA;EAoEA,KAAA,EAAO,KAAA;IAlEP,gBAoEE,IAAA,UAlEF;IAoEE,MAAA,4CAlEF;IAoEE,IAAA;EAAA;EApEqC;EAuEvC,KAAA;AAAA;;;;;KAOU,iBAAA,IAAqB,OAAA,sBAA6B,OAAA;;;;cAKjD,iBAAA;AAtDb;;;;AAAA,cA4Da,qBAAA;AAvDb;;;AAAA,iBA4DgB,kBAAA,CAAmB,WAAA;;;;iBAOnB,gBAAA,CAAiB,WAAA;;;;;ADnVjC;iBE8BgB,WAAA,CAAY,IAAA,EAAM,WAAA;;;;iBAyBlB,oBAAA,CAAqB,IAAA,EAAM,WAAA;;;;iBAqB3B,mBAAA,CAAoB,IAAA,EAAM,WAAA;;;;;;;;;;;;AD9E1C;;;iBCwIgB,kBAAA,CAAmB,IAAA,EAAM,WAAA;;;;;;;;;;;;iBAuDzB,iBAAA,CAAkB,IAAA,EAAM,WAAA;;;;iBAqDxB,sBAAA,CAAuB,IAAA,EAAM,WAAA,EAAa,eAAA;;;;iBAwC1C,2BAAA,CAA4B,OAAA,EAAS,iBAAA;;;;iBA8CrC,0BAAA,CAA2B,OAAA,EAAS,iBAAA;;;;iBAsBpC,6BAAA,CAA8B,IAAA,EAAM,iBAAA;;;;iBAqBpC,4BAAA,CAA6B,IAAA,EAAM,iBAAA;;;ADjVnD;iBCmWgB,+BAAA,CACd,WAAA,EAAa,cAAA,IACb,IAAA,EAAM,WAAA,EACN,eAAA;;;;;;;;AD1VF;;;;;;;;iBC+YgB,qBAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;;;;iBAuDO,qBAAA,CAAsB,OAAA,GAAS,sBAAA,GAA8B,cAAA;;;;cAoNhE,gBAAA;EDxoBS,yDC0oBA,sBAAA,KAAsB,cAAA,EDxoBnB;8BAAO;;;;;;;;UEvEf,aAAA;EHEK;EGApB,KAAA;;EAEA,IAAA;EHDiC;EGGjC,UAAA;AAAA;;;;iBAMc,mBAAA,CAAoB,gBAAA,UAA0B,QAAA,WAAmB,aAAA;;;;iBA6BjE,UAAA,CAAW,QAAA,UAAkB,MAAA;;;;iBAsE7B,SAAA,CAAU,QAAA,UAAkB,OAAA;;;;UA4B3B,YAAA;EACf,UAAA,SAAmB,EAAA,CAAG,UAAA;EACtB,UAAA,SAAmB,EAAA,CAAG,UAAA;AAAA;;;;;;iBC3IF,gBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,UACA,WAAA,cACC,OAAA,CAAQ,WAAA;;;;;iBAuCW,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,YACC,OAAA,CAAQ,GAAA,SAAY,WAAA;;;;;;AJ9CvB;;;;;;iBKKsB,eAAA,CACpB,QAAA,EAAU,OAAA,IACV,MAAA,EAAQ,oBAAA,EACR,WAAA,EAAa,UAAA,EACb,WAAA,cACC,OAAA,CAAQ,sBAAA;;;;;;iBC8lBW,WAAA,CAAY,MAAA,EAAQ,iBAAA,GAAoB,OAAA,CAAQ,iBAAA;;;;;iBAwQhD,cAAA,CAAe,MAAA,EAAQ,iBAAA,GAAoB,OAAA;;;;;;;;iBA6BjD,WAAA,CACd,MAAA,EAAQ,IAAA,CAAK,iBAAA,qBACb,UAAA,GAAa,YAAA;;;;;;;KC/4BH,SAAA,GAAY,MAAA,SAAe,CAAA,CAAE,OAAA;;;;KAK7B,gBAAA;EPJe,6DOMzB,OAAA;AAAA;;;;;;;;;;;;;;ANTF;;;;;;;;;;iBMgDgB,eAAA,CAAgB,IAAA,EAAM,SAAA,EAAW,OAAA,GAAU,gBAAA;;;;;;KCjC/C,eAAA;ERbU,oDQepB,KAAA;EAEA,WAAA,URhBiC;EQkBjC,QAAA,YRjBS;EQmBT,OAAA;AAAA;;;;KAMU,mBAAA;ER1BV,4DQ4BA,YAAA,0BR3BS;EQ6BT,QAAA;AAAA;;;;APjCF;;;;;;;;;;;;;;;;;;;;;;;;;;;iBO+JsB,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,UAAA,EAAY,eAAA,IACZ,OAAA,GAAU,mBAAA,GACT,OAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/executor/subcommand-router.ts","../../src/docs/render-args.ts","../../src/docs/types.ts","../../src/docs/default-renderers.ts","../../src/docs/doc-comparator.ts","../../src/docs/doc-generator.ts","../../src/docs/example-executor.ts","../../src/docs/golden-test.ts","../../src/docs/render-index.ts"],"mappings":";;;;;;;;;AAQA;;iBAAsB,kBAAA,CACpB,GAAA,EAAK,UAAA,UAAoB,OAAA,CAAQ,UAAA,KAChC,OAAA,CAAQ,UAAA;;;;;;;KCFC,SAAA,GAAY,MAAA,SAAe,CAAA,CAAE,OAAA;;;;KAK7B,gBAAA;EDJe,6DCMzB,OAAA;AAAA;;;;;;;;;;;;;;AAPF;;;;;;;;;AAKA;iBAyCgB,eAAA,CAAgB,IAAA,EAAM,SAAA,EAAW,OAAA,GAAU,gBAAA;;;;KCjD/C,YAAA;AFGZ;;;AAAA,KEEY,mBAAA;EFDuB,4DEGjC,YAAA,GAAe,YAAA,EFFN;EEIT,QAAA;AAAA;;;;UAMe,WAAA;EFXf;EEaA,IAAA;EFZS;EEcT,WAAA;EFdmB;EEgBnB,eAAA;;EAEA,WAAA;EDpBU;ECsBV,KAAA;;EAEA,cAAA,EAAgB,iBAAA;EDxBM;EC0BtB,OAAA,EAAS,iBAAA;ED1B8B;EC4BvC,WAAA,EAAa,cAAA;ED5BiC;EC8B9C,SAAA,EAAW,eAAA;EDzBe;EC2B1B,OAAA,EAAS,UAAA;EDzBT;EC2BA,KAAA;EDYc;ECVd,QAAA;;EAEA,OAAA,GAAU,MAAA;EDQ0B;ECNpC,QAAA,GAAW,OAAA;EDM8C;ECJzD,cAAA,GAAiB,sBAAA;AAAA;;;;UAMF,cAAA;EAnDL;EAqDV,IAAA;;EAEA,WAAA;EAvDsB;EAyDtB,QAAA;AAAA;;;;UAMe,sBAAA;EAtDf;EAwDA,GAAA;EAxDQ;EA0DR,IAAA;EApD0B;EAsD1B,cAAA;EA1CgB;EA4ChB,MAAA;EAxCa;EA0Cb,MAAA;EAtCS;EAwCT,OAAA;AAAA;;;;;UAOe,oBAAA;EA7Df;EA+DA,IAAA,gBAAoB,OAAA;EA3DpB;EA6DA,OAAA,gBAAuB,OAAA;AAAA;;;;;;;;;;;;;KAeb,aAAA,GAAgB,MAAA,SAAe,oBAAA;;;;KAK/B,cAAA,IAAkB,IAAA,EAAM,WAAA;;AAvDpC;;;;;;KAgEY,qBAAA,IAAyB,cAAA,UAAwB,IAAA,EAAM,WAAA;;;AApDnE;UAyDiB,oBAAA;;EAEf,KAAA;EAzDA;EA2DA,WAAA;AAAA;;;;UAMe,oBAAA;EAvDR;EAyDP,OAAA,EAAS,iBAAA;EAlD0B;EAoDnC,MAAA,GAAS,OAAA,EAAS,iBAAA,IAAqB,IAAA,GAAO,oBAAA;EAhDhB;EAkD9B,OAAA;EApDoB;EAsDpB,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,qBAAA,IAAyB,OAAA,EAAS,oBAAA;;AAvC9C;;UA4CiB,sBAAA;EA5CW;EA8C1B,IAAA,EAAM,iBAAA;EAzCI;EA2CV,MAAA,GAAS,IAAA,EAAM,iBAAA,IAAqB,IAAA,GAAO,oBAAA;;EAE3C,OAAA;EA7C6C;EA+C7C,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,uBAAA,IAA2B,OAAA,EAAS,sBAAA;;;;UAK/B,wBAAA;EA7C6D;EA+C5E,eAAA;EA1Ce;EA4Cf,WAAA;AAAA;;;AAlCF;UAwCiB,wBAAA;;EAEf,WAAA,EAAa,cAAA;EAtCK;EAwClB,MAAA,GAAS,WAAA,EAAa,cAAA,IAAkB,IAAA,GAAO,wBAAA;EApCzC;EAsCN,OAAA;EAtCiB;EAwCjB,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,yBAAA,IAA6B,OAAA,EAAS,wBAAA;;;;UAKjC,qBAAA;EAjDf;EAmDA,WAAA;EAjDM;EAmDN,UAAA;EAnDiB;EAqDjB,aAAA;AAAA;;;;UAMe,qBAAA;EApDsB;EAsDrC,QAAA,EAAU,OAAA;EApDJ;EAsDN,OAAA,GAAU,sBAAA;EApDiC;EAsD3C,MAAA,GACE,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;EArDQ;EAwDjB,OAAA;EA9DA;EAgEA,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,sBAAA,IAA0B,OAAA,EAAS,qBAAA;;;;UAK9B,mBAAA;EAjEf;EAmEA,OAAA;EAnEiB;EAqEjB,OAAA;EAnEU;EAqEV,IAAA,EAAM,WAAA;AAAA;AAAA,KAEI,oBAAA,IAAwB,OAAA,EAAS,mBAAA;;AAlE7C;;UAuEiB,sBAAA;EArEf;EAuEA,YAAA,GAAe,YAAA;EA/DA;EAiEf,WAAA;;EAEA,eAAA;EA/DsB;EAiEtB,wBAAA;EA7DM;EA+DN,iBAAA,GAAoB,oBAAA;EA/DH;EAiEjB,WAAA,GAAc,oBAAA;EAvED;EAyEb,eAAA,GAAkB,uBAAA;EAvEI;EAyEtB,aAAA,GAAgB,qBAAA;EAzE+B;EA2E/C,iBAAA,GAAoB,yBAAA;EAzEpB;EA2EA,WAAA,GAAc,oBAAA;EAzER;EA2EN,YAAA,GAAe,oBAAA;EA3EE;EA6EjB,cAAA,GAAiB,sBAAA;AAAA;;;;AAtEnB;UA6EiB,aAAA;;EAEf,IAAA;EA7EA;;;;EAkFA,aAAA,GAAgB,SAAA;IAAc,IAAA,EAAM,SAAA;IAAW,OAAA,GAAU,gBAAA;EAAA;EAtE/C;EAwEV,YAAA,GAAe,YAAA;EAnEH;EAqEZ,KAAA,GAAQ,mBAAA;AAAA;;;;UAMO,UAAA;EAhFL;EAkFV,QAAA;EAhFU;EAkFV,MAAA,GAAS,cAAA;EA/EG;EAiFZ,KAAA;EAhFY;EAkFZ,WAAA;AAAA;;;;;;;AA1EF;;;;;AAKA;KAoFY,WAAA,GAAc,MAAA,oBAA0B,UAAA;;;;UAKnC,iBAAA;EAnFf;EAqFA,OAAA,EAAS,UAAA;EArFQ;;AAEnB;;;EAyFE,OAAA,GAAU,aAAA;EAzFoD;EA2F9D,KAAA,EAAO,WAAA;EAtF8B;EAwFrC,OAAA;EAtFe;EAwFf,MAAA,GAAS,sBAAA;EA9EK;EAgFd,SAAA,GAAY,iBAAA;EA5EI;EA8EhB,QAAA,GAAW,aAAA;EA1EG;;;;;EAgFd,cAAA;AAAA;;;;UAMe,iBAAA;EAhGK;EAkGpB,OAAA;EAhGc;EAkGd,KAAA,EAAO,KAAA;IAhGW,gBAkGhB,IAAA,UAhGc;IAkGd,MAAA,4CAhGkB;IAkGlB,IAAA;EAAA;EA9FF;EAiGA,KAAA;AAAA;;;;AAxFF;KA+FY,iBAAA,IAAqB,OAAA,sBAA6B,OAAA;;;;cAKjD,iBAAA;;;;;cAMA,qBAAA;;;;iBAKG,kBAAA,CAAmB,WAAA;;;;iBAOnB,gBAAA,CAAiB,WAAA;;;;;cAQpB,4BAAA;;;;iBAKG,wBAAA,CAAA;;;;iBAOA,sBAAA,CAAA;;;AAlGhB;;cA0Ga,mBAAA;;;AArGb;iBA0GgB,gBAAA,CAAA;;;;iBAOA,cAAA,CAAA;;;;;AFjahB;iBG8BgB,WAAA,CAAY,IAAA,EAAM,WAAA;;;;iBAyBlB,oBAAA,CAAqB,IAAA,EAAM,WAAA;;;;iBAqB3B,mBAAA,CAAoB,IAAA,EAAM,WAAA;;;;;;;;;;;;AF5E1C;;;iBEsIgB,kBAAA,CAAmB,IAAA,EAAM,WAAA;;;;;;AFjIzC;;;;;AAyCA;iBE+IgB,iBAAA,CAAkB,IAAA,EAAM,WAAA;;;;iBAqDxB,sBAAA,CAAuB,IAAA,EAAM,WAAA,EAAa,eAAA;;;;iBAwC1C,2BAAA,CAA4B,OAAA,EAAS,iBAAA;;;;iBA8CrC,0BAAA,CAA2B,OAAA,EAAS,iBAAA;;;;iBAsBpC,6BAAA,CAA8B,IAAA,EAAM,iBAAA;AD5VpD;;;AAAA,iBCiXgB,4BAAA,CAA6B,IAAA,EAAM,iBAAA;;;;iBAkBnC,+BAAA,CACd,WAAA,EAAa,cAAA,IACb,IAAA,EAAM,WAAA,EACN,eAAA;;AD5XF;;;;;;;;;;;;;;iBCibgB,qBAAA,CACd,QAAA,EAAU,OAAA,IACV,OAAA,GAAU,sBAAA,IACV,IAAA,GAAO,qBAAA;;;;iBAuDO,qBAAA,CAAsB,OAAA,GAAS,sBAAA,GAA8B,cAAA;;;;cAoNhE,gBAAA;ED/qBE,yDCirBO,sBAAA,KAAsB,cAAA,ED/qB/B;8BAEF;;;;;;;;UElCM,aAAA;EJEK;EIApB,KAAA;;EAEA,IAAA;EJDiC;EIGjC,UAAA;AAAA;;;;iBAMc,mBAAA,CAAoB,gBAAA,UAA0B,QAAA,WAAmB,aAAA;;;;iBA6BjE,UAAA,CAAW,QAAA,UAAkB,MAAA;;;;iBAsE7B,SAAA,CAAU,QAAA,UAAkB,OAAA;;;;UA4B3B,YAAA;EACf,UAAA,SAAmB,EAAA,CAAG,UAAA;EACtB,UAAA,SAAmB,EAAA,CAAG,UAAA;AAAA;;;;;;iBC3IF,gBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,UACA,WAAA,cACC,OAAA,CAAQ,WAAA;;;;;iBAuCW,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,QAAA,YACC,OAAA,CAAQ,GAAA,SAAY,WAAA;;;;;;AL9CvB;;;;;;iBMKsB,eAAA,CACpB,QAAA,EAAU,OAAA,IACV,MAAA,EAAQ,oBAAA,EACR,WAAA,EAAa,UAAA,EACb,WAAA,cACC,OAAA,CAAQ,sBAAA;;;;;;iBC0pCW,WAAA,CAAY,MAAA,EAAQ,iBAAA,GAAoB,OAAA,CAAQ,iBAAA;;;;;iBAiYhD,cAAA,CAAe,MAAA,EAAQ,iBAAA,GAAoB,OAAA;;;;;;;;iBA6BjD,WAAA,CACd,MAAA,EAAQ,IAAA,CAAK,iBAAA,qBACb,UAAA,GAAa,YAAA;;;;;;KCvjDH,eAAA;ERb4B,oDQetC,KAAA,URdK;EQgBL,WAAA,URhByB;EQkBzB,QAAA,YRjBC;EQmBD,OAAA;AAAA;;;;;;;;;;;APrBF;;;;;;;;;AAKA;;;;;AAyCA;;;;;;iBOuGsB,kBAAA,CACpB,OAAA,EAAS,UAAA,EACT,UAAA,EAAY,eAAA,IACZ,OAAA,GAAU,mBAAA,GACT,OAAA"}