ts-openapi-codegen 2.1.0-beta.6 → 2.1.0-beta.8

package/dist/core/OpenApiClient.js

@@ -1,9 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenApiClient = void 0;
+const fs_1 = require("fs");
 const Consts_1 = require("../common/Consts");
 const Logger_1 = require("../common/Logger");
 const LoggerMessages_1 = require("../common/LoggerMessages");
+const TEslintFixOptions_1 = require("../common/TEslintFixOptions");
+const eslintFix_1 = require("../common/utils/eslintFix");
 const fileSystemHelpers_1 = require("../common/utils/fileSystemHelpers");
 const pathHelpers_1 = require("../common/utils/pathHelpers");
 const Parser_1 = require("./api/v2/Parser");
@@ -16,6 +19,7 @@ const EmptySchemaStrategy_enum_1 = require("./types/enums/EmptySchemaStrategy.en
 const ModelsMode_enum_1 = require("./types/enums/ModelsMode.enum");
 const ValidationLibrary_enum_1 = require("./types/enums/ValidationLibrary.enum");
 const applyDiffReportToClient_1 = require("./utils/applyDiffReportToClient");
+const GenerationCache_1 = require("./utils/GenerationCache");
 const getOpenApiSpec_1 = require("./utils/getOpenApiSpec");
 const getOpenApiVersion_1 = require("./utils/getOpenApiVersion");
 const getOutputPaths_1 = require("./utils/getOutputPaths");
@@ -25,7 +29,11 @@ const prepareDtoModels_1 = require("./utils/prepareDtoModels");
 const registerHandlebarTemplates_1 = require("./utils/registerHandlebarTemplates");
 const WriteClient_1 = require("./WriteClient");
 class OpenApiClient {
+    static CACHE_FINGERPRINT_VERSION = 1;
+    static DEFAULT_CACHE_FILENAME = '.openapi-codegen-cache.json';
     _writeClient = null;
+    /** ESLint paths from top-level rawOptions (not per items[] entry). */
+    eslintFixOptions = {};
     get writeClient() {
         if (!this._writeClient) {
             throw new Error('WriteClient must be initialized');
@@ -52,7 +60,6 @@ class OpenApiClient {
                 enumPrefix: rawOptions.enumPrefix,
                 typePrefix: rawOptions.typePrefix,
                 useCancelableRequest: rawOptions.useCancelableRequest,
-                useRequestRaw: rawOptions.useRequestRaw,
                 logLevel: rawOptions.logLevel,
                 logTarget: rawOptions.logTarget,
                 sortByRequired: rawOptions.sortByRequired,
@@ -65,6 +72,11 @@ class OpenApiClient {
                 strictOpenapi: rawOptions.strictOpenapi,
                 reportFile: rawOptions.reportFile,
                 governanceConfig: rawOptions.governanceConfig,
+                cache: rawOptions.cache,
+                cachePath: rawOptions.cachePath,
+                cacheStrategy: rawOptions.cacheStrategy,
+                cacheDebug: rawOptions.cacheDebug,
+                prettierConfigPath: rawOptions.prettierConfigPath,
             }));
         }
         else {
@@ -89,7 +101,6 @@ class OpenApiClient {
                     enumPrefix: rawOptions.enumPrefix,
                     typePrefix: rawOptions.typePrefix,
                     useCancelableRequest: rawOptions.useCancelableRequest,
-                    useRequestRaw: rawOptions.useRequestRaw,
                     logLevel: rawOptions.logLevel,
                     logTarget: rawOptions.logTarget,
                     sortByRequired: rawOptions.sortByRequired,
@@ -102,6 +113,11 @@ class OpenApiClient {
                     strictOpenapi: rawOptions.strictOpenapi,
                     reportFile: rawOptions.reportFile,
                     governanceConfig: rawOptions.governanceConfig,
+                    cache: rawOptions.cache,
+                    cachePath: rawOptions.cachePath,
+                    cacheStrategy: rawOptions.cacheStrategy,
+                    cacheDebug: rawOptions.cacheDebug,
+                    prettierConfigPath: rawOptions.prettierConfigPath,
                 },
             ];
         }
@@ -126,7 +142,6 @@ class OpenApiClient {
             enumPrefix: item.enumPrefix || Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.enumPrefix,
             typePrefix: item.typePrefix || Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.typePrefix,
             useCancelableRequest: item.useCancelableRequest ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.useCancelableRequest,
-            useRequestRaw: item.useRequestRaw ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.useRequestRaw,
             logLevel: item.logLevel || Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.logLevel,
             logTarget: item.logTarget || Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.logTarget,
             sortByRequired: item.sortByRequired ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.sortByRequired,
@@ -141,18 +156,57 @@ class OpenApiClient {
             miracles: item.miracles || Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.miracles,
             strictOpenapi: item.strictOpenapi ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.strictOpenapi,
             reportFile: item.reportFile || Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.reportFile,
-            useProjectPrettier: item.useProjectPrettier ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.useProjectPrettier,
-            useEslintFix: item.useEslintFix ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.useEslintFix,
+            prettierConfigPath: item.prettierConfigPath ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.prettierConfigPath,
             governanceConfig: item.governanceConfig || Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.governanceConfig,
+            cache: item.cache ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.cache,
+            cachePath: item.cachePath || Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.cachePath,
+            cacheStrategy: item.cacheStrategy ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.cacheStrategy,
+            cacheDebug: item.cacheDebug ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.cacheDebug,
         };
     }
-    async cleanOutputDirectories(option) {
-        const outputDirs = [option.output, option.outputCore, option.outputSchemas, option.outputModels, option.outputServices];
-        for (const dir of outputDirs) {
-            if (dir) {
-                await fileSystemHelpers_1.fileSystemHelpers.rmdir(dir);
+    getOutputRoots(items) {
+        const roots = new Set();
+        for (const item of items) {
+            const outputDirs = [item.output, item.outputCore, item.outputSchemas, item.outputModels, item.outputServices];
+            for (const dir of outputDirs) {
+                if (dir) {
+                    roots.add((0, pathHelpers_1.resolveHelper)(process.cwd(), dir));
+                }
             }
         }
+        return Array.from(roots);
+    }
+    async cleanupStaleOutputs(items) {
+        const outputRoots = this.getOutputRoots(items);
+        const expectedFiles = this.writeClient.getExpectedOutputFiles();
+        for (const root of outputRoots) {
+            await this.removeStaleFilesInDirectory(root, expectedFiles);
+        }
+    }
+    async removeStaleFilesInDirectory(path, expectedFiles) {
+        const stats = await fs_1.promises.stat(path).catch(() => null);
+        if (!stats) {
+            return false;
+        }
+        if (stats.isFile()) {
+            if (!expectedFiles.has(path)) {
+                await fileSystemHelpers_1.fileSystemHelpers.rmdir(path);
+                return false;
+            }
+            return true;
+        }
+        const entries = await fs_1.promises.readdir(path);
+        let hasAnyFile = false;
+        for (const entry of entries) {
+            const childPath = (0, pathHelpers_1.resolveHelper)(path, entry);
+            const childHasFiles = await this.removeStaleFilesInDirectory(childPath, expectedFiles);
+            hasAnyFile = hasAnyFile || childHasFiles;
+        }
+        if (!hasAnyFile) {
+            await fileSystemHelpers_1.fileSystemHelpers.rmdir(path);
+            return false;
+        }
+        return true;
     }
     async generateCodeForItems(items) {
         if (items.length === 0) {
@@ -161,12 +215,27 @@ class OpenApiClient {
         this.writeClient.logger.forceInfo(LoggerMessages_1.LOGGER_MESSAGES.GENERATION.STARTED(items.length));
         try {
             const start = process.hrtime.bigint();
-            for (const option of items) {
-                await this.cleanOutputDirectories(option);
+            const cacheEnabled = items[0]?.cache === true;
+            const generationCaches = new Map();
+            if (!cacheEnabled) {
+                this.warnOnSharedOutputsWithoutCache(items);
+            }
+            else {
+                for (const outputRoot of this.getUniqueResolvedOutputs(items)) {
+                    const sampleItem = items.find(item => this.resolveOutputRoot(item.output) === outputRoot);
+                    if (!sampleItem) {
+                        continue;
+                    }
+                    const cachePath = this.resolveCachePathForOutput(sampleItem.output, sampleItem.cachePath);
+                    const generationCache = new GenerationCache_1.GenerationCache(cachePath);
+                    await generationCache.load();
+                    generationCaches.set(outputRoot, generationCache);
+                }
             }
             for (const option of items) {
                 const fileStart = process.hrtime.bigint();
-                await this.generateSingle(option);
+                const generationCache = cacheEnabled ? (generationCaches.get(this.resolveOutputRoot(option.output)) ?? null) : null;
+                await this.generateSingle(option, generationCache);
                 const fileEnd = process.hrtime.bigint();
                 const fileDurationInSeconds = Number(fileEnd - fileStart) / 1e9;
                 this.writeClient.logger.forceInfo(LoggerMessages_1.LOGGER_MESSAGES.GENERATION.DURATION_FOR_FILE(option.input, fileDurationInSeconds.toFixed(3)));
@@ -177,6 +246,15 @@ class OpenApiClient {
             else {
                 await this.writeClient.combineAndWrite();
             }
+            await this.cleanupStaleOutputs(items);
+            if (cacheEnabled) {
+                for (const generationCache of generationCaches.values()) {
+                    await generationCache.save();
+                }
+            }
+            const writeStats = this.writeClient.getWriteStats();
+            this.writeClient.logger.info(LoggerMessages_1.LOGGER_MESSAGES.GENERATION.WRITE_STATS(writeStats.written, writeStats.unchanged));
+            await this.runBatchEslintFixIfEnabled();
             this.writeClient.logger.forceInfo(LoggerMessages_1.LOGGER_MESSAGES.GENERATION.FINISHED);
             const end = process.hrtime.bigint();
             const durationInSeconds = Number(end - start) / 1e9;
@@ -188,8 +266,34 @@ class OpenApiClient {
         }
         this.writeClient.logger.shutdownLogger();
     }
-    async generateSingle(item) {
-        const { input, output, outputCore, outputServices, outputModels, outputSchemas, httpClient, useOptions, useUnionTypes, excludeCoreServiceFiles, request, plugins, customExecutorPath, interfacePrefix, enumPrefix, typePrefix, useCancelableRequest, useRequestRaw, sortByRequired, useSeparatedIndexes, validationLibrary = ValidationLibrary_enum_1.ValidationLibrary.NONE, emptySchemaStrategy = EmptySchemaStrategy_enum_1.EmptySchemaStrategy.KEEP, useHistory, diffReport, modelsMode = ModelsMode_enum_1.ModelsMode.INTERFACES, strictOpenapi, reportFile, useProjectPrettier = false, useEslintFix = false, governanceConfig, } = item;
+    getUniqueResolvedOutputs(items) {
+        return Array.from(new Set(items.map(item => this.resolveOutputRoot(item.output))));
+    }
+    resolveOutputRoot(output) {
+        return (0, pathHelpers_1.resolveHelper)(process.cwd(), output);
+    }
+    resolveCachePathForOutput(output, cachePath) {
+        if (cachePath.startsWith('/') || /^[A-Za-z]:[\\/]/.test(cachePath)) {
+            return cachePath;
+        }
+        return (0, pathHelpers_1.resolveHelper)(this.resolveOutputRoot(output), cachePath || OpenApiClient.DEFAULT_CACHE_FILENAME);
+    }
+    warnOnSharedOutputsWithoutCache(items) {
+        const countByOutput = new Map();
+        for (const item of items) {
+            const output = this.resolveOutputRoot(item.output);
+            countByOutput.set(output, (countByOutput.get(output) ?? 0) + 1);
+        }
+        const duplicatedOutputs = Array.from(countByOutput.entries())
+            .filter(([, count]) => count > 1)
+            .map(([output]) => output);
+        if (duplicatedOutputs.length === 0) {
+            return;
+        }
+        this.writeClient.logger.warn(LoggerMessages_1.LOGGER_MESSAGES.GENERATION.CACHE_SHARED_OUTPUT_WARNING(duplicatedOutputs.map(output => `- ${output}`).join('\n')));
+    }
+    async generateSingle(item, generationCache) {
+        const { input, output, outputCore, outputServices, outputModels, outputSchemas, httpClient, useOptions, useUnionTypes, excludeCoreServiceFiles, request, plugins, customExecutorPath, interfacePrefix, enumPrefix, typePrefix, useCancelableRequest, sortByRequired, useSeparatedIndexes, validationLibrary = ValidationLibrary_enum_1.ValidationLibrary.NONE, emptySchemaStrategy = EmptySchemaStrategy_enum_1.EmptySchemaStrategy.KEEP, useHistory, diffReport, modelsMode = ModelsMode_enum_1.ModelsMode.INTERFACES, strictOpenapi, reportFile, prettierConfigPath, governanceConfig, } = item;
         const outputPaths = (0, getOutputPaths_1.getOutputPaths)({
             output,
             outputCore,
@@ -198,6 +302,28 @@ class OpenApiClient {
             outputSchemas,
         });
         const absoluteInput = (0, pathHelpers_1.resolveHelper)(process.cwd(), input);
+        const cacheKey = this.getCacheKey(item, absoluteInput);
+        const cacheFingerprint = await this.getCacheFingerprint(item, absoluteInput);
+        const useEntityCache = item.cache && item.cacheStrategy === 'entity' && generationCache !== null;
+        if (useEntityCache) {
+            const cachedEntry = generationCache.get(cacheKey);
+            if (cachedEntry && cachedEntry.fingerprint === cacheFingerprint) {
+                const allFilesExist = await this.filesExist(cachedEntry.files);
+                if (allFilesExist) {
+                    for (const filePath of cachedEntry.files) {
+                        this.writeClient.registerOutputFile(filePath);
+                    }
+                    if (item.cacheDebug) {
+                        this.writeClient.logger.info(LoggerMessages_1.LOGGER_MESSAGES.GENERATION.CACHE_HIT(input));
+                    }
+                    return;
+                }
+            }
+            if (item.cacheDebug) {
+                this.writeClient.logger.info(LoggerMessages_1.LOGGER_MESSAGES.GENERATION.CACHE_MISS(input));
+            }
+        }
+        const knownFilesBefore = new Set(this.writeClient.getExpectedOutputFilesArray());
         const generatorPlugins = await (0, loadGeneratorPlugins_1.loadGeneratorPlugins)(plugins);
         const context = new Context_1.Context({
             input: absoluteInput,
@@ -217,7 +343,7 @@ class OpenApiClient {
                 governanceConfig: governancePolicy,
             });
             const reportPath = await (0, validateOpenApiStrict_1.writeOpenApiStrictReport)(strictReport, reportFile);
-            this.writeClient.logger.forceInfo(`Strict OpenAPI report created: ${reportPath}`);
+            this.writeClient.logger.forceInfo(LoggerMessages_1.LOGGER_MESSAGES.GENERATION.STRICT_REPORT_CREATED(reportPath));
             if (strictReport.summary.errors > 0) {
                 throw new Error(`Strict OpenAPI validation failed with ${strictReport.summary.errors} error(s). Report: ${reportPath}`);
             }
@@ -228,6 +354,7 @@ class OpenApiClient {
             useUnionTypes,
             useOptions,
             validationLibrary,
+            useBatchEslintFix: Boolean(this.eslintFixOptions.tsconfigPath && this.eslintFixOptions.eslintConfigPath),
         });
         const diffReportData = await this.loadDiffReportIfNeeded({
             useHistory,
@@ -261,13 +388,11 @@ class OpenApiClient {
                     request,
                     customExecutorPath,
                     useCancelableRequest,
-                    useRequestRaw,
                     useSeparatedIndexes,
                     validationLibrary,
                     emptySchemaStrategy,
                     modelsMode,
-                    useProjectPrettier,
-                    useEslintFix,
+                    prettierConfigPath,
                 });
                 break;
             }
@@ -296,17 +421,112 @@ class OpenApiClient {
                     request,
                     customExecutorPath,
                     useCancelableRequest,
-                    useRequestRaw,
                     useSeparatedIndexes,
                     validationLibrary,
                     emptySchemaStrategy,
                     modelsMode,
-                    useProjectPrettier,
-                    useEslintFix,
+                    prettierConfigPath,
                 });
                 break;
             }
         }
+        const generatedFiles = this.writeClient.getExpectedOutputFilesArray().filter(filePath => !knownFilesBefore.has(filePath));
+        if (item.cache && generationCache) {
+            generationCache.set({
+                key: cacheKey,
+                fingerprint: cacheFingerprint,
+                files: generatedFiles,
+                updatedAt: Date.now(),
+            });
+        }
+    }
+    getCacheKey(item, absoluteInput) {
+        return GenerationCache_1.GenerationCache.hash(JSON.stringify({
+            input: absoluteInput,
+            output: item.output,
+            outputCore: item.outputCore,
+            outputServices: item.outputServices,
+            outputModels: item.outputModels,
+            outputSchemas: item.outputSchemas,
+        }));
+    }
+    async getCacheFingerprint(item, absoluteInput) {
+        const specContent = await fileSystemHelpers_1.fileSystemHelpers.readFile(absoluteInput, 'utf8');
+        const fingerprint = {
+            cacheFingerprintVersion: OpenApiClient.CACHE_FINGERPRINT_VERSION,
+            generatorVersion: process.env.npm_package_version || 'dev',
+            specHash: GenerationCache_1.GenerationCache.hash(specContent),
+            options: {
+                httpClient: item.httpClient,
+                useOptions: item.useOptions,
+                useUnionTypes: item.useUnionTypes,
+                includeSchemasFiles: item.includeSchemasFiles,
+                excludeCoreServiceFiles: item.excludeCoreServiceFiles,
+                request: item.request,
+                plugins: item.plugins,
+                customExecutorPath: item.customExecutorPath,
+                interfacePrefix: item.interfacePrefix,
+                enumPrefix: item.enumPrefix,
+                typePrefix: item.typePrefix,
+                useCancelableRequest: item.useCancelableRequest,
+                sortByRequired: item.sortByRequired,
+                useSeparatedIndexes: item.useSeparatedIndexes,
+                validationLibrary: item.validationLibrary,
+                emptySchemaStrategy: item.emptySchemaStrategy,
+                useHistory: item.useHistory,
+                diffReport: item.diffReport,
+                modelsMode: item.modelsMode,
+                strictOpenapi: item.strictOpenapi,
+            },
+        };
+        return GenerationCache_1.GenerationCache.hash(JSON.stringify(fingerprint));
+    }
+    async filesExist(paths) {
+        for (const filePath of paths) {
+            const exists = await fileSystemHelpers_1.fileSystemHelpers.exists(filePath);
+            if (!exists) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * Runs batch ESLint fix after combineAndWrite / combineAndWrightSimple when both paths are set.
+     * Warns and skips when only one path is provided; always clears the WriteClient lint registry.
+     */
+    async runBatchEslintFixIfEnabled() {
+        const opts = this.eslintFixOptions;
+        const hasTsconfig = !!opts.tsconfigPath;
+        const hasEslintConfig = !!opts.eslintConfigPath;
+        if (!hasTsconfig && !hasEslintConfig) {
+            this.writeClient.clearLintTargets();
+            return;
+        }
+        if (!hasTsconfig || !hasEslintConfig) {
+            this.writeClient.logger.warn(LoggerMessages_1.LOGGER_MESSAGES.FORMATTING.ESLINT_PATHS_MISSING);
+            this.writeClient.clearLintTargets();
+            return;
+        }
+        try {
+            const { files, includeGlobs } = this.writeClient.getLintTargets();
+            if (files.length === 0) {
+                return;
+            }
+            const fixStart = process.hrtime.bigint();
+            this.writeClient.logger.forceInfo(LoggerMessages_1.LOGGER_MESSAGES.FORMATTING.ESLINT_BATCH_STARTED);
+            await (0, eslintFix_1.eslintFixBatch)({
+                files,
+                includeGlobs,
+                tsconfigPath: opts.tsconfigPath,
+                eslintConfigPath: opts.eslintConfigPath,
+            });
+            const fixEnd = process.hrtime.bigint();
+            const durationInSeconds = Number(fixEnd - fixStart) / 1e9;
+            this.writeClient.logger.forceInfo(LoggerMessages_1.LOGGER_MESSAGES.FORMATTING.ESLINT_BATCH_FINISHED(durationInSeconds.toFixed(3)));
+        }
+        finally {
+            this.writeClient.clearLintTargets();
+        }
     }
     async loadDiffReportIfNeeded(params) {
         return (0, loadDiffReport_1.loadDiffReport)({
@@ -335,6 +555,7 @@ class OpenApiClient {
             logOutput: rawOptions.logTarget ?? Consts_1.COMMON_DEFAULT_OPTIONS_VALUES.logTarget,
         });
         this._writeClient = new WriteClient_1.WriteClient(logger);
+        this.eslintFixOptions = (0, TEslintFixOptions_1.extractEslintFixOptions)(rawOptions);
         const items = this.normalizeOptions(rawOptions).map(item => this.addDefaultValues(item));
         await this.generateCodeForItems(items);
     }

package/dist/core/WriteClient.d.ts

@@ -18,6 +18,7 @@ import { writeClientSchemasIndex } from './utils/writeClientSchemasIndex';
 import { writeClientServices } from './utils/writeClientServices';
 import { writeClientServicesIndex } from './utils/writeClientServicesIndex';
 import { writeClientSimpleIndex } from './utils/writeClientSimpleIndex';
+import { WriteFileIfChangedResult } from './utils/writeFileIfChanged';
 /**
  * @param client Client object with all the models, services, etc.
  * @param templates Templates wrapper with all loaded Handlebars templates
@@ -28,7 +29,6 @@ import { writeClientSimpleIndex } from './utils/writeClientSimpleIndex';
  * @param excludeCoreServiceFiles The generation of the core and services is excluded
  * @param request: Path to custom request file
  * @param useCancelableRequest Use cancelable request type.
- * @param useRequestRaw Generate requestRaw methods and ApiResult-based raw stack.
  * @param useSeparatedIndexes Use separate index files for the core, models, schemas, and services
  * @param validationLibrary Validation library to use for schema validation
  */
@@ -43,15 +43,13 @@ type TWriteClientProps = {
     request?: string;
     customExecutorPath?: string;
     useCancelableRequest?: boolean;
-    useRequestRaw?: boolean;
     useSeparatedIndexes?: boolean;
     validationLibrary?: ValidationLibrary;
     emptySchemaStrategy: EmptySchemaStrategy;
     modelsMode?: ModelsMode;
-    useProjectPrettier?: boolean;
-    useEslintFix?: boolean;
+    prettierConfigPath?: string;
 };
-type TAPIClientGeneratorConfig = Omit<TWriteClientProps, 'httpClient' | 'useOptions' | 'request' | 'useCancelableRequest' | 'useRequestRaw' | 'useSeparatedIndexes'> & {
+type TAPIClientGeneratorConfig = Omit<TWriteClientProps, 'httpClient' | 'useOptions' | 'request' | 'useCancelableRequest' | 'useSeparatedIndexes'> & {
     schemaModels: Model[];
 };
 /**
@@ -59,6 +57,12 @@ type TAPIClientGeneratorConfig = Omit<TWriteClientProps, 'httpClient' | 'useOpti
  */
 export declare class WriteClient {
     private config;
+    private expectedOutputFiles;
+    private writeStats;
+    /** Absolute paths of generated model/service files for batch ESLint. */
+    private lintTargetFiles;
+    /** Output directory globs for the temporary tsconfig include. */
+    private lintIncludeGlobs;
     private _logger;
     constructor(logger?: Logger);
     /**
@@ -74,6 +78,30 @@ export declare class WriteClient {
     combineAndWrite(): Promise<void>;
     combineAndWrightSimple(): Promise<void>;
     get logger(): Logger;
+    writeOutputFile(filePath: string, content: string): Promise<WriteFileIfChangedResult>;
+    registerOutputFile(filePath: string): void;
+    getExpectedOutputFiles(): Set<string>;
+    getExpectedOutputFilesArray(): string[];
+    getWriteStats(): {
+        written: number;
+        unchanged: number;
+    };
+    /**
+     * Registers a generated file for the post-generation batch ESLint pass.
+     *
+     * @param filePath - Written file path (absolute or relative to cwd).
+     * @param outputRoot - Models or services output directory used to build a narrow tsconfig glob.
+     */
+    registerLintTarget(filePath: string, outputRoot: string): void;
+    /**
+     * Returns collected lint targets after all writeClient* calls.
+     */
+    getLintTargets(): {
+        files: string[];
+        includeGlobs: string[];
+    };
+    /** Clears the lint registry after batch ESLint finishes or is skipped. */
+    clearLintTargets(): void;
     private buildSimpleClientIndexMap;
     private buildClientIndexMap;
     private finalizeAndWrite;

package/dist/core/WriteClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"WriteClient.d.ts","sourceRoot":"","sources":["../../src/core/WriteClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAM1C,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAIxD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAExE;;;;;;;;;;;;;GAaG;AACH,KAAK,iBAAiB,GAAG;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,uBAAuB,EAAE,OAAO,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,KAAK,yBAAyB,GAAG,IAAI,CAAC,iBAAiB,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS,GAAG,sBAAsB,GAAG,eAAe,GAAG,qBAAqB,CAAC,GAAG;IACnK,YAAY,EAAE,KAAK,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,qBAAa,WAAW;IACpB,OAAO,CAAC,MAAM,CAAuD;IACrE,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,CAAC,EAAE,MAAM;IAU3B;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;YAyI9C,sBAAsB;IA0DpC;;;OAGG;IACH,6BAA6B,CAAC,MAAM,EAAE,yBAAyB;IAUzD,eAAe;IAKf,sBAAsB;IAK5B,IAAW,MAAM,WAEhB;IAED,OAAO,CAAC,yBAAyB;IAyCjC,OAAO,CAAC,mBAAmB;YAkEb,gBAAgB;YAUhB,uBAAuB;IAMrC,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,aAAa;IAId,eAAe,yBAAmB;IAClC,oBAAoB,8BAAwB;IAC5C,oBAAoB,8BAAwB;IAC5C,iBAAiB,2BAAqB;IACtC,sBAAsB,gCAA0B;IAChD,kBAAkB,4BAAsB;IACxC,uBAAuB,iCAA2B;IAClD,mBAAmB,6BAAuB;IAC1C,wBAAwB,kCAA4B;IACpD,sBAAsB,gCAA0B;IAChD,mBAAmB,6BAAuB;CACpD"}
+{"version":3,"file":"WriteClient.d.ts","sourceRoot":"","sources":["../../src/core/WriteClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAM1C,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAE7D,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,wCAAwC,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAC3D,OAAO,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAC1D,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,4BAA4B,CAAC;AAIxD,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAsB,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE1F;;;;;;;;;;;;GAYG;AACH,KAAK,iBAAiB,GAAG;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,SAAS,CAAC;IACrB,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,UAAU,CAAC;IACvB,UAAU,EAAE,OAAO,CAAC;IACpB,aAAa,EAAE,OAAO,CAAC;IACvB,uBAAuB,EAAE,OAAO,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,KAAK,yBAAyB,GAAG,IAAI,CAAC,iBAAiB,EAAE,YAAY,GAAG,YAAY,GAAG,SAAS,GAAG,sBAAsB,GAAG,qBAAqB,CAAC,GAAG;IACjJ,YAAY,EAAE,KAAK,EAAE,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,qBAAa,WAAW;IACpB,OAAO,CAAC,MAAM,CAAuD;IACrE,OAAO,CAAC,mBAAmB,CAA0B;IACrD,OAAO,CAAC,UAAU,CAAgC;IAClD,wEAAwE;IACxE,OAAO,CAAC,eAAe,CAAqB;IAC5C,iEAAiE;IACjE,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,CAAC,EAAE,MAAM;IAU3B;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;YAiI9C,sBAAsB;IAwDpC;;;OAGG;IACH,6BAA6B,CAAC,MAAM,EAAE,yBAAyB;IAUzD,eAAe;IAKf,sBAAsB;IAK5B,IAAW,MAAM,WAEhB;IAEY,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAO3F,kBAAkB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI1C,sBAAsB,IAAI,GAAG,CAAC,MAAM,CAAC;IAIrC,2BAA2B,IAAI,MAAM,EAAE;IAIvC,aAAa,IAAI;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE;IAI9D;;;;;OAKG;IACI,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI;IAKrE;;OAEG;IACI,cAAc,IAAI;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,YAAY,EAAE,MAAM,EAAE,CAAA;KAAE;IAOpE,0EAA0E;IACnE,gBAAgB,IAAI,IAAI;IAK/B,OAAO,CAAC,yBAAyB;IAyCjC,OAAO,CAAC,mBAAmB;YAkEb,gBAAgB;YAUhB,uBAAuB;IAMrC,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,iBAAiB;IAiBzB,OAAO,CAAC,uBAAuB;IAe/B,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,aAAa;IAId,eAAe,yBAAmB;IAClC,oBAAoB,8BAAwB;IAC5C,oBAAoB,8BAAwB;IAC5C,iBAAiB,2BAAqB;IACtC,sBAAsB,gCAA0B;IAChD,kBAAkB,4BAAsB;IACxC,uBAAuB,iCAA2B;IAClD,mBAAmB,6BAAuB;IAC1C,wBAAwB,kCAA4B;IACpD,sBAAsB,gCAA0B;IAChD,mBAAmB,6BAAuB;CACpD"}

package/dist/core/WriteClient.js

@@ -21,11 +21,18 @@ const writeClientSchemasIndex_1 = require("./utils/writeClientSchemasIndex");
 const writeClientServices_1 = require("./utils/writeClientServices");
 const writeClientServicesIndex_1 = require("./utils/writeClientServicesIndex");
 const writeClientSimpleIndex_1 = require("./utils/writeClientSimpleIndex");
+const writeFileIfChanged_1 = require("./utils/writeFileIfChanged");
 /**
  * The client which is writing all items and keep the parameters to write index file
  */
 class WriteClient {
     config = new Map();
+    expectedOutputFiles = new Set();
+    writeStats = { written: 0, unchanged: 0 };
+    /** Absolute paths of generated model/service files for batch ESLint. */
+    lintTargetFiles = new Set();
+    /** Output directory globs for the temporary tsconfig include. */
+    lintIncludeGlobs = new Set();
     _logger;
     constructor(logger) {
         this._logger =
@@ -40,14 +47,14 @@ class WriteClient {
      * Write our OpenAPI client, using the given templates at the given output
      */
     async writeClient(options) {
-        const { client, templates, outputPaths, httpClient, useOptions, useUnionTypes, excludeCoreServiceFiles = false, request, customExecutorPath, useCancelableRequest = false, useRequestRaw = true, useSeparatedIndexes = false, validationLibrary = ValidationLibrary_enum_1.ValidationLibrary.NONE, emptySchemaStrategy, modelsMode, useProjectPrettier = false, useEslintFix = false, } = options;
+        const { client, templates, outputPaths, httpClient, useOptions, useUnionTypes, excludeCoreServiceFiles = false, request, customExecutorPath, useCancelableRequest = false, useSeparatedIndexes = false, validationLibrary = ValidationLibrary_enum_1.ValidationLibrary.NONE, emptySchemaStrategy, modelsMode, prettierConfigPath, } = options;
         if (!excludeCoreServiceFiles) {
             const executorPath = (0, pathHelpers_1.resolveHelper)(outputPaths.outputCore, 'executor');
             const interceptorsPath = (0, pathHelpers_1.resolveHelper)(outputPaths.outputCore, 'interceptors');
             await fileSystemHelpers_1.fileSystemHelpers.mkdir(outputPaths.outputCore);
             await fileSystemHelpers_1.fileSystemHelpers.mkdir(executorPath);
             await fileSystemHelpers_1.fileSystemHelpers.mkdir(interceptorsPath);
-            await this.writeClientCore({ client, templates, outputCorePath: outputPaths.outputCore, httpClient, request, useCancelableRequest, useRequestRaw, modelsMode });
+            await this.writeClientCore({ client, templates, outputCorePath: outputPaths.outputCore, httpClient, request, useCancelableRequest, modelsMode });
             await this.writeClientCoreIndex({
                 templates,
                 outputCorePath: outputPaths.outputCore,
@@ -69,9 +76,7 @@ class WriteClient {
                 useUnionTypes,
                 useOptions,
                 useCancelableRequest,
-                useRequestRaw,
-                useProjectPrettier,
-                useEslintFix,
+                prettierConfigPath,
             });
             await this.writeClientServicesIndex({
                 services: client.services,
@@ -86,8 +91,7 @@ class WriteClient {
                 templates,
                 request,
                 customExecutorPath,
-                useProjectPrettier,
-                useEslintFix,
+                prettierConfigPath,
             });
         }
         /**
@@ -104,8 +108,7 @@ class WriteClient {
                 useUnionTypes,
                 validationLibrary,
                 emptySchemaStrategy,
-                useProjectPrettier,
-                useEslintFix,
+                prettierConfigPath,
             });
             await this.writeClientSchemasIndex({
                 models: schemaModels,
@@ -129,8 +132,7 @@ class WriteClient {
                 emptySchemaStrategy,
                 modelsMode,
                 schemaModels,
-                useProjectPrettier,
-                useEslintFix,
+                prettierConfigPath,
             });
             return;
         }
@@ -150,17 +152,16 @@ class WriteClient {
             emptySchemaStrategy,
             modelsMode,
             schemaModels: [],
-            useProjectPrettier,
-            useEslintFix,
+            prettierConfigPath,
         });
     }
     async writeModelsAndFinalize(config) {
-        const { client, templates, outputPaths, httpClient, useUnionTypes, useOptions, useSeparatedIndexes, excludeCoreServiceFiles, validationLibrary, emptySchemaStrategy, modelsMode, schemaModels, useProjectPrettier, useEslintFix, } = config;
+        const { client, templates, outputPaths, httpClient, useUnionTypes, useOptions, useSeparatedIndexes, excludeCoreServiceFiles, validationLibrary, emptySchemaStrategy, modelsMode, schemaModels, prettierConfigPath, } = config;
         await fileSystemHelpers_1.fileSystemHelpers.mkdir(outputPaths.outputModels);
         const shouldInlineDtoCore = modelsMode === ModelsMode_enum_1.ModelsMode.CLASSES && excludeCoreServiceFiles;
         if (shouldInlineDtoCore) {
-            await fileSystemHelpers_1.fileSystemHelpers.writeFile((0, pathHelpers_1.resolveHelper)(outputPaths.outputModels, 'BaseDto.ts'), templates.core.baseDto({}));
-            await fileSystemHelpers_1.fileSystemHelpers.writeFile((0, pathHelpers_1.resolveHelper)(outputPaths.outputModels, 'dtoUtils.ts'), templates.core.dtoUtils({}));
+            await this.writeOutputFile((0, pathHelpers_1.resolveHelper)(outputPaths.outputModels, 'BaseDto.ts'), templates.core.baseDto({}));
+            await this.writeOutputFile((0, pathHelpers_1.resolveHelper)(outputPaths.outputModels, 'dtoUtils.ts'), templates.core.dtoUtils({}));
         }
         await this.writeClientModels({
             models: client.models,
@@ -171,8 +172,7 @@ class WriteClient {
             useOptions,
             modelsMode,
             outputCorePath: shouldInlineDtoCore ? './' : (0, pathHelpers_1.relativeHelper)(outputPaths.outputModels, outputPaths.outputCore),
-            useProjectPrettier,
-            useEslintFix,
+            prettierConfigPath,
         });
         await this.writeClientModelsIndex({
             models: client.models,
@@ -219,6 +219,48 @@ class WriteClient {
     get logger() {
         return this._logger;
     }
+    async writeOutputFile(filePath, content) {
+        this.expectedOutputFiles.add((0, pathHelpers_1.resolveHelper)(process.cwd(), filePath));
+        const result = await (0, writeFileIfChanged_1.writeFileIfChanged)(filePath, content);
+        this.writeStats[result] += 1;
+        return result;
+    }
+    registerOutputFile(filePath) {
+        this.expectedOutputFiles.add((0, pathHelpers_1.resolveHelper)(process.cwd(), filePath));
+    }
+    getExpectedOutputFiles() {
+        return this.expectedOutputFiles;
+    }
+    getExpectedOutputFilesArray() {
+        return Array.from(this.expectedOutputFiles);
+    }
+    getWriteStats() {
+        return { ...this.writeStats };
+    }
+    /**
+     * Registers a generated file for the post-generation batch ESLint pass.
+     *
+     * @param filePath - Written file path (absolute or relative to cwd).
+     * @param outputRoot - Models or services output directory used to build a narrow tsconfig glob.
+     */
+    registerLintTarget(filePath, outputRoot) {
+        this.lintTargetFiles.add((0, pathHelpers_1.resolveHelper)(process.cwd(), filePath));
+        this.lintIncludeGlobs.add(`${outputRoot.replace(/\\/g, '/')}/**/*.ts`);
+    }
+    /**
+     * Returns collected lint targets after all writeClient* calls.
+     */
+    getLintTargets() {
+        return {
+            files: [...this.lintTargetFiles],
+            includeGlobs: [...this.lintIncludeGlobs],
+        };
+    }
+    /** Clears the lint registry after batch ESLint finishes or is skipped. */
+    clearLintTargets() {
+        this.lintTargetFiles.clear();
+        this.lintIncludeGlobs.clear();
+    }
     buildSimpleClientIndexMap() {
         const result = new Map();
         for (const [key, value] of this.config.entries()) {

package/dist/core/__tests__/WriteClient.test.js

@@ -61,7 +61,7 @@ const WriteClient_1 = require("../WriteClient");
                 interceptors: () => 'interceptors',
                 withInterceptors: () => 'withInterceptors',
                 baseDto: () => 'baseDto',
-                dtoUtils: () => 'dtoUtils'
+                dtoUtils: () => 'dtoUtils',
             },
         };
         const outputPaths = (0, getOutputPaths_1.getOutputPaths)({ output: './dist' });