Merge pull request #343 from hey-api/fix/files-header

fix(parser): add header to generated files

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

@@ -5,31 +5,42 @@ import ts from 'typescript';
 import * as module from './module';
 import * as typedef from './typedef';
 import * as types from './types';
-import { tsNodeToString } from './utils';
+import { addLeadingComment, tsNodeToString } from './utils';
 
 export type { Property } from './typedef';
 export type { Comments } from './utils';
 export type { Node } from 'typescript';
 
 export class TypeScriptFile {
+    private _headers: Array<string> = [];
     private _imports: Array<ts.Node> = [];
     private _items: Array<ts.Node | string> = [];
 
-    public addNamedImport(...params: Parameters<typeof module.createNamedImportDeclarations>): void {
-        this._imports.push(compiler.import.named(...params));
+    public add(...nodes: Array<ts.Node | string>): void {
+        this._items = [...this._items, ...nodes];
     }
 
-    public add(...nodes: Array<ts.Node | string>): void {
-        this._items.push(...nodes);
+    public addHeader() {
+        const text = 'This file is auto-generated by @hey-api/openapi-ts';
+        const comment = addLeadingComment(undefined, [text], true, false)
+        this._headers = [...this._headers, comment]
+        return this;
+    }
+
+    public addNamedImport(...params: Parameters<typeof module.createNamedImportDeclarations>): void {
+        this._imports = [...this._imports, compiler.import.named(...params)];
     }
 
     public toString(seperator: string = '\n') {
-        const values: string[] = [];
+        let output: string[] = [];
+        if (this._headers.length) {
+            output = [...output, this._headers.join('\n')];
+        }
         if (this._imports.length) {
-            values.push(this._imports.map(v => tsNodeToString(v)).join('\n'));
+            output = [...output, this._imports.map(v => tsNodeToString(v)).join('\n')];
         }
-        values.push(...this._items.map(v => (typeof v === 'string' ? v : tsNodeToString(v))));
-        return values.join(seperator);
+        output = [...output, ...this._items.map(v => (typeof v === 'string' ? v : tsNodeToString(v)))];
+        return output.join(seperator);
     }
 
     public write(file: PathOrFileDescriptor, seperator: string = '\n') {

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

@@ -1,6 +1,6 @@
 import ts from 'typescript';
 
-import { addLeadingJSDocComment, type Comments } from './utils';
+import { addLeadingComment, type Comments } from './utils';
 
 export const createTypeNode = (base: any) => ts.factory.createTypeReferenceNode(base as string);
 
@@ -23,7 +23,7 @@ export const createTypeAliasDeclaration = (
         ts.factory.createTypeReferenceNode(type)
     );
     if (comments?.length) {
-        addLeadingJSDocComment(node, comments);
+        addLeadingComment(node, comments);
     }
     return node;
 };
@@ -54,7 +54,7 @@ export const createTypeInterfaceNode = (properties: Property[], isNullable: bool
             );
             const comment = property.comment;
             if (comment) {
-                addLeadingJSDocComment(signature, comment);
+                addLeadingComment(signature, comment);
             }
             return signature;
         })

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

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

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

@@ -88,25 +88,34 @@ export const isType = <T>(value: T | undefined): value is T => value !== undefin
 
 export type Comments = Array<string | null | false | undefined>;
 
-export const addLeadingJSDocComment = (
+export const addLeadingComment = (
     node: ts.Node | undefined,
     text: Comments,
-    hasTrailingNewLine: boolean = true
+    hasTrailingNewLine: boolean = true,
+    useJSDocStyle = true,
 ): string => {
-    if (!text.filter(Boolean).length) {
+    const comments = text.filter(Boolean);
+
+    if (!comments.length) {
         return '';
     }
+
     // if node is falsy, assume string mode
-    if (node) {
-        ts.addSyntheticLeadingComment(
-            node,
-            ts.SyntaxKind.MultiLineCommentTrivia,
-            ['*', ...text, ' '].filter(Boolean).join('\n'),
-            hasTrailingNewLine
-        );
-        return '';
+    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 result = ['/**', ...text, ' */'].filter(Boolean).join('\n');
-    return hasTrailingNewLine ? `${result}\n` : result;
+    ts.addSyntheticLeadingComment(
+        node,
+        ts.SyntaxKind.MultiLineCommentTrivia,
+        ['*', ...comments.map(row => ` * ${row}`), ' '].join('\n'),
+        hasTrailingNewLine
+    );
+    return '';
 };

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

@@ -12,7 +12,9 @@ import { getConfig } from '../config';
  */
 export const writeClientIndex = async (client: Client, outputPath: string): Promise<void> => {
     const config = getConfig();
-    const file = new TypeScriptFile();
+
+    const file = new TypeScriptFile().addHeader();
+
     if (config.name) {
         file.add(compiler.export.named([config.name], `./${config.name}`));
     }

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

@@ -27,14 +27,14 @@ const processEnum = (client: Client, model: Model, exportType: boolean) => {
         properties[key] = value;
         const comment = enumerator.customDescription || enumerator.description;
         if (comment) {
-            comments[key] = [` * ${escapeComment(comment)}`];
+            comments[key] = [escapeComment(comment)];
         }
     });
 
     if (exportType) {
         const comment: Comments = [
-            model.description && ` * ${escapeComment(model.description)}`,
-            model.deprecated && ' * @deprecated',
+            model.description && escapeComment(model.description),
+            model.deprecated && '@deprecated',
         ];
         if (config.enums === 'typescript') {
             nodes = [...nodes, compiler.types.enum(model.name, properties, comment, comments)];
@@ -57,8 +57,8 @@ const processEnum = (client: Client, model: Model, exportType: boolean) => {
 
 const processType = (client: Client, model: Model) => {
     const comment: Comments = [
-        model.description && ` * ${escapeComment(model.description)}`,
-        model.deprecated && ' * @deprecated',
+        model.description && escapeComment(model.description),
+        model.deprecated && '@deprecated',
     ];
     const type = toType(model);
     return compiler.typedef.alias(model.name, type!, comment);
@@ -245,7 +245,7 @@ const processServiceTypes = (services: Service[]) => {
  * @param client Client containing models, schemas, and services
  */
 export const writeClientModels = async (openApi: OpenApi, outputPath: string, client: Client): Promise<void> => {
-    const file = new TypeScriptFile();
+    const file = new TypeScriptFile().addHeader();
 
     for (const model of client.models) {
         const nodes = processModel(client, model);

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

@@ -10,7 +10,7 @@ import { ensureValidTypeScriptJavaScriptIdentifier } from '../../openApi/common/
  * @param outputPath Directory to write the generated files to
  */
 export const writeClientSchemas = async (openApi: OpenApi, outputPath: string): Promise<void> => {
-    const file = new TypeScriptFile();
+    const file = new TypeScriptFile().addHeader();
 
     const addSchema = (name: string, obj: any) => {
         const validName = `$${ensureValidTypeScriptJavaScriptIdentifier(name)}`;

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

@@ -22,7 +22,7 @@ export const writeClientServices = async (
     templates: Templates
 ): Promise<void> => {
     const config = getConfig();
-    const file = new TypeScriptFile();
+    const file = new TypeScriptFile().addHeader();
 
     let imports: string[] = [];
     let results: string[] = [];

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

@@ -80,8 +80,8 @@ const typeInterface = (model: Model) => {
         }
         return {
             comment: [
-                property.description && ` * ${escapeComment(property.description)}`,
-                property.deprecated && ` * @deprecated`,
+                property.description && escapeComment(property.description),
+                property.deprecated && '@deprecated',
             ],
             isReadOnly: property.isReadOnly,
             isRequired: maybeRequired === '',

packages/openapi-ts/test/__snapshots__/test/generated/v2/index.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export { ApiError } from './core/ApiError';
 export { CancelablePromise, CancelError } from './core/CancelablePromise';
 export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI';

packages/openapi-ts/test/__snapshots__/test/generated/v2/models.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 /**
  * Testing multiline comments in string: First line
  * Second line

packages/openapi-ts/test/__snapshots__/test/generated/v2/schemas.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export const $CommentWithBreaks = {
     description: `Testing multiline comments in string: First line
 Second line

packages/openapi-ts/test/__snapshots__/test/generated/v2/services.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 import type { CancelablePromise } from './core/CancelablePromise';
 import { OpenAPI } from './core/OpenAPI';
 import { request as __request } from './core/request';

packages/openapi-ts/test/__snapshots__/test/generated/v3/index.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export { ApiError } from './core/ApiError';
 export { CancelablePromise, CancelError } from './core/CancelablePromise';
 export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI';

packages/openapi-ts/test/__snapshots__/test/generated/v3/models.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 /**
  * Testing multiline comments in string: First line
  * Second line

packages/openapi-ts/test/__snapshots__/test/generated/v3/schemas.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export const $CommentWithBreaks = {
     description: `Testing multiline comments in string: First line
 Second line

packages/openapi-ts/test/__snapshots__/test/generated/v3/services.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 import type { CancelablePromise } from './core/CancelablePromise';
 import { OpenAPI } from './core/OpenAPI';
 import { request as __request } from './core/request';

packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/index.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export { ApiError } from './core/ApiError';
 export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI';
 export * from './models';

packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/models.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 /**
  * Testing multiline comments in string: First line
  * Second line

packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/schemas.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export const $CommentWithBreaks = {
     description: `Testing multiline comments in string: First line
 Second line

packages/openapi-ts/test/__snapshots__/test/generated/v3_angular/services.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 import { Injectable } from '@angular/core';
 import { HttpClient } from '@angular/common/http';
 import type { Observable } from 'rxjs';

packages/openapi-ts/test/__snapshots__/test/generated/v3_axios/index.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export { ApiError } from './core/ApiError';
 export { CancelablePromise, CancelError } from './core/CancelablePromise';
 export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI';

packages/openapi-ts/test/__snapshots__/test/generated/v3_client/index.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export { ApiClient } from './ApiClient';
 export { ApiError } from './core/ApiError';
 export { BaseHttpRequest } from './core/BaseHttpRequest';

packages/openapi-ts/test/__snapshots__/test/generated/v3_client/models.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 /**
  * Testing multiline comments in string: First line
  * Second line

packages/openapi-ts/test/__snapshots__/test/generated/v3_client/services.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 import type { CancelablePromise } from './core/CancelablePromise';
 import type { BaseHttpRequest } from './core/BaseHttpRequest';
 import type { $OpenApiTs } from './models';

packages/openapi-ts/test/__snapshots__/test/generated/v3_date/index.ts.snap

@@ -1,2 +1,4 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export * from './models';
 export * from './schemas';

packages/openapi-ts/test/__snapshots__/test/generated/v3_date/models.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 /**
  * This is a model that contains a some patterns
  */

packages/openapi-ts/test/__snapshots__/test/generated/v3_date/schemas.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export const $CommentWithBreaks = {
     description: `Testing multiline comments in string: First line
 Second line

packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/index.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export { ApiError } from './core/ApiError';
 export { CancelablePromise, CancelError } from './core/CancelablePromise';
 export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI';

packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/models.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 /**
  * Testing multiline comments in string: First line
  * Second line

packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/schemas.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export const $CommentWithBreaks = {
     description: `Testing multiline comments in string: First line
 Second line

packages/openapi-ts/test/__snapshots__/test/generated/v3_enums_typescript/services.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 import type { CancelablePromise } from './core/CancelablePromise';
 import { OpenAPI } from './core/OpenAPI';
 import { request as __request } from './core/request';

packages/openapi-ts/test/__snapshots__/test/generated/v3_legacy_positional_args/index.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export { ApiError } from './core/ApiError';
 export { CancelablePromise, CancelError } from './core/CancelablePromise';
 export { OpenAPI, type OpenAPIConfig } from './core/OpenAPI';

packages/openapi-ts/test/__snapshots__/test/generated/v3_legacy_positional_args/models.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 /**
  * This is a model with one string property
  */

packages/openapi-ts/test/__snapshots__/test/generated/v3_legacy_positional_args/services.ts.snap

@@ -1,3 +1,5 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 import type { CancelablePromise } from './core/CancelablePromise';
 import { OpenAPI } from './core/OpenAPI';
 import { request as __request } from './core/request';

packages/openapi-ts/test/__snapshots__/test/generated/v3_models/index.ts.snap

@@ -1 +1,3 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
 export * from './models';