@graphql-codegen/cli 6.0.0 → 6.1.1

package/cjs/codegen.js

@@ -245,12 +245,17 @@ async function executeCodegen(input) {
                                             const name = Object.keys(plugin)[0];
                                             return [name, pkg];
                                         }));
+                                        const importExtension = (0, plugin_helpers_1.normalizeImportExtension)({
+                                            emitLegacyCommonJSImports: config.emitLegacyCommonJSImports,
+                                            importExtension: config.importExtension,
+                                        });
                                         const mergedConfig = {
                                             ...rootConfig,
                                             ...(typeof outputFileTemplateConfig === 'string'
                                                 ? { value: outputFileTemplateConfig }
                                                 : outputFileTemplateConfig),
-                                            emitLegacyCommonJSImports: (0, config_js_1.shouldEmitLegacyCommonJSImports)(config),
+                                            importExtension,
+                                            emitLegacyCommonJSImports: config.emitLegacyCommonJSImports ?? true,
                                         };
                                         const documentTransforms = Array.isArray(outputConfig.documentTransforms)
                                             ? await Promise.all(outputConfig.documentTransforms.map(async (config, index) => {
@@ -288,8 +293,8 @@ async function executeCodegen(input) {
                                         const process = async (outputArgs) => {
                                             const output = await (0, core_1.codegen)({
                                                 ...outputArgs,
-                                                // @ts-expect-error todo: fix 'emitLegacyCommonJSImports' does not exist in type 'GenerateOptions'
-                                                emitLegacyCommonJSImports: (0, config_js_1.shouldEmitLegacyCommonJSImports)(config, outputArgs.filename),
+                                                importExtension,
+                                                emitLegacyCommonJSImports: config.emitLegacyCommonJSImports ?? true,
                                                 cache,
                                             });
                                             result.push({
@@ -319,7 +324,7 @@ async function executeCodegen(input) {
                         exitOnError: false,
                     };
                 });
-                return task.newListr(generateTasks, { concurrent: (0, os_1.cpus)().length });
+                return task.newListr(generateTasks, { concurrent: (0, os_1.cpus)().length || 1 });
             },
         },
     ], {

package/cjs/config.js

@@ -9,7 +9,6 @@ exports.parseArgv = parseArgv;
 exports.createContext = createContext;
 exports.updateContextWithCliFlags = updateContextWithCliFlags;
 exports.ensureContext = ensureContext;
-exports.shouldEmitLegacyCommonJSImports = shouldEmitLegacyCommonJSImports;
 const tslib_1 = require("tslib");
 const crypto_1 = require("crypto");
 const fs_1 = require("fs");
@@ -178,6 +177,18 @@ function buildOptions() {
             type: 'boolean',
             default: false,
         },
+        'emit-legacy-common-js-imports': {
+            describe: 'Emit legacy CommonJS imports (deprecated, use import-extension instead)',
+            type: 'boolean',
+        },
+        'import-extension': {
+            describe: 'Extension to append to imports (e.g., .js, .mjs, or empty string for no extension)',
+            type: 'string',
+        },
+        'ignore-no-documents': {
+            describe: 'Suppress errors for no documents',
+            type: 'boolean',
+        },
     };
 }
 function parseArgv(argv = process.argv) {
@@ -225,6 +236,9 @@ function updateContextWithCliFlags(context, cliFlags) {
         // for some reason parsed value is `'false'` string so this ensure it always is a boolean.
         config.emitLegacyCommonJSImports = cliFlags['emit-legacy-common-js-imports'] === true;
     }
+    if (cliFlags['import-extension'] !== undefined) {
+        config.importExtension = cliFlags['import-extension'];
+    }
     if (cliFlags.project) {
         context.useProject(cliFlags.project);
     }
@@ -352,15 +366,3 @@ function addHashToDocumentFiles(documentFilesPromise) {
         return doc;
     }));
 }
-function shouldEmitLegacyCommonJSImports(config) {
-    const globalValue = config.emitLegacyCommonJSImports === undefined ? true : !!config.emitLegacyCommonJSImports;
-    // const outputConfig = config.generates[outputPath];
-    // if (!outputConfig) {
-    //   debugLog(`Couldn't find a config of ${outputPath}`);
-    //   return globalValue;
-    // }
-    // if (isConfiguredOutput(outputConfig) && typeof outputConfig.emitLegacyCommonJSImports === 'boolean') {
-    //   return outputConfig.emitLegacyCommonJSImports;
-    // }
-    return globalValue;
-}

package/cjs/utils/watcher.js

@@ -48,7 +48,21 @@ const createWatcher = (initialContext, onNext) => {
         const debouncedExec = (0, debounce_1.default)(() => {
             if (!isShutdown) {
                 (0, codegen_js_1.executeCodegen)(initialContext)
-                    .then(({ result }) => onNext(result), () => Promise.resolve())
+                    .then(({ result, error }) => {
+                    // FIXME: this is a quick fix to stop `onNext` (writeOutput) from
+                    // removing all files when there is an error.
+                    //
+                    // This is because `removeStaleFiles()` will remove files if the
+                    // generated files are different between runs. And on error, it
+                    // returns an empty array i.e. will remove all generated files from
+                    // the previous run
+                    //
+                    // This also means we don't have config.allowPartialOutputs in watch mode
+                    if (error) {
+                        return;
+                    }
+                    onNext(result);
+                }, () => Promise.resolve())
                     .then(() => emitWatching(watchDirectory));
             }
         }, 100);
@@ -146,7 +160,14 @@ const createWatcher = (initialContext, onNext) => {
      */
     stopWatching.runningWatcher = new Promise((resolve, reject) => {
         (0, codegen_js_1.executeCodegen)(initialContext)
-            .then(({ result }) => onNext(result), () => Promise.resolve())
+            .then(({ result, error }) => {
+            // TODO: this is the initial run, the logic here mimics the above watcher logic.
+            // We need to check whether it's ok to deviate between these two.
+            if (error) {
+                return;
+            }
+            onNext(result);
+        }, () => Promise.resolve())
             .then(() => runWatcher(abortController.signal))
             .catch(err => {
             watcherSubscription.unsubscribe();

package/esm/codegen.js

@@ -3,11 +3,11 @@ import { createRequire } from 'module';
 import { cpus } from 'os';
 import path from 'path';
 import { codegen } from '@graphql-codegen/core';
-import { getCachedDocumentNodeFromSchema, normalizeConfig, normalizeInstanceOrArray, normalizeOutputParam, } from '@graphql-codegen/plugin-helpers';
+import { getCachedDocumentNodeFromSchema, normalizeConfig, normalizeImportExtension, normalizeInstanceOrArray, normalizeOutputParam, } from '@graphql-codegen/plugin-helpers';
 import { NoTypeDefinitionsFound } from '@graphql-tools/load';
 import { GraphQLError } from 'graphql';
 import { Listr } from 'listr2';
-import { ensureContext, shouldEmitLegacyCommonJSImports } from './config.js';
+import { ensureContext } from './config.js';
 import { getPluginByName } from './plugins.js';
 import { getPresetByName } from './presets.js';
 import { debugLog, printLogs } from './utils/debugging.js';
@@ -241,12 +241,17 @@ export async function executeCodegen(input) {
                                             const name = Object.keys(plugin)[0];
                                             return [name, pkg];
                                         }));
+                                        const importExtension = normalizeImportExtension({
+                                            emitLegacyCommonJSImports: config.emitLegacyCommonJSImports,
+                                            importExtension: config.importExtension,
+                                        });
                                         const mergedConfig = {
                                             ...rootConfig,
                                             ...(typeof outputFileTemplateConfig === 'string'
                                                 ? { value: outputFileTemplateConfig }
                                                 : outputFileTemplateConfig),
-                                            emitLegacyCommonJSImports: shouldEmitLegacyCommonJSImports(config),
+                                            importExtension,
+                                            emitLegacyCommonJSImports: config.emitLegacyCommonJSImports ?? true,
                                         };
                                         const documentTransforms = Array.isArray(outputConfig.documentTransforms)
                                             ? await Promise.all(outputConfig.documentTransforms.map(async (config, index) => {
@@ -284,8 +289,8 @@ export async function executeCodegen(input) {
                                         const process = async (outputArgs) => {
                                             const output = await codegen({
                                                 ...outputArgs,
-                                                // @ts-expect-error todo: fix 'emitLegacyCommonJSImports' does not exist in type 'GenerateOptions'
-                                                emitLegacyCommonJSImports: shouldEmitLegacyCommonJSImports(config, outputArgs.filename),
+                                                importExtension,
+                                                emitLegacyCommonJSImports: config.emitLegacyCommonJSImports ?? true,
                                                 cache,
                                             });
                                             result.push({
@@ -315,7 +320,7 @@ export async function executeCodegen(input) {
                         exitOnError: false,
                     };
                 });
-                return task.newListr(generateTasks, { concurrent: cpus().length });
+                return task.newListr(generateTasks, { concurrent: cpus().length || 1 });
             },
         },
     ], {

package/esm/config.js

@@ -165,6 +165,18 @@ export function buildOptions() {
             type: 'boolean',
             default: false,
         },
+        'emit-legacy-common-js-imports': {
+            describe: 'Emit legacy CommonJS imports (deprecated, use import-extension instead)',
+            type: 'boolean',
+        },
+        'import-extension': {
+            describe: 'Extension to append to imports (e.g., .js, .mjs, or empty string for no extension)',
+            type: 'string',
+        },
+        'ignore-no-documents': {
+            describe: 'Suppress errors for no documents',
+            type: 'boolean',
+        },
     };
 }
 export function parseArgv(argv = process.argv) {
@@ -212,6 +224,9 @@ export function updateContextWithCliFlags(context, cliFlags) {
         // for some reason parsed value is `'false'` string so this ensure it always is a boolean.
         config.emitLegacyCommonJSImports = cliFlags['emit-legacy-common-js-imports'] === true;
     }
+    if (cliFlags['import-extension'] !== undefined) {
+        config.importExtension = cliFlags['import-extension'];
+    }
     if (cliFlags.project) {
         context.useProject(cliFlags.project);
     }
@@ -338,15 +353,3 @@ function addHashToDocumentFiles(documentFilesPromise) {
         return doc;
     }));
 }
-export function shouldEmitLegacyCommonJSImports(config) {
-    const globalValue = config.emitLegacyCommonJSImports === undefined ? true : !!config.emitLegacyCommonJSImports;
-    // const outputConfig = config.generates[outputPath];
-    // if (!outputConfig) {
-    //   debugLog(`Couldn't find a config of ${outputPath}`);
-    //   return globalValue;
-    // }
-    // if (isConfiguredOutput(outputConfig) && typeof outputConfig.emitLegacyCommonJSImports === 'boolean') {
-    //   return outputConfig.emitLegacyCommonJSImports;
-    // }
-    return globalValue;
-}

package/esm/utils/watcher.js

@@ -44,7 +44,21 @@ export const createWatcher = (initialContext, onNext) => {
         const debouncedExec = debounce(() => {
             if (!isShutdown) {
                 executeCodegen(initialContext)
-                    .then(({ result }) => onNext(result), () => Promise.resolve())
+                    .then(({ result, error }) => {
+                    // FIXME: this is a quick fix to stop `onNext` (writeOutput) from
+                    // removing all files when there is an error.
+                    //
+                    // This is because `removeStaleFiles()` will remove files if the
+                    // generated files are different between runs. And on error, it
+                    // returns an empty array i.e. will remove all generated files from
+                    // the previous run
+                    //
+                    // This also means we don't have config.allowPartialOutputs in watch mode
+                    if (error) {
+                        return;
+                    }
+                    onNext(result);
+                }, () => Promise.resolve())
                     .then(() => emitWatching(watchDirectory));
             }
         }, 100);
@@ -142,7 +156,14 @@ export const createWatcher = (initialContext, onNext) => {
      */
     stopWatching.runningWatcher = new Promise((resolve, reject) => {
         executeCodegen(initialContext)
-            .then(({ result }) => onNext(result), () => Promise.resolve())
+            .then(({ result, error }) => {
+            // TODO: this is the initial run, the logic here mimics the above watcher logic.
+            // We need to check whether it's ok to deviate between these two.
+            if (error) {
+                return;
+            }
+            onNext(result);
+        }, () => Promise.resolve())
             .then(() => runWatcher(abortController.signal))
             .catch(err => {
             watcherSubscription.unsubscribe();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/cli",
-  "version": "6.0.0",
+  "version": "6.1.1",
   "peerDependenciesMeta": {
     "@parcel/watcher": {
       "optional": true
@@ -14,17 +14,17 @@
     "@babel/generator": "^7.18.13",
     "@babel/template": "^7.18.10",
     "@babel/types": "^7.18.13",
-    "@graphql-codegen/client-preset": "^5.0.0",
+    "@graphql-codegen/client-preset": "^5.2.0",
     "@graphql-codegen/core": "^5.0.0",
-    "@graphql-codegen/plugin-helpers": "^6.0.0",
+    "@graphql-codegen/plugin-helpers": "^6.1.0",
     "@graphql-tools/apollo-engine-loader": "^8.0.0",
     "@graphql-tools/code-file-loader": "^8.0.0",
     "@graphql-tools/git-loader": "^8.0.0",
-    "@graphql-tools/github-loader": "^8.0.0",
+    "@graphql-tools/github-loader": "^9.0.0",
     "@graphql-tools/graphql-file-loader": "^8.0.0",
     "@graphql-tools/json-file-loader": "^8.0.0",
     "@graphql-tools/load": "^8.1.0",
-    "@graphql-tools/url-loader": "^8.0.0",
+    "@graphql-tools/url-loader": "^9.0.0",
     "@graphql-tools/utils": "^10.0.0",
     "@inquirer/prompts": "^7.8.2",
     "@whatwg-node/fetch": "^0.10.0",

package/typings/config.d.cts

@@ -16,6 +16,7 @@ export type YamlCliFlags = {
     debug?: boolean;
     ignoreNoDocuments?: boolean;
     emitLegacyCommonJSImports?: boolean;
+    importExtension?: '' | `.${string}`;
 };
 export declare function generateSearchPlaces(moduleName: string): string[];
 export type CodegenConfigLoader = (filepath: string, content: string) => Promise<Types.Config> | Types.Config;
@@ -103,6 +104,18 @@ export declare function buildOptions(): {
         type: "boolean";
         default: boolean;
     };
+    'emit-legacy-common-js-imports': {
+        describe: string;
+        type: "boolean";
+    };
+    'import-extension': {
+        describe: string;
+        type: "string";
+    };
+    'ignore-no-documents': {
+        describe: string;
+        type: "boolean";
+    };
 };
 export declare function parseArgv(argv?: string[]): YamlCliFlags;
 export declare function createContext(cliFlags?: YamlCliFlags): Promise<CodegenContext>;
@@ -137,4 +150,3 @@ export declare class CodegenContext {
     loadDocuments(pointer: Types.OperationDocument[]): Promise<Types.DocumentFile[]>;
 }
 export declare function ensureContext(input: CodegenContext | Types.Config): CodegenContext;
-export declare function shouldEmitLegacyCommonJSImports(config: Types.Config): boolean;

package/typings/config.d.ts

@@ -16,6 +16,7 @@ export type YamlCliFlags = {
     debug?: boolean;
     ignoreNoDocuments?: boolean;
     emitLegacyCommonJSImports?: boolean;
+    importExtension?: '' | `.${string}`;
 };
 export declare function generateSearchPlaces(moduleName: string): string[];
 export type CodegenConfigLoader = (filepath: string, content: string) => Promise<Types.Config> | Types.Config;
@@ -103,6 +104,18 @@ export declare function buildOptions(): {
         type: "boolean";
         default: boolean;
     };
+    'emit-legacy-common-js-imports': {
+        describe: string;
+        type: "boolean";
+    };
+    'import-extension': {
+        describe: string;
+        type: "string";
+    };
+    'ignore-no-documents': {
+        describe: string;
+        type: "boolean";
+    };
 };
 export declare function parseArgv(argv?: string[]): YamlCliFlags;
 export declare function createContext(cliFlags?: YamlCliFlags): Promise<CodegenContext>;
@@ -137,4 +150,3 @@ export declare class CodegenContext {
     loadDocuments(pointer: Types.OperationDocument[]): Promise<Types.DocumentFile[]>;
 }
 export declare function ensureContext(input: CodegenContext | Types.Config): CodegenContext;
-export declare function shouldEmitLegacyCommonJSImports(config: Types.Config): boolean;

package/typings/generate-and-save.d.cts

@@ -2,4 +2,9 @@ import { Types } from '@graphql-codegen/plugin-helpers';
 import { CodegenContext } from './config.cjs';
 export declare function generate(input: CodegenContext | (Types.Config & {
     cwd?: string;
-}), saveToFile?: boolean): Promise<Types.FileOutput[] | any>;
+}), saveToFile?: boolean): Promise<Types.FileOutput[]
+/**
+ * When this function runs in watch mode, it'd return an empty promise that doesn't resolve until the watcher exits
+ * FIXME: this effectively makes the result `any`, which loses type-hints
+ */
+ | any>;

package/typings/generate-and-save.d.ts

@@ -2,4 +2,9 @@ import { Types } from '@graphql-codegen/plugin-helpers';
 import { CodegenContext } from './config.js';
 export declare function generate(input: CodegenContext | (Types.Config & {
     cwd?: string;
-}), saveToFile?: boolean): Promise<Types.FileOutput[] | any>;
+}), saveToFile?: boolean): Promise<Types.FileOutput[]
+/**
+ * When this function runs in watch mode, it'd return an empty promise that doesn't resolve until the watcher exits
+ * FIXME: this effectively makes the result `any`, which loses type-hints
+ */
+ | any>;