Replace Prettier with Biome as the code formatter to improve performance during the code generation phase (#1145)

Signed-off-by: Sora Morimoto <[email protected]>

Author: smorimoto

.changeset/twelve-plants-invent.md

@@ -0,0 +1,5 @@
+---
+"swagger-typescript-api": patch
+---
+
+Replace Prettier with Biome as the code formatter to improve performance during the code generation phase.

README.md

@@ -108,13 +108,6 @@ generateApi({
   extractRequestBody: false,
   extractEnums: false,
   unwrapResponseData: false,
-  prettier: {
-    // By default prettier config is load from your project
-    printWidth: 120,
-    tabWidth: 2,
-    trailingComma: "all",
-    parser: "typescript",
-  },
   defaultResponseType: "void",
   singleHttpClient: true,
   cleanOutput: false,

package.json

@@ -43,16 +43,16 @@
     "test": "vitest run"
   },
   "dependencies": {
+    "@biomejs/js-api": "^0.7.1",
+    "@biomejs/wasm-nodejs": "^1.9.4",
     "@types/swagger-schema-official": "^2.0.25",
     "c12": "^3.0.2",
     "citty": "^0.1.6",
     "consola": "^3.4.2",
-    "cosmiconfig": "^9.0.0",
     "eta": "^2.2.0",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "nanoid": "^5.1.5",
-    "prettier": "~3.5.3",
     "swagger-schema-official": "2.0.0-bab6bed",
     "swagger2openapi": "^7.0.8",
     "typescript": "~5.8.2"

src/code-formatter.ts

@@ -1,4 +1,6 @@
-import * as prettier from "prettier";
+import * as path from "node:path";
+import { Biome, Distribution } from "@biomejs/js-api";
+import * as nanoid from "nanoid";
 import * as typescript from "typescript";
 import type { CodeGenConfig } from "./configuration.js";
 
@@ -34,23 +36,27 @@ export class CodeFormatter {
     return content;
   };
 
-  prettierFormat = async (content: string) => {
-    const formatted = await prettier.format(
-      content,
-      this.config.prettierOptions,
-    );
-    return formatted;
+  format = async (content: string) => {
+    const biome = await Biome.create({ distribution: Distribution.NODE });
+    biome.applyConfiguration({
+      files: { maxSize: Number.MAX_SAFE_INTEGER },
+      formatter: { indentStyle: "space" },
+    });
+    const formatted = biome.formatContent(content, {
+      filePath: path.format({ name: nanoid.nanoid(), ext: "ts" }),
+    });
+    return formatted.content;
   };
 
   formatCode = async (
     code: string,
-    { removeUnusedImports = true, prettierFormat = true } = {},
+    { removeUnusedImports = true, format = true } = {},
   ) => {
     if (removeUnusedImports) {
       code = this.removeUnusedImports(code);
     }
-    if (prettierFormat) {
-      code = await this.prettierFormat(code);
+    if (format) {
+      code = await this.format(code);
     }
     return code;
   };

src/configuration.ts

@@ -1,4 +1,3 @@
-import * as cosmiconfig from "cosmiconfig";
 import lodash from "lodash";
 import type { OpenAPI } from "openapi-types";
 import * as typescript from "typescript";
@@ -87,7 +86,6 @@ export class CodeGenConfig {
     outOfModuleApi: "Common",
   };
   routeNameDuplicatesMap = new Map();
-  prettierOptions = { ...CONSTANTS.PRETTIER_OPTIONS };
   hooks: Hooks = {
     onPreBuildRoutePath: (_routePath: unknown) => void 0,
     onBuildRoutePath: (_routeData: unknown) => void 0,
@@ -390,7 +388,6 @@ export class CodeGenConfig {
   templateExtensions = [".eta", ".ejs"];
 
   constructor({
-    prettierOptions = getDefaultPrettierOptions(),
     codeGenConstructs,
     primitiveTypeConstructs,
     constants,
@@ -405,10 +402,6 @@ export class CodeGenConfig {
 
     this.update({
       ...otherConfig,
-      prettierOptions:
-        prettierOptions === undefined
-          ? getDefaultPrettierOptions()
-          : prettierOptions,
       hooks: lodash.merge(this.hooks, hooks || {}),
       constants: {
         ...CONSTANTS,
@@ -430,20 +423,3 @@ export class CodeGenConfig {
     objectAssign(this, update);
   };
 }
-
-const getDefaultPrettierOptions = () => {
-  const prettier = cosmiconfig
-    .cosmiconfigSync("prettier", {
-      searchStrategy: "global",
-    })
-    .search();
-
-  if (prettier) {
-    return {
-      ...prettier.config,
-      parser: "typescript",
-    };
-  }
-
-  return { ...CONSTANTS.PRETTIER_OPTIONS };
-};

src/constants.ts

@@ -21,13 +21,6 @@ export const HTTP_CLIENT = {
   AXIOS: "axios",
 } as const;
 
-export const PRETTIER_OPTIONS = {
-  printWidth: 120,
-  tabWidth: 2,
-  trailingComma: "all",
-  parser: "typescript",
-} as const;
-
 export const PROJECT_VERSION = packageJson.version;
 
 export const RESERVED_BODY_ARG_NAMES = ["data", "body", "reqBody"];