feat: remove eslint postprocessing, it is too inefficient

mdevils · mdevils · commit af454e91fc6b · 2024-12-21T12:44:44.000+01:00
diff --git a/docs/interfaces/index.CommonOpenApiClientGeneratorConfig.md b/docs/interfaces/index.CommonOpenApiClientGeneratorConfig.md
@@ -18,7 +18,6 @@ Common configuration for the API client generators.
 
 - [document](index.CommonOpenApiClientGeneratorConfig.md#document)
 - [outputDirPath](index.CommonOpenApiClientGeneratorConfig.md#outputdirpath)
-- [postprocess](index.CommonOpenApiClientGeneratorConfig.md#postprocess)
 
 ## Properties
 
@@ -35,11 +34,3 @@ ___
 • **outputDirPath**: `string`
 
 Output directory for the generated client files.
-
-___
-
-### postprocess
-
-• `Optional` **postprocess**: [`CommonOpenApiClientGeneratorConfigPostprocess`](index.CommonOpenApiClientGeneratorConfigPostprocess.md)
-
-Configuration for the generated client files.
diff --git a/docs/interfaces/index.CommonOpenApiClientGeneratorConfigPostprocess.md b/docs/interfaces/index.CommonOpenApiClientGeneratorConfigPostprocess.md
diff --git a/docs/interfaces/openapi_client.OpenApiClientGeneratorConfig.md b/docs/interfaces/openapi_client.OpenApiClientGeneratorConfig.md
@@ -25,7 +25,6 @@ Configuration for generating an OpenAPI client.
 - [models](openapi_client.OpenApiClientGeneratorConfig.md#models)
 - [operations](openapi_client.OpenApiClientGeneratorConfig.md#operations)
 - [outputDirPath](openapi_client.OpenApiClientGeneratorConfig.md#outputdirpath)
-- [postprocess](openapi_client.OpenApiClientGeneratorConfig.md#postprocess)
 - [services](openapi_client.OpenApiClientGeneratorConfig.md#services)
 - [type](openapi_client.OpenApiClientGeneratorConfig.md#type)
 - [validation](openapi_client.OpenApiClientGeneratorConfig.md#validation)
@@ -119,18 +118,6 @@ Output directory for the generated client files.
 
 ___
 
-### postprocess
-
-• `Optional` **postprocess**: [`CommonOpenApiClientGeneratorConfigPostprocess`](index.CommonOpenApiClientGeneratorConfigPostprocess.md)
-
-Configuration for the generated client files.
-
-#### Inherited from
-
-[CommonOpenApiClientGeneratorConfig](index.CommonOpenApiClientGeneratorConfig.md).[postprocess](index.CommonOpenApiClientGeneratorConfig.md#postprocess)
-
-___
-
 ### services
 
 • `Optional` **services**: ``false`` \| [`OpenApiClientGeneratorConfigServices`](openapi_client.OpenApiClientGeneratorConfigServices.md)
diff --git a/docs/modules/index.md b/docs/modules/index.md
@@ -10,7 +10,6 @@
 - [CommonOpenApiClientGeneratorConfig](../interfaces/index.CommonOpenApiClientGeneratorConfig.md)
 - [CommonOpenApiClientGeneratorConfigDocument](../interfaces/index.CommonOpenApiClientGeneratorConfigDocument.md)
 - [CommonOpenApiClientGeneratorConfigDocumentPatch](../interfaces/index.CommonOpenApiClientGeneratorConfigDocumentPatch.md)
-- [CommonOpenApiClientGeneratorConfigPostprocess](../interfaces/index.CommonOpenApiClientGeneratorConfigPostprocess.md)
 - [FilenameFormat](../interfaces/index.FilenameFormat.md)
 - [JsDocBlock](../interfaces/index.JsDocBlock.md)
 - [JsDocBlockTag](../interfaces/index.JsDocBlockTag.md)
diff --git a/src/cli/index.ts b/src/cli/index.ts
@@ -14,7 +14,6 @@ import {
     openapiToTypescriptClient
 } from '../schema-to-typescript/openapi-to-typescript-client';
 import {loadOpenApiDocument} from '../schemas/load-open-api-document';
-import {postprocessFiles} from '../utils/postprocess-files';
 
 async function loadConfig(filename: string): Promise<ApiTypescriptGeneratorConfig> {
     const fullFilename = path.resolve(process.cwd(), filename);
@@ -70,16 +69,12 @@ yargs(hideBin(process.argv))
                 switch (generateConfig.type) {
                     case 'openapiClient':
                         const document = await loadOpenApiDocument(generateConfig.document);
-                        const files = await postprocessFiles({
-                            files: (
-                                await openapiToTypescriptClient({
-                                    document,
-                                    generateConfig
-                                })
-                            ).files,
-                            config: generateConfig.postprocess,
-                            outputDirPath: generateConfig.outputDirPath
-                        });
+                        const files = (
+                            await openapiToTypescriptClient({
+                                document,
+                                generateConfig
+                            })
+                        ).files;
                         const allDirectories = new Set<string>();
                         for (const {filename} of files) {
                             allDirectories.add(path.dirname(path.resolve(generateConfig.outputDirPath, filename)));
@@ -114,16 +109,12 @@ yargs(hideBin(process.argv))
                     case 'openapiClient':
                         if (
                             !(await compareGenerationResult({
-                                files: await postprocessFiles({
-                                    files: (
-                                        await openapiToTypescriptClient({
-                                            document: await loadOpenApiDocument(generateConfig.document),
-                                            generateConfig
-                                        })
-                                    ).files,
-                                    config: generateConfig.postprocess,
-                                    outputDirPath: generateConfig.outputDirPath
-                                }),
+                                files: (
+                                    await openapiToTypescriptClient({
+                                        document: await loadOpenApiDocument(generateConfig.document),
+                                        generateConfig
+                                    })
+                                ).files,
                                 outputDirPath: generateConfig.outputDirPath,
                                 cleanupDirectories: getCleanupDirectories(generateConfig)
                             }))
diff --git a/src/index.ts b/src/index.ts
@@ -9,8 +9,7 @@ export type {
     OpenApiDocumentPatchTags,
     CommonOpenApiClientGeneratorConfigDocumentPatch,
     OpenApiDocumentPatchAllSchemas,
-    OpenApiDocumentPatchDocument,
-    CommonOpenApiClientGeneratorConfigPostprocess
+    OpenApiDocumentPatchDocument
 } from './schema-to-typescript/config';
 export type {JsDocBlockTag, JsDocBlock} from './utils/jsdoc';
 export type {FilenameFormat, EntityNameCase} from './utils/string-utils';
diff --git a/src/schema-to-typescript/config.ts b/src/schema-to-typescript/config.ts
@@ -153,17 +153,6 @@ export interface CommonOpenApiClientGeneratorConfigDocument {
     patch?: CommonOpenApiClientGeneratorConfigDocumentPatch;
 }
 
-/**
- * Configuration for postprocessing the generated files.
- */
-export interface CommonOpenApiClientGeneratorConfigPostprocess {
-    /**
-     * If true, runs ESLint on the generated files. ESlint should be installed in the project and the configuration
-     * should be present. This postprocess step can take a long time for large schemas.
-     */
-    eslint?: boolean;
-}
-
 /**
  * Common configuration for the API client generators.
  */
@@ -176,10 +165,6 @@ export interface CommonOpenApiClientGeneratorConfig {
      * Output directory for the generated client files.
      */
     outputDirPath: string;
-    /**
-     * Configuration for the generated client files.
-     */
-    postprocess?: CommonOpenApiClientGeneratorConfigPostprocess;
 }
 
 export interface ClientGenerationResult {
diff --git a/src/utils/postprocess-files.ts b/src/utils/postprocess-files.ts
diff --git a/test/pet-store/api-typescript-generator-config.ts b/test/pet-store/api-typescript-generator-config.ts
@@ -24,9 +24,6 @@ export default async function (): Promise<ApiTypescriptGeneratorConfig> {
                 validation: {
                     library: 'zod'
                 },
-                postprocess: {
-                    eslint: true
-                },
                 core: {
                     cleanupFiles: true,
                     generateJsDoc: ({suggestedJsDoc}) => ({
