Add pretty for GenerationReport

Author: ryukzak

README.md

@@ -62,15 +62,15 @@ yarn add @atomic-ehr/codegen
 1. Write SDK generation script (`generate-types.ts`):
 
     ```typescript
-    import { APIBuilder } from '@atomic-ehr/codegen';
+    import { APIBuilder, prettyReport } from '@atomic-ehr/codegen';
 
     const builder = new APIBuilder()
         .fromPackage("hl7.fhir.r4.core", "4.0.1")
         .typescript({})
         .outputTo("./examples/typescript-r4/fhir-types");
 
     const report = await builder.generate();
-    console.log(report);
+    console.log(prettyReport(report));
     ```
 
 2. Run the script with:

examples/csharp/generate.ts

@@ -1,4 +1,4 @@
-import { APIBuilder } from "../../src";
+import { APIBuilder, prettyReport } from "../../src";
 
 if (require.main === module) {
     console.log("📦 Generating FHIR R4 Core Types...");
@@ -14,12 +14,7 @@ if (require.main === module) {
 
     const report = await builder.generate();
 
-    console.log(report);
+    console.log(prettyReport(report));
 
-    if (report.success) {
-        console.log("✅ FHIR R4 types generated successfully!");
-    } else {
-        console.error("❌ FHIR R4 types generation failed.");
-        process.exit(1);
-    }
+    if (!report.success) process.exit(1);
 }

examples/local-package-folder/generate.ts

@@ -1,6 +1,6 @@
 import * as Path from "node:path";
 import { fileURLToPath } from "node:url";
-import { APIBuilder, LogLevel } from "../../src/api";
+import { APIBuilder, LogLevel, prettyReport } from "../../src/api";
 
 const __dirname = Path.dirname(fileURLToPath(import.meta.url));
 
@@ -9,7 +9,7 @@ async function generateFromLocalPackageFolder() {
         logLevel: LogLevel.INFO,
     });
 
-    await builder
+    const report = await builder
         .localStructureDefinitions({
             package: { name: "example.folder.structures", version: "0.0.1" },
             path: Path.join(__dirname, "structure-definitions"),
@@ -23,6 +23,9 @@ async function generateFromLocalPackageFolder() {
         })
         .outputTo("./examples/local-package-folder")
         .generate();
+
+    console.log(prettyReport(report));
+    if (!report.success) process.exit(1);
 }
 
 generateFromLocalPackageFolder().catch((error) => {

examples/python/generate.ts

@@ -1,4 +1,4 @@
-import { APIBuilder } from "../../src";
+import { APIBuilder, prettyReport } from "../../src";
 
 if (require.main === module) {
     console.log("📦 Generating FHIR R4 Core Types...");
@@ -16,12 +16,9 @@ if (require.main === module) {
 
     const report = await builder.generate();
 
-    console.log(report);
+    console.log(prettyReport(report));
 
-    if (report.success) {
-        console.log("✅ FHIR R4 types generated successfully!");
-    } else {
-        console.error("❌ FHIR R4 types generation failed.");
+    if (!report.success) {
         process.exit(1);
     }
 }

examples/typescript-ccda/generate.ts

@@ -1,7 +1,7 @@
 // Run this script using Bun CLI with:
 // bun run scripts/generate-fhir-types.ts
 
-import { APIBuilder } from "../../src/api/builder";
+import { APIBuilder, prettyReport } from "../../src/api/builder";
 
 if (require.main === module) {
     console.log("📦 Generating FHIR R4 Core Types...");
@@ -16,12 +16,7 @@ if (require.main === module) {
         .cleanOutput(true);
 
     const report = await builder.generate();
-    console.log(report);
+    console.log(prettyReport(report));
 
-    if (report.success) {
-        console.log("✅ FHIR R4 types generated successfully!");
-    } else {
-        console.error("❌ FHIR R4 types generation failed.");
-        process.exit(1);
-    }
+    if (!report.success) process.exit(1);
 }

examples/typescript-r4/generate.ts

@@ -1,7 +1,7 @@
 // Run this script using Bun CLI with:
 // bun run scripts/generate-fhir-types.ts
 
-import { APIBuilder } from "../../src/api/builder";
+import { APIBuilder, prettyReport } from "../../src/api/builder";
 
 if (require.main === module) {
     console.log("📦 Generating FHIR R4 Core Types...");
@@ -37,13 +37,6 @@ if (require.main === module) {
         .cleanOutput(true);
 
     const report = await builder.generate();
-
-    console.log(report);
-
-    if (report.success) {
-        console.log("✅ FHIR R4 types generated successfully!");
-    } else {
-        console.error("❌ FHIR R4 types generation failed.");
-        process.exit(1);
-    }
+    console.log(prettyReport(report));
+    if (!report.success) process.exit(1);
 }

src/api/builder.ts

@@ -59,17 +59,33 @@ export interface APIBuilderOptions {
  */
 export type ProgressCallback = (phase: string, current: number, total: number, message?: string) => void;
 
-/**
- * Generation result information
- */
-export interface GenerationResult {
+export type GenerationReport = {
     success: boolean;
     outputDir: string;
     filesGenerated: Record<string, string>;
     errors: string[];
     warnings: string[];
     duration: number;
-}
+};
+
+export const prettyReport = (report: GenerationReport): string => {
+    const { success, filesGenerated, errors, warnings, duration } = report;
+    const errorsStr = errors.length > 0 ? `Errors: ${errors.join(", ")}` : undefined;
+    const warningsStr = warnings.length > 0 ? `Warnings: ${warnings.join(", ")}` : undefined;
+    const files = Object.entries(filesGenerated)
+        .map(([path, content]) => `  - ${path} (${content.split("\n").length} loc)`)
+        .join("\n");
+    return [
+        "Generated files:",
+        files,
+        errorsStr,
+        warningsStr,
+        `Duration: ${Math.round(duration)}ms`,
+        `Status: ${success ? "🟩 Success" : "🟥 Failure"}`,
+    ]
+        .filter((e) => e)
+        .join("\n");
+};
 
 export interface GeneratedFile {
     fullFileName: string;
@@ -400,9 +416,9 @@ export class APIBuilder {
         return this;
     }
 
-    async generate(): Promise<GenerationResult> {
+    async generate(): Promise<GenerationReport> {
         const startTime = performance.now();
-        const result: GenerationResult = {
+        const result: GenerationReport = {
             success: false,
             outputDir: this.options.outputDir,
             filesGenerated: {},
@@ -512,7 +528,7 @@ export class APIBuilder {
         return Array.from(this.generators.keys());
     }
 
-    private async executeGenerators(result: GenerationResult, tsIndex: TypeSchemaIndex): Promise<void> {
+    private async executeGenerators(result: GenerationReport, tsIndex: TypeSchemaIndex): Promise<void> {
         for (const [type, generator] of this.generators.entries()) {
             this.logger.info(`Generating ${type}...`);
 

src/api/index.ts

@@ -9,6 +9,6 @@
 
 export { LogLevel } from "../utils/codegen-logger";
 export type { APIBuilderOptions, LocalStructureDefinitionConfig } from "./builder";
-export { APIBuilder } from "./builder";
+export { APIBuilder, prettyReport } from "./builder";
 export type { CSharpGeneratorOptions } from "./writer-generator/csharp/csharp";
 export type { TypeScriptOptions } from "./writer-generator/typescript";