feat: disable formatting with prettier by default

.changeset/famous-bugs-laugh.md

@@ -0,0 +1,5 @@
+---
+"@hey-api/openapi-ts": minor
+---
+
+change: disable formatting with prettier by default

docs/openapi-ts/configuration.md

@@ -103,29 +103,29 @@ You might not need a `node` client. Fetch API is [experimental](https://nodejs.o
 
 ## Formatting
 
-By default, `openapi-ts` will automatically format your client according to your project configuration. To disable automatic formatting, set `format` to false.
+By default, `openapi-ts` will not automatically format your client. To enable this feature, set `format` to a valid formatter.
 
 ::: code-group
 
-```js{2} [prettier]
+```js{2} [disabled]
 export default {
-  format: 'prettier',
+  format: false,
   input: 'path/to/openapi.json',
   output: 'src/client',
 }
 ```
 
-```js{2} [biome]
+```js{2} [prettier]
 export default {
-  format: 'biome',
+  format: 'prettier',
   input: 'path/to/openapi.json',
   output: 'src/client',
 }
 ```
 
-```js{2} [disabled]
+```js{2} [biome]
 export default {
-  format: false,
+  format: 'biome',
   input: 'path/to/openapi.json',
   output: 'src/client',
 }

docs/openapi-ts/migrating.md

@@ -52,7 +52,7 @@ This config option is deprecated and will be removed.
 
 ### Changed `format`
 
-This config option has changed. You now need to specify a value (`biome` or `prettier`) to format the output (default: `prettier`).
+This config option has changed. You now need to specify a value (`biome` or `prettier`) to format the output (default: `false`).
 
 ```js{2}
 export default {

packages/openapi-ts/src/compiler/classes.ts

@@ -2,7 +2,7 @@ import ts from 'typescript';
 
 import { createTypeNode } from './typedef';
 import { toExpression } from './types';
-import { addLeadingComment, Comments, isType } from './utils';
+import { addLeadingJSDocComment, Comments, isType } from './utils';
 
 type AccessLevel = 'public' | 'protected' | 'private';
 
@@ -87,7 +87,7 @@ export const createConstructorDeclaration = ({
     ts.factory.createBlock(statements, multiLine),
   );
   if (comment?.length) {
-    addLeadingComment(node, comment);
+    addLeadingJSDocComment(node, comment);
   }
   return node;
 };
@@ -138,7 +138,7 @@ export const createMethodDeclaration = ({
     ts.factory.createBlock(statements, multiLine),
   );
   if (comment?.length) {
-    addLeadingComment(node, comment);
+    addLeadingJSDocComment(node, comment);
   }
   return node;
 };
@@ -214,7 +214,9 @@ export const createReturnFunctionCall = ({
       ts.factory.createIdentifier(name),
       undefined,
       args
-        .map((arg) => ts.factory.createIdentifier(arg))
-        .filter(isType<ts.Identifier>),
+        .map((arg) =>
+          ts.isExpression(arg) ? arg : ts.factory.createIdentifier(arg),
+        )
+        .filter(isType<ts.Identifier | ts.Expression>),
     ),
   );

packages/openapi-ts/src/compiler/index.ts

@@ -7,7 +7,7 @@ import * as classes from './classes';
 import * as module from './module';
 import * as typedef from './typedef';
 import * as types from './types';
-import { addLeadingComment, stringToTsNodes, tsNodeToString } from './utils';
+import { stringToTsNodes, tsNodeToString } from './utils';
 
 export type { FunctionParameter } from './classes';
 export type { Property } from './typedef';
@@ -44,9 +44,10 @@ export class TypeScriptFile {
     this._path = path.resolve(dir, this.getName());
 
     if (header) {
-      const text = 'This file is auto-generated by @hey-api/openapi-ts';
-      const comment = addLeadingComment(undefined, [text], true, false);
-      this._headers = [...this._headers, comment];
+      this._headers = [
+        ...this._headers,
+        '// This file is auto-generated by @hey-api/openapi-ts',
+      ];
     }
   }
 

packages/openapi-ts/src/compiler/typedef.ts

@@ -1,6 +1,6 @@
 import ts from 'typescript';
 
-import { addLeadingComment, type Comments, tsNodeToString } from './utils';
+import { addLeadingJSDocComment, type Comments, tsNodeToString } from './utils';
 
 export const createTypeNode = (
   base: any | ts.TypeNode,
@@ -41,7 +41,7 @@ export const createTypeAliasDeclaration = (
     createTypeNode(type),
   );
   if (comments?.length) {
-    addLeadingComment(node, comments);
+    addLeadingJSDocComment(node, comments);
   }
   return node;
 };
@@ -79,7 +79,7 @@ export const createTypeInterfaceNode = (
       );
       const comment = property.comment;
       if (comment) {
-        addLeadingComment(signature, comment);
+        addLeadingJSDocComment(signature, comment);
       }
       return signature;
     }),

packages/openapi-ts/src/compiler/types.ts

@@ -1,6 +1,6 @@
 import ts from 'typescript';
 
-import { addLeadingComment, type Comments, isType, ots } from './utils';
+import { addLeadingJSDocComment, type Comments, isType, ots } from './utils';
 
 /**
  * Convert an unknown value to an expression.
@@ -120,7 +120,7 @@ export const createObjectType = <T extends object>({
           : ts.factory.createPropertyAssignment(key, initializer);
       const c = comments?.[key];
       if (c?.length) {
-        addLeadingComment(assignment, c);
+        addLeadingJSDocComment(assignment, c);
       }
       return assignment;
     })
@@ -158,13 +158,13 @@ export const createEnumDeclaration = <T extends object>({
       const assignment = ts.factory.createEnumMember(key, initializer);
       const c = comments?.[key];
       if (c) {
-        addLeadingComment(assignment, c);
+        addLeadingJSDocComment(assignment, c);
       }
       return assignment;
     }),
   );
   if (leadingComment.length) {
-    addLeadingComment(declaration, leadingComment);
+    addLeadingJSDocComment(declaration, leadingComment);
   }
   return declaration;
 };

packages/openapi-ts/src/compiler/utils.ts

@@ -116,38 +116,26 @@ export const isType = <T>(value: T | undefined): value is T =>
 
 export type Comments = Array<string | null | false | undefined>;
 
-export const addLeadingComment = (
-  node: ts.Node | undefined,
-  text: Comments,
-  hasTrailingNewLine: boolean = true,
-  useJSDocStyle = true,
-): string => {
+export const addLeadingJSDocComment = (node: ts.Node, text: Comments) => {
   const comments = text.filter(Boolean);
-
   if (!comments.length) {
-    return '';
+    return;
   }
 
-  // if node is falsy, assume string mode
-  if (!node) {
-    if (useJSDocStyle) {
-      const result = ['/**', ...comments.map((row) => ` * ${row}`), ' */'].join(
-        '\n',
-      );
-      return hasTrailingNewLine ? `${result}\n` : result;
-    }
-
-    const result = comments.map((row) => `// ${row}`).join('\n');
-    return hasTrailingNewLine ? `${result}\n` : result;
-  }
+  const jsdocTexts = comments.map((c, l) =>
+    ts.factory.createJSDocText(`${c}${l !== comments.length ? '\n' : ''}`),
+  );
+  const jsdoc = ts.factory.createJSDocComment(
+    ts.factory.createNodeArray(jsdocTexts),
+  );
+  const cleanedJsdoc = tsNodeToString(jsdoc)
+    .replace('/*', '')
+    .replace('*  */', '');
 
   ts.addSyntheticLeadingComment(
     node,
     ts.SyntaxKind.MultiLineCommentTrivia,
-    encodeURIComponent(
-      ['*', ...comments.map((row) => ` * ${row}`), ' '].join('\n'),
-    ),
-    hasTrailingNewLine,
+    cleanedJsdoc,
+    true,
   );
-  return '';
 };

packages/openapi-ts/src/index.ts

@@ -206,7 +206,7 @@ const initConfig = async (
     dryRun = false,
     enums = false,
     exportCore = true,
-    format = 'prettier',
+    format = false,
     input,
     lint = false,
     name,

packages/openapi-ts/src/templates/core/OpenAPI.hbs

@@ -1,13 +1,12 @@
-{{~#equals @root.$config.client 'angular'~}}
+{{#equals @root.$config.client 'angular'}}
 import type { HttpResponse } from '@angular/common/http';
-{{~/equals~}}
-{{~#equals @root.$config.client 'axios'~}}
+{{/equals}}
+{{#equals @root.$config.client 'axios'}}
 import type { AxiosRequestConfig, AxiosResponse } from 'axios';
-{{~/equals~}}
-{{~#equals @root.$config.client 'node'~}}
+{{/equals}}
+{{#equals @root.$config.client 'node'}}
 import type { RequestInit, Response } from 'node-fetch';
-{{~/equals~}}
-
+{{/equals}}
 import type { ApiRequestOptions } from './ApiRequestOptions';
 
 type Headers = Record<string, string>;
@@ -24,10 +23,7 @@ export class Interceptors<T> {
   eject(fn: Middleware<T>) {
     const index = this._fns.indexOf(fn);
     if (index !== -1) {
-      this._fns = [
-        ...this._fns.slice(0, index),
-        ...this._fns.slice(index + 1),
-      ];
+      this._fns = [...this._fns.slice(0, index), ...this._fns.slice(index + 1)];
     }
   }
 
@@ -47,25 +43,25 @@ export type OpenAPIConfig = {
 	VERSION: string;
 	WITH_CREDENTIALS: boolean;
 	interceptors: {
-		{{~#equals @root.$config.client 'angular'~}}
+		{{#equals @root.$config.client 'angular'}}
 		response: Interceptors<HttpResponse<any>>;
-		{{~/equals~}}
-		{{~#equals @root.$config.client 'axios'~}}
+		{{/equals}}
+		{{#equals @root.$config.client 'axios'}}
 		request: Interceptors<AxiosRequestConfig>;
 		response: Interceptors<AxiosResponse>;
-		{{~/equals~}}
-		{{~#equals @root.$config.client 'fetch'~}}
+		{{/equals}}
+		{{#equals @root.$config.client 'fetch'}}
 		request: Interceptors<RequestInit>;
 		response: Interceptors<Response>;
-		{{~/equals~}}
-		{{~#equals @root.$config.client 'node'~}}
+		{{/equals}}
+		{{#equals @root.$config.client 'node'}}
 		request: Interceptors<RequestInit>;
 		response: Interceptors<Response>;
-		{{~/equals~}}
-		{{~#equals @root.$config.client 'xhr'~}}
+		{{/equals}}
+		{{#equals @root.$config.client 'xhr'}}
 		request: Interceptors<XMLHttpRequest>;
 		response: Interceptors<XMLHttpRequest>;
-		{{~/equals~}}
+		{{/equals}}
 	};
 };
 
@@ -80,9 +76,9 @@ export const OpenAPI: OpenAPIConfig = {
 	VERSION: '{{{version}}}',
 	WITH_CREDENTIALS: false,
 	interceptors: {
-		{{~#notEquals @root.$config.client 'angular'~}}
+		{{#notEquals @root.$config.client 'angular'}}
 		request: new Interceptors(),
-		{{~/notEquals~}}
+		{{/notEquals}}
 		response: new Interceptors(),
 	},
 };

packages/openapi-ts/src/types/config.ts

@@ -30,7 +30,7 @@ export interface UserConfig {
   exportCore?: boolean;
   /**
    * Process output folder with formatter?
-   * @default 'prettier'
+   * @default false
    */
   format?: 'biome' | 'prettier' | false;
   /**

packages/openapi-ts/src/utils/enum.ts

@@ -59,13 +59,16 @@ export const enumName = (client: Client, name?: string) => {
 
 export const enumUnionType = (enums: Enum[]) =>
   enums
-    .map((enumerator) => enumValue(enumerator.value))
+    .map((enumerator) => enumValue(enumerator.value, true))
     .filter(unique)
     .join(' | ');
 
-export const enumValue = (value?: string | number) => {
+export const enumValue = (value?: string | number, union: boolean = false) => {
   if (typeof value === 'string') {
-    return `'${value.replace(/'/g, "\\'")}'`;
+    if (value.includes("'") && union) {
+      return `"${value}"`;
+    }
+    return `'${value}'`;
   }
   return value;
 };

packages/openapi-ts/src/utils/escape.ts

@@ -24,16 +24,11 @@ export const unescapeName = (value: string): string => {
   return value;
 };
 
-export const escapeComment = (value: string, insertAsterisk = true) =>
+export const escapeComment = (value: string) =>
   value
     .replace(/\*\//g, '*')
     .replace(/\/\*/g, '*')
-    .replace(/\r?\n(.*)/g, (_, w) => {
-      if (insertAsterisk) {
-        return `${EOL} * ${w.trim()}`;
-      }
-      return EOL + w.trim();
-    });
+    .replace(/\r?\n(.*)/g, (_l, w) => EOL + w.trim());
 
 export const escapeDescription = (value: string) =>
   value.replace(/\\/g, '\\\\').replace(/`/g, '\\`').replace(/\${/g, '\\${');

packages/openapi-ts/src/utils/write/models.ts

@@ -4,7 +4,7 @@ import {
   type Node,
   TypeScriptFile,
 } from '../../compiler';
-import { addLeadingComment } from '../../compiler/utils';
+import { addLeadingJSDocComment } from '../../compiler/utils';
 import type { Model, OperationParameter, Service } from '../../openApi';
 import { ensureValidTypeScriptJavaScriptIdentifier } from '../../openApi/common/parser/sanitize';
 import type { Client } from '../../types/client';
@@ -100,7 +100,7 @@ const processEnum = (
       unescape: true,
     });
     const node = compiler.export.asConst(name, expression);
-    addLeadingComment(node, comment);
+    addLeadingJSDocComment(node, comment);
     onNode(node, 'enum');
   }
 };