fix: throw formatting errors, generate missing slug/tag

Author: mnahkies

packages/documentation/src/lib/playground.tsx

@@ -50,7 +50,7 @@ const defaultConfig = {
   enableRuntimeResponseValidation: true,
   extractInlineSchemas: true,
   allowUnusedImports: false,
-  groupingStrategy: "none",
+  groupingStrategy: "first-tag",
   tsAllowAny: false,
   tsCompilerOptions: {exactOptionalPropertyTypes: false},
   enableTypedBasePaths: true,

packages/openapi-code-generator/src/core/input.ts

@@ -169,9 +169,7 @@ export class Input {
       const tag = operation.tags[0]
 
       if (!tag) {
-        throw new Error(
-          `cannot group operations by first tag as operationId: '${operation.operationId}' has no tags`,
-        )
+        return "generated"
       }
 
       return tag.toLowerCase()
@@ -185,9 +183,7 @@ export class Input {
       ).replace(/[{}]*/g, "")
 
       if (!slug) {
-        throw new Error(
-          `cannot group operations by first slug as operationId: '${operation.operationId}' has no slugs`,
-        )
+        return "generated"
       }
 
       return slug.toLowerCase()

packages/openapi-code-generator/src/core/interfaces.ts

@@ -1,3 +1,3 @@
 export interface IFormatter {
-  format(filename: string, raw: string): Promise<string>
+  format(filename: string, raw: string): Promise<{result: string; err?: Error}>
 }

packages/openapi-code-generator/src/typescript/common/client-servers-builder.spec.ts

@@ -29,7 +29,7 @@ async function runTest(
   const formatter = await TypescriptFormatterBiome.createNodeFormatter()
 
   return {
-    output: await formatter.format("unit-test.ts", builder.toString()),
+    output: (await formatter.format("unit-test.ts", builder.toString())).result,
     hasServers: builder.hasServers,
     hasOperationServers: builder.hasOperationServers,
     builder,

packages/openapi-code-generator/src/typescript/common/schema-builders/schema-builder.test-utils.ts

@@ -66,7 +66,7 @@ export function schemaBuilderTestHarness(
           const x = ${schema}
         `,
       )
-    ).trim()
+    ).result.trim()
 
     const schemas = (
       await formatter.format(
@@ -76,7 +76,7 @@ export function schemaBuilderTestHarness(
           includeHeader: false,
         }),
       )
-    ).trim()
+    ).result.trim()
 
     return {
       code,

packages/openapi-code-generator/src/typescript/common/type-builder.spec.ts

@@ -461,10 +461,10 @@ describe.each(testVersions)(
           const x: ${type}
         `,
           )
-        ).trim(),
+        ).result.trim(),
         types: (
           await formatter.format("unit-test.types.ts", builder.toString())
-        ).trim(),
+        ).result.trim(),
       }
     }
   },

packages/openapi-code-generator/src/typescript/common/typescript-emitter.ts

@@ -25,32 +25,46 @@ export class TypescriptEmitter {
         }
       })
 
-    logger.time("format output")
+    logger.time("format and write output")
 
-    await Promise.all(
+    const result = await Promise.allSettled(
       outputs.map(async (output) => {
-        output.data = await this.formatter.format(output.filename, output.data)
+        const {result, err} = await this.formatter.format(
+          output.filename,
+          output.data,
+        )
+        output.data = result
+        await this.writeOutput(output.filename, output.data)
+
+        if (err) {
+          throw err
+        }
       }),
     )
 
-    logger.time("write output")
+    const error = result.find((result) => result.status === "rejected")
 
-    await Promise.all(
-      outputs.map(async (output) => {
-        await this.writeOutput(output.filename, output.data)
-      }),
-    )
+    if (error) {
+      throw error.reason
+    }
   }
 
   private async writeOutput(filename: string, data: string) {
-    const outputDirectory = path.dirname(
-      path.join(this.config.destinationDirectory, filename),
-    )
-    const outputFilepath = path.join(this.config.destinationDirectory, filename)
+    try {
+      const outputDirectory = path.dirname(
+        path.join(this.config.destinationDirectory, filename),
+      )
+      const outputFilepath = path.join(
+        this.config.destinationDirectory,
+        filename,
+      )
 
-    await this.fsAdaptor.mkDir(outputDirectory, true)
-    await this.fsAdaptor.writeFile(outputFilepath, data)
+      await this.fsAdaptor.mkDir(outputDirectory, true)
+      await this.fsAdaptor.writeFile(outputFilepath, data)
 
-    logger.info(`Wrote ${outputFilepath}`)
+      logger.info(`Wrote ${outputFilepath}`)
+    } catch (err) {
+      throw new Error(`failed to write ${filename}`, {cause: err})
+    }
   }
 }

packages/openapi-code-generator/src/typescript/common/typescript-formatter.biome.ts

@@ -28,20 +28,27 @@ export class TypescriptFormatterBiome implements IFormatter {
     })
   }
 
-  async format(filename: string, raw: string): Promise<string> {
+  async format(
+    filename: string,
+    raw: string,
+  ): Promise<{result: string; err?: Error}> {
+    const trimmed = raw
+      .split("\n")
+      .map((it) => it.trim())
+      .join("\n")
+
     try {
-      const trimmed = raw
-        .split("\n")
-        .map((it) => it.trim())
-        .join("\n")
       const formatted = this.biome.formatContent(trimmed, {
         filePath: filename,
       })
 
-      return formatted.content
+      return {result: formatted.content}
     } catch (err) {
       logger.error("failed to format", {err})
-      return raw
+      return {
+        result: trimmed,
+        err: new Error(`failed to format ${filename}`, {cause: err}),
+      }
     }
   }
 

packages/openapi-code-generator/src/typescript/common/typescript-formatter.prettier.ts

@@ -9,22 +9,30 @@ const plugins = [
 export class TypescriptFormatterPrettier implements IFormatter {
   private constructor() {}
 
-  async format(filename: string, raw: string): Promise<string> {
-    try {
-      const trimmed = raw
-        .split("\n")
-        .map((it) => it.trim())
-        .join("\n")
+  async format(
+    filename: string,
+    raw: string,
+  ): Promise<{result: string; err?: Error}> {
+    const trimmed = raw
+      .split("\n")
+      .map((it) => it.trim())
+      .join("\n")
 
-      return prettier.format(trimmed, {
+    try {
+      const formatted = await prettier.format(trimmed, {
         semi: false,
         arrowParens: "always",
         parser: "typescript",
         plugins,
       })
+
+      return {result: formatted}
     } catch (err) {
       logger.error("failed to format", {err})
-      return raw
+      return {
+        result: trimmed,
+        err: new Error(`failed to format ${filename}`, {cause: err}),
+      }
     }
   }
 

packages/openapi-code-generator/src/typescript/typescript-koa/typescript-koa.generator.spec.ts

@@ -102,10 +102,12 @@ describe("typescript/typescript-koa", () => {
         tags: [],
       })
 
-      return formatter.format(
-        "unit-test.ts",
-        serverRouterBuilder.implementationExport("UnitTestImplementation"),
-      )
+      return (
+        await formatter.format(
+          "unit-test.ts",
+          serverRouterBuilder.implementationExport("UnitTestImplementation"),
+        )
+      ).result
     }
   })
 })