feat(cli): implement output abstraction layer

2026-01-28 22:57:15 +07:00
parent aa5663a854
commit a7f39f79ba
12 changed files with 916 additions and 2 deletions
@@ -0,0 +1,62 @@
+/**
+ * Output abstraction layer for the Paseo CLI.
+ *
+ * This module provides structured output rendering with support for multiple formats:
+ * - table: Human-readable aligned tables (default)
+ * - json: Machine-readable JSON
+ * - yaml: Machine-readable YAML
+ * - quiet: Minimal output (IDs only)
+ *
+ * @example
+ * ```typescript
+ * import { withOutput, render, type ListResult, type OutputSchema } from './output/index.js'
+ *
+ * // Define your data type
+ * interface Agent { id: string; title: string; status: string }
+ *
+ * // Define how to render it
+ * const schema: OutputSchema<Agent> = {
+ *   idField: 'id',
+ *   columns: [
+ *     { header: 'ID', field: 'id' },
+ *     { header: 'TITLE', field: 'title' },
+ *     { header: 'STATUS', field: 'status', color: (v) => v === 'running' ? 'green' : undefined },
+ *   ],
+ * }
+ *
+ * // Return structured data from commands
+ * const result: ListResult<Agent> = {
+ *   type: 'list',
+ *   data: agents,
+ *   schema,
+ * }
+ *
+ * // Render with options
+ * const output = render(result, { format: 'json' })
+ * ```
+ */
+
+// Types
+export type {
+  OutputFormat,
+  OutputOptions,
+  ColumnDef,
+  OutputSchema,
+  CommandResult,
+  SingleResult,
+  ListResult,
+  AnyCommandResult,
+  CommandError,
+} from './types.js'
+
+// Renderers
+export { renderTable, renderTableHeader, renderTableRow } from './table.js'
+export { renderJson, renderJsonLine } from './json.js'
+export { renderYaml, renderYamlDoc } from './yaml.js'
+export { renderQuiet } from './quiet.js'
+
+// Main render function
+export { render, renderError, toCommandError, defaultOutputOptions } from './render.js'
+
+// Command wrapper
+export { withOutput, createOutputOptions, type CommandOptions } from './with-output.js'