@graphql-codegen/cli 7.3.1 → 7.4.0

package/cjs/codegen.js

@@ -378,6 +378,15 @@ async function executeCodegen(input) {
                                                 filename: outputArgs.filename,
                                                 content: output,
                                                 hooks: outputConfig.hooks || {},
+                                                // A preset sets `outputArgs` per output via `buildGeneratesSection`.
+                                                // Fall back to `outputConfig` so plugin outputs can opt in too.
+                                                contentComparison: outputArgs.contentComparison ?? outputConfig.contentComparison,
+                                                // Carry the entry's `overwrite` onto the file so the CLI can honor it per file.
+                                                // Unlike `contentComparison`, this is intentionally not
+                                                // `outputArgs.overwrite ?? outputConfig.overwrite`: presets should not
+                                                // be able to set `overwrite` per file from buildGeneratesSection
+                                                // (a capability this doesn't need).
+                                                overwrite: outputConfig.overwrite,
                                             });
                                         };
                                         await context.profiler.run(() => Promise.all(outputs.map(process)), `Codegen: ${filename}`);

package/cjs/generate-and-save.js

@@ -17,15 +17,17 @@ async function generate(input, saveToFile = true) {
     const context = (0, config_js_1.ensureContext)(input);
     const config = context.getConfig();
     await context.profiler.run(() => (0, hooks_js_1.lifecycleHooks)(config.hooks).afterStart(), 'Lifecycle: afterStart');
-    let previouslyGeneratedFilenames = [];
+    // Store only the projection (`filename` + `overwrite`) rather than full results, so a
+    // file that disappears is still judged by the `overwrite` of the entry that produced it.
+    let previouslyGeneratedFiles = [];
     function removeStaleFiles(config, generationResult) {
         const filenames = generationResult.map(o => o.filename);
         // find stale files from previous build which are not present in current build
-        const staleFilenames = previouslyGeneratedFilenames.filter(f => !filenames.includes(f));
-        for (const filename of staleFilenames) {
-            if (normalizeOverwriteConfig(config, filename).removeStaleFiles) {
-                (0, file_system_js_1.unlinkFile)(filename, err => {
-                    const prettyFilename = filename.replace(`${input.cwd || process.cwd()}/`, '');
+        const staleFiles = previouslyGeneratedFiles.filter(f => !filenames.includes(f.filename));
+        for (const staleFile of staleFiles) {
+            if (normalizeOverwriteConfig(config.overwrite, staleFile.overwrite).removeStaleFiles) {
+                (0, file_system_js_1.unlinkFile)(staleFile.filename, err => {
+                    const prettyFilename = staleFile.filename.replace(`${input.cwd || process.cwd()}/`, '');
                     if (err) {
                         (0, debugging_js_1.debugLog)(`Cannot remove stale file: ${prettyFilename}\n${err}`);
                     }
@@ -35,8 +37,15 @@ async function generate(input, saveToFile = true) {
                 });
             }
         }
-        previouslyGeneratedFilenames = filenames;
+        previouslyGeneratedFiles = generationResult.map(res => ({
+            filename: res.filename,
+            overwrite: res.overwrite,
+        }));
     }
+    // Records the hash of the content codegen last wrote per file. This is always
+    // kept up to date; `FileOutput.contentComparison` only decides whether the
+    // skip-check trusts this record ('cache-first') or re-reads the file from disk
+    // ('disk'), for outputs whose content depends on the file's existing content.
     const recentOutputHash = new Map();
     async function writeOutput(generationResult) {
         if (!saveToFile) {
@@ -49,13 +58,29 @@ async function generate(input, saveToFile = true) {
             await (0, hooks_js_1.lifecycleHooks)(config.hooks).beforeAllFileWrite(generationResult.map(r => r.filename));
         }, 'Lifecycle: beforeAllFileWrite');
         await context.profiler.run(() => Promise.all(generationResult.map(async (result) => {
-            const previousHash = recentOutputHash.get(result.filename) || (await hashFile(result.filename));
+            // The "previous" hash the skip-check compares against:
+            // - 'cache-first' trusts the in-memory record of what codegen last wrote
+            // (falling back to disk when there's no entry).
+            // - 'disk' always re-reads the file, because the output's content
+            // depends on the file's existing content
+            // (e.g. a preset that reads the file and rewrites part of it), so the
+            // in-memory record could wrongly skip a write when the file was changed
+            // on disk but the regenerated content matches a previous run.
+            const previousHash = await (async function getPreviousHash() {
+                const { contentComparison = 'cache-first' } = result;
+                if (contentComparison === 'disk') {
+                    return await hashFile(result.filename);
+                }
+                return recentOutputHash.get(result.filename) || (await hashFile(result.filename));
+            })();
             const exists = previousHash !== null;
-            // Store previous hash to avoid reading from disk again
+            // Always update the cache, regardless of `cache-first` or `disk` option,
+            // so subsequent runs have consistent entry to compare against
             if (previousHash) {
                 recentOutputHash.set(result.filename, previousHash);
             }
-            if (!normalizeOverwriteConfig(config, result.filename).updateExistingFiles && exists) {
+            if (!normalizeOverwriteConfig(config.overwrite, result.overwrite).updateExistingFiles &&
+                exists) {
                 return;
             }
             let content = result.content || '';
@@ -132,19 +157,8 @@ async function generate(input, saveToFile = true) {
     await writeProfilerOutput();
     return outputFiles;
 }
-function normalizeOverwriteConfig(config, outputPath) {
-    const overwrite = (function getOverwriteOption() {
-        const { overwrite: result = true } = config;
-        const outputConfig = config.generates[outputPath];
-        if (!outputConfig) {
-            (0, debugging_js_1.debugLog)(`Couldn't find a config of ${outputPath}`);
-            return result;
-        }
-        if (isConfiguredOutput(outputConfig) && outputConfig.overwrite !== undefined) {
-            return outputConfig.overwrite;
-        }
-        return result;
-    })();
+function normalizeOverwriteConfig(configOverwrite, fileOverwrite) {
+    const overwrite = fileOverwrite ?? configOverwrite ?? true;
     if (overwrite === true) {
         return {
             removeStaleFiles: true,
@@ -160,9 +174,6 @@ function normalizeOverwriteConfig(config, outputPath) {
     const { removeStaleFiles = true, updateExistingFiles = true } = overwrite;
     return { removeStaleFiles, updateExistingFiles };
 }
-function isConfiguredOutput(output) {
-    return typeof output.plugins !== 'undefined';
-}
 async function hashFile(filePath) {
     try {
         return hash(await (0, file_system_js_1.readFile)(filePath));

package/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '7.3.1';
+exports.version = '7.4.0';

package/esm/codegen.js

@@ -374,6 +374,15 @@ export async function executeCodegen(input) {
                                                 filename: outputArgs.filename,
                                                 content: output,
                                                 hooks: outputConfig.hooks || {},
+                                                // A preset sets `outputArgs` per output via `buildGeneratesSection`.
+                                                // Fall back to `outputConfig` so plugin outputs can opt in too.
+                                                contentComparison: outputArgs.contentComparison ?? outputConfig.contentComparison,
+                                                // Carry the entry's `overwrite` onto the file so the CLI can honor it per file.
+                                                // Unlike `contentComparison`, this is intentionally not
+                                                // `outputArgs.overwrite ?? outputConfig.overwrite`: presets should not
+                                                // be able to set `overwrite` per file from buildGeneratesSection
+                                                // (a capability this doesn't need).
+                                                overwrite: outputConfig.overwrite,
                                             });
                                         };
                                         await context.profiler.run(() => Promise.all(outputs.map(process)), `Codegen: ${filename}`);

package/esm/generate-and-save.js

@@ -13,15 +13,17 @@ export async function generate(input, saveToFile = true) {
     const context = ensureContext(input);
     const config = context.getConfig();
     await context.profiler.run(() => lifecycleHooks(config.hooks).afterStart(), 'Lifecycle: afterStart');
-    let previouslyGeneratedFilenames = [];
+    // Store only the projection (`filename` + `overwrite`) rather than full results, so a
+    // file that disappears is still judged by the `overwrite` of the entry that produced it.
+    let previouslyGeneratedFiles = [];
     function removeStaleFiles(config, generationResult) {
         const filenames = generationResult.map(o => o.filename);
         // find stale files from previous build which are not present in current build
-        const staleFilenames = previouslyGeneratedFilenames.filter(f => !filenames.includes(f));
-        for (const filename of staleFilenames) {
-            if (normalizeOverwriteConfig(config, filename).removeStaleFiles) {
-                unlinkFile(filename, err => {
-                    const prettyFilename = filename.replace(`${input.cwd || process.cwd()}/`, '');
+        const staleFiles = previouslyGeneratedFiles.filter(f => !filenames.includes(f.filename));
+        for (const staleFile of staleFiles) {
+            if (normalizeOverwriteConfig(config.overwrite, staleFile.overwrite).removeStaleFiles) {
+                unlinkFile(staleFile.filename, err => {
+                    const prettyFilename = staleFile.filename.replace(`${input.cwd || process.cwd()}/`, '');
                     if (err) {
                         debugLog(`Cannot remove stale file: ${prettyFilename}\n${err}`);
                     }
@@ -31,8 +33,15 @@ export async function generate(input, saveToFile = true) {
                 });
             }
         }
-        previouslyGeneratedFilenames = filenames;
+        previouslyGeneratedFiles = generationResult.map(res => ({
+            filename: res.filename,
+            overwrite: res.overwrite,
+        }));
     }
+    // Records the hash of the content codegen last wrote per file. This is always
+    // kept up to date; `FileOutput.contentComparison` only decides whether the
+    // skip-check trusts this record ('cache-first') or re-reads the file from disk
+    // ('disk'), for outputs whose content depends on the file's existing content.
     const recentOutputHash = new Map();
     async function writeOutput(generationResult) {
         if (!saveToFile) {
@@ -45,13 +54,29 @@ export async function generate(input, saveToFile = true) {
             await lifecycleHooks(config.hooks).beforeAllFileWrite(generationResult.map(r => r.filename));
         }, 'Lifecycle: beforeAllFileWrite');
         await context.profiler.run(() => Promise.all(generationResult.map(async (result) => {
-            const previousHash = recentOutputHash.get(result.filename) || (await hashFile(result.filename));
+            // The "previous" hash the skip-check compares against:
+            // - 'cache-first' trusts the in-memory record of what codegen last wrote
+            // (falling back to disk when there's no entry).
+            // - 'disk' always re-reads the file, because the output's content
+            // depends on the file's existing content
+            // (e.g. a preset that reads the file and rewrites part of it), so the
+            // in-memory record could wrongly skip a write when the file was changed
+            // on disk but the regenerated content matches a previous run.
+            const previousHash = await (async function getPreviousHash() {
+                const { contentComparison = 'cache-first' } = result;
+                if (contentComparison === 'disk') {
+                    return await hashFile(result.filename);
+                }
+                return recentOutputHash.get(result.filename) || (await hashFile(result.filename));
+            })();
             const exists = previousHash !== null;
-            // Store previous hash to avoid reading from disk again
+            // Always update the cache, regardless of `cache-first` or `disk` option,
+            // so subsequent runs have consistent entry to compare against
             if (previousHash) {
                 recentOutputHash.set(result.filename, previousHash);
             }
-            if (!normalizeOverwriteConfig(config, result.filename).updateExistingFiles && exists) {
+            if (!normalizeOverwriteConfig(config.overwrite, result.overwrite).updateExistingFiles &&
+                exists) {
                 return;
             }
             let content = result.content || '';
@@ -128,19 +153,8 @@ export async function generate(input, saveToFile = true) {
     await writeProfilerOutput();
     return outputFiles;
 }
-function normalizeOverwriteConfig(config, outputPath) {
-    const overwrite = (function getOverwriteOption() {
-        const { overwrite: result = true } = config;
-        const outputConfig = config.generates[outputPath];
-        if (!outputConfig) {
-            debugLog(`Couldn't find a config of ${outputPath}`);
-            return result;
-        }
-        if (isConfiguredOutput(outputConfig) && outputConfig.overwrite !== undefined) {
-            return outputConfig.overwrite;
-        }
-        return result;
-    })();
+function normalizeOverwriteConfig(configOverwrite, fileOverwrite) {
+    const overwrite = fileOverwrite ?? configOverwrite ?? true;
     if (overwrite === true) {
         return {
             removeStaleFiles: true,
@@ -156,9 +170,6 @@ function normalizeOverwriteConfig(config, outputPath) {
     const { removeStaleFiles = true, updateExistingFiles = true } = overwrite;
     return { removeStaleFiles, updateExistingFiles };
 }
-function isConfiguredOutput(output) {
-    return typeof output.plugins !== 'undefined';
-}
 async function hashFile(filePath) {
     try {
         return hash(await readFile(filePath));

package/esm/version.js

@@ -1 +1 @@
-export const version = '7.3.1';
+export const version = '7.4.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/cli",
-  "version": "7.3.1",
+  "version": "7.4.0",
   "peerDependenciesMeta": {
     "@parcel/watcher": {
       "optional": true
@@ -45,7 +45,7 @@
     "yargs": "^18.0.0",
     "@graphql-codegen/client-preset": "^6.1.3",
     "@graphql-codegen/core": "^6.2.0",
-    "@graphql-codegen/plugin-helpers": "^7.2.1"
+    "@graphql-codegen/plugin-helpers": "^7.3.0"
   },
   "repository": {
     "type": "git",