Something went wrong. Try again.
fork of hey-api/openapi-ts because I need some additional things
Something went wrong. Try again.
3.6 kB · 120 lines
TypeScript
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121import colors from 'ansi-colors';
import type { IR } from '../ir/types';import { httpMethods } from '../openApi/shared/utils/operation';
export interface PrintOptions { /** * Indentation depth for `JSON.stringify()` when printing objects. * * @default 2 */ depth?: number; /** * Which section of the IR to print. Use 'all' to print every section. * * @default 'all' */ section?: keyof IR.Model | 'all'; /** * How much detail to print. * * - `summary` → only keys, names, operationIds, status codes * - `full` → dump full JSON structures * * @default 'summary' */ verbosity?: 'full' | 'summary';}
const indent = (level: number) => ' '.repeat(level);
const log = (message: string, level?: number) => console.log(`${indent(level ?? 0)}${message}`);
const print = (ir: IR.Model, options: PrintOptions = {}) => { const { depth = 2, section = 'all', verbosity = 'summary' } = options;
const printObject = ( obj: unknown, level: number, kind: 'responses' | 'requestBody' | 'schema' | 'generic' = 'generic', ) => { if (verbosity === 'summary' && obj && typeof obj === 'object') { if (kind === 'responses') { const count = Object.keys(obj).length; const noun = count === 1 ? 'code' : 'codes'; log(`responses: ${colors.yellow(`${count} ${noun}`)}`, level); } else if (kind === 'requestBody') { log(`requestBody: ${Object.keys(obj).join(', ')}`, level); } else if (kind === 'schema') { log(`schema keys: ${Object.keys(obj).join(', ')}`, level); } else { log(`keys: ${Object.keys(obj).join(', ')}`, level); } } else { log(JSON.stringify(obj, null, depth), level); } };
const printPathItem = ( key: string, item: IR.PathItemObject | IR.ReferenceObject, base: number = 1, ) => { if ('$ref' in item) { log(`${colors.cyan(key)} is a $ref → ${colors.yellow(item.$ref)}`, base); return; }
for (const method of Object.keys(item) as Array<keyof IR.PathItemObject>) { if (!httpMethods.includes(method)) continue;
const operation = item[method]!; log( `${colors.green(method.toUpperCase())} ${colors.cyan(key)} (${colors.magenta(operation.operationId ?? '')})`, base, );
if (operation.body) printObject(operation.body, base + 1, 'requestBody'); if (operation.responses) printObject(operation.responses, base + 1, 'responses'); } };
const sections = section === 'all' ? (Object.keys(ir) as unknown as ReadonlyArray<keyof IR.Model>) : [section];
for (const section of sections) { switch (section) { case 'components': if (ir.components?.schemas) { log(`Components: ${Object.keys(ir.components.schemas).length} schemas`); for (const [, schema] of Object.entries(ir.components.schemas)) { printObject(schema, 1, 'schema'); } } break; case 'paths': { const paths = ir.paths || {}; log(`paths (${Object.keys(paths).length} items):`); for (const [path, item] of Object.entries(paths)) { printPathItem(path, item); } break; } case 'servers': break; case 'webhooks': { const webhooks = ir.webhooks || {}; log(`webhooks (${Object.keys(webhooks).length} items):`); for (const [path, item] of Object.entries(webhooks)) { printPathItem(path, item); } break; } } }};
export const ir = { print,} as const;