@graphql-codegen/cli 2.8.0-alpha-bd464a586.0 → 2.8.0

package/esm/codegen.js

@@ -1,7 +1,6 @@
 import { DetailedError, normalizeOutputParam, normalizeInstanceOrArray, normalizeConfig, getCachedDocumentNodeFromSchema, isDetailedError, } from '@graphql-codegen/plugin-helpers';
 import { codegen } from '@graphql-codegen/core';
 import { AggregateError } from '@graphql-tools/utils';
-import { Renderer, ErrorRenderer } from './utils/listr-renderer.js';
 import { GraphQLError } from 'graphql';
 import { getPluginByName } from './plugins.js';
 import { getPresetByName } from './presets.js';
@@ -11,8 +10,7 @@ import fs from 'fs';
 import path from 'path';
 import { cpus } from 'os';
 import { createRequire } from 'module';
-import Listr from 'listr';
-import { isListrError } from './utils/cli-error.js';
+import { Listr } from 'listr2';
 /**
  * Poor mans ESM detection.
  * Looking at this and you have a better method?
@@ -53,39 +51,12 @@ export async function executeCodegen(input) {
     const config = context.getConfig();
     const pluginContext = context.getPluginContext();
     const result = [];
-    const commonListrOptions = {
-        exitOnError: true,
-    };
-    let listr;
-    if (process.env.VERBOSE) {
-        listr = new Listr({
-            ...commonListrOptions,
-            renderer: 'verbose',
-            nonTTYRenderer: 'verbose',
-        });
-    }
-    else if (process.env.NODE_ENV === 'test') {
-        listr = new Listr({
-            ...commonListrOptions,
-            renderer: 'silent',
-            nonTTYRenderer: 'silent',
-        });
-    }
-    else {
-        listr = new Listr({
-            ...commonListrOptions,
-            renderer: config.silent ? 'silent' : config.errorsOnly ? ErrorRenderer : Renderer,
-            nonTTYRenderer: config.silent ? 'silent' : 'default',
-            collapse: true,
-            clearOutput: false,
-        });
-    }
     let rootConfig = {};
     let rootSchemas;
     let rootDocuments;
     const generates = {};
     const cache = createCache();
-    function wrapTask(task, source, taskName) {
+    function wrapTask(task, source, taskName, ctx) {
         return () => {
             return context.profiler.run(async () => {
                 try {
@@ -95,6 +66,7 @@ export async function executeCodegen(input) {
                     if (source && !(error instanceof GraphQLError)) {
                         error.source = source;
                     }
+                    ctx.errors.push(error);
                     throw error;
                 }
             }, taskName);
@@ -165,123 +137,109 @@ export async function executeCodegen(input) {
       `);
         }
     }
-    listr.add({
-        title: 'Parse configuration',
-        task: () => normalize(),
-    });
-    listr.add({
-        title: 'Generate outputs',
-        task: () => {
-            return new Listr(Object.keys(generates).map(filename => {
-                const outputConfig = generates[filename];
-                const hasPreset = !!outputConfig.preset;
-                return {
-                    title: hasPreset
+    const isTest = process.env.NODE_ENV === 'test';
+    const tasks = new Listr([
+        {
+            title: 'Parse Configuration',
+            task: () => normalize(),
+        },
+        {
+            title: 'Generate outputs',
+            task: (ctx, task) => {
+                const generateTasks = Object.keys(generates).map(filename => {
+                    const outputConfig = generates[filename];
+                    const hasPreset = !!outputConfig.preset;
+                    const title = hasPreset
                         ? `Generate to ${filename} (using EXPERIMENTAL preset "${outputConfig.preset}")`
-                        : `Generate ${filename}`,
-                    task: () => {
-                        let outputSchemaAst;
-                        let outputSchema;
-                        const outputFileTemplateConfig = outputConfig.config || {};
-                        let outputDocuments = [];
-                        const outputSpecificSchemas = normalizeInstanceOrArray(outputConfig.schema);
-                        const outputSpecificDocuments = normalizeInstanceOrArray(outputConfig.documents);
-                        return new Listr([
-                            {
-                                title: 'Load GraphQL schemas',
-                                task: wrapTask(async () => {
-                                    debugLog(`[CLI] Loading Schemas`);
-                                    const schemaPointerMap = {};
-                                    const allSchemaUnnormalizedPointers = [...rootSchemas, ...outputSpecificSchemas];
-                                    for (const unnormalizedPtr of allSchemaUnnormalizedPointers) {
-                                        if (typeof unnormalizedPtr === 'string') {
-                                            schemaPointerMap[unnormalizedPtr] = {};
-                                        }
-                                        else if (typeof unnormalizedPtr === 'object') {
-                                            Object.assign(schemaPointerMap, unnormalizedPtr);
-                                        }
-                                    }
-                                    const hash = JSON.stringify(schemaPointerMap);
-                                    const result = await cache('schema', hash, async () => {
-                                        const outputSchemaAst = await context.loadSchema(schemaPointerMap);
-                                        const outputSchema = getCachedDocumentNodeFromSchema(outputSchemaAst);
-                                        return {
-                                            outputSchemaAst,
-                                            outputSchema,
-                                        };
-                                    });
-                                    outputSchemaAst = await result.outputSchemaAst;
-                                    outputSchema = result.outputSchema;
-                                }, filename, `Load GraphQL schemas: ${filename}`),
-                            },
-                            {
-                                title: 'Load GraphQL documents',
-                                task: wrapTask(async () => {
-                                    debugLog(`[CLI] Loading Documents`);
-                                    // get different cache for shared docs and output specific docs
-                                    const documentPointerMap = {};
-                                    const allDocumentsUnnormalizedPointers = [...rootDocuments, ...outputSpecificDocuments];
-                                    for (const unnormalizedPtr of allDocumentsUnnormalizedPointers) {
-                                        if (typeof unnormalizedPtr === 'string') {
-                                            documentPointerMap[unnormalizedPtr] = {};
+                        : `Generate ${filename}`;
+                    return {
+                        title,
+                        task: (_, subTask) => {
+                            let outputSchemaAst;
+                            let outputSchema;
+                            const outputFileTemplateConfig = outputConfig.config || {};
+                            let outputDocuments = [];
+                            const outputSpecificSchemas = normalizeInstanceOrArray(outputConfig.schema);
+                            const outputSpecificDocuments = normalizeInstanceOrArray(outputConfig.documents);
+                            return subTask.newListr([
+                                {
+                                    title: 'Load GraphQL schemas',
+                                    task: wrapTask(async () => {
+                                        debugLog(`[CLI] Loading Schemas`);
+                                        const schemaPointerMap = {};
+                                        const allSchemaDenormalizedPointers = [...rootSchemas, ...outputSpecificSchemas];
+                                        for (const denormalizedPtr of allSchemaDenormalizedPointers) {
+                                            if (typeof denormalizedPtr === 'string') {
+                                                schemaPointerMap[denormalizedPtr] = {};
+                                            }
+                                            else if (typeof denormalizedPtr === 'object') {
+                                                Object.assign(schemaPointerMap, denormalizedPtr);
+                                            }
                                         }
-                                        else if (typeof unnormalizedPtr === 'object') {
-                                            Object.assign(documentPointerMap, unnormalizedPtr);
+                                        const hash = JSON.stringify(schemaPointerMap);
+                                        const result = await cache('schema', hash, async () => {
+                                            const outputSchemaAst = await context.loadSchema(schemaPointerMap);
+                                            const outputSchema = getCachedDocumentNodeFromSchema(outputSchemaAst);
+                                            return {
+                                                outputSchemaAst,
+                                                outputSchema,
+                                            };
+                                        });
+                                        outputSchemaAst = result.outputSchemaAst;
+                                        outputSchema = result.outputSchema;
+                                    }, filename, `Load GraphQL schemas: ${filename}`, ctx),
+                                },
+                                {
+                                    title: 'Load GraphQL documents',
+                                    task: wrapTask(async () => {
+                                        debugLog(`[CLI] Loading Documents`);
+                                        const documentPointerMap = {};
+                                        const allDocumentsDenormalizedPointers = [...rootDocuments, ...outputSpecificDocuments];
+                                        for (const denormalizedPtr of allDocumentsDenormalizedPointers) {
+                                            if (typeof denormalizedPtr === 'string') {
+                                                documentPointerMap[denormalizedPtr] = {};
+                                            }
+                                            else if (typeof denormalizedPtr === 'object') {
+                                                Object.assign(documentPointerMap, denormalizedPtr);
+                                            }
                                         }
-                                    }
-                                    const hash = JSON.stringify(documentPointerMap);
-                                    const result = await cache('documents', hash, async () => {
-                                        const documents = await context.loadDocuments(documentPointerMap);
-                                        return {
-                                            documents,
+                                        const hash = JSON.stringify(documentPointerMap);
+                                        const result = await cache('documents', hash, async () => {
+                                            const documents = await context.loadDocuments(documentPointerMap);
+                                            return {
+                                                documents,
+                                            };
+                                        });
+                                        outputDocuments = result.documents;
+                                    }, filename, `Load GraphQL documents: ${filename}`, ctx),
+                                },
+                                {
+                                    title: 'Generate',
+                                    task: wrapTask(async () => {
+                                        debugLog(`[CLI] Generating output`);
+                                        const normalizedPluginsArray = normalizeConfig(outputConfig.plugins);
+                                        const pluginLoader = config.pluginLoader || makeDefaultLoader(context.cwd);
+                                        const pluginPackages = await Promise.all(normalizedPluginsArray.map(plugin => getPluginByName(Object.keys(plugin)[0], pluginLoader)));
+                                        const preset = hasPreset
+                                            ? typeof outputConfig.preset === 'string'
+                                                ? await getPresetByName(outputConfig.preset, makeDefaultLoader(context.cwd))
+                                                : outputConfig.preset
+                                            : null;
+                                        const pluginMap = Object.fromEntries(pluginPackages.map((pkg, i) => {
+                                            const plugin = normalizedPluginsArray[i];
+                                            const name = Object.keys(plugin)[0];
+                                            return [name, pkg];
+                                        }));
+                                        const mergedConfig = {
+                                            ...rootConfig,
+                                            ...(typeof outputFileTemplateConfig === 'string'
+                                                ? { value: outputFileTemplateConfig }
+                                                : outputFileTemplateConfig),
                                         };
-                                    });
-                                    outputDocuments = await result.documents;
-                                }, filename, `Load GraphQL documents: ${filename}`),
-                            },
-                            {
-                                title: 'Generate',
-                                task: wrapTask(async () => {
-                                    debugLog(`[CLI] Generating output`);
-                                    const normalizedPluginsArray = normalizeConfig(outputConfig.plugins);
-                                    const pluginLoader = config.pluginLoader || makeDefaultLoader(context.cwd);
-                                    const pluginPackages = await Promise.all(normalizedPluginsArray.map(plugin => getPluginByName(Object.keys(plugin)[0], pluginLoader)));
-                                    const pluginMap = {};
-                                    const preset = hasPreset
-                                        ? typeof outputConfig.preset === 'string'
-                                            ? await getPresetByName(outputConfig.preset, makeDefaultLoader(context.cwd))
-                                            : outputConfig.preset
-                                        : null;
-                                    pluginPackages.forEach((pluginPackage, i) => {
-                                        const plugin = normalizedPluginsArray[i];
-                                        const name = Object.keys(plugin)[0];
-                                        pluginMap[name] = pluginPackage;
-                                    });
-                                    const mergedConfig = {
-                                        ...rootConfig,
-                                        ...(typeof outputFileTemplateConfig === 'string'
-                                            ? { value: outputFileTemplateConfig }
-                                            : outputFileTemplateConfig),
-                                    };
-                                    let outputs = [];
-                                    if (hasPreset) {
-                                        outputs = await context.profiler.run(async () => preset.buildGeneratesSection({
-                                            baseOutputDir: filename,
-                                            presetConfig: outputConfig.presetConfig || {},
-                                            plugins: normalizedPluginsArray,
-                                            schema: outputSchema,
-                                            schemaAst: outputSchemaAst,
-                                            documents: outputDocuments,
-                                            config: mergedConfig,
-                                            pluginMap,
-                                            pluginContext,
-                                            profiler: context.profiler,
-                                        }), `Build Generates Section: ${filename}`);
-                                    }
-                                    else {
-                                        outputs = [
-                                            {
-                                                filename,
+                                        const outputs = hasPreset
+                                            ? await context.profiler.run(async () => preset.buildGeneratesSection({
+                                                baseOutputDir: filename,
+                                                presetConfig: outputConfig.presetConfig || {},
                                                 plugins: normalizedPluginsArray,
                                                 schema: outputSchema,
                                                 schemaAst: outputSchemaAst,
@@ -290,50 +248,67 @@ export async function executeCodegen(input) {
                                                 pluginMap,
                                                 pluginContext,
                                                 profiler: context.profiler,
-                                            },
-                                        ];
-                                    }
-                                    const process = async (outputArgs) => {
-                                        const output = await codegen({
-                                            ...outputArgs,
-                                            cache,
-                                        });
-                                        result.push({
-                                            filename: outputArgs.filename,
-                                            content: output,
-                                            hooks: outputConfig.hooks || {},
-                                        });
-                                    };
-                                    await context.profiler.run(() => Promise.all(outputs.map(process)), `Codegen: ${filename}`);
-                                }, filename, `Generate: ${filename}`),
-                            },
-                        ], {
-                            // it stops when one of tasks failed
-                            exitOnError: true,
-                        });
-                    },
-                };
-            }), {
-                // it doesn't stop when one of tasks failed, to finish at least some of outputs
-                exitOnError: false,
-                concurrent: cpus().length,
-            });
+                                            }), `Build Generates Section: ${filename}`)
+                                            : [
+                                                {
+                                                    filename,
+                                                    plugins: normalizedPluginsArray,
+                                                    schema: outputSchema,
+                                                    schemaAst: outputSchemaAst,
+                                                    documents: outputDocuments,
+                                                    config: mergedConfig,
+                                                    pluginMap,
+                                                    pluginContext,
+                                                    profiler: context.profiler,
+                                                },
+                                            ];
+                                        const process = async (outputArgs) => {
+                                            const output = await codegen({
+                                                ...outputArgs,
+                                                cache,
+                                            });
+                                            result.push({
+                                                filename: outputArgs.filename,
+                                                content: output,
+                                                hooks: outputConfig.hooks || {},
+                                            });
+                                        };
+                                        await context.profiler.run(() => Promise.all(outputs.map(process)), `Codegen: ${filename}`);
+                                    }, filename, `Generate: ${filename}`, ctx),
+                                },
+                            ], {
+                                // it stops when of the tasks failed
+                                exitOnError: true,
+                            });
+                        },
+                        // It doesn't stop when one of tasks failed, to finish at least some of outputs
+                        exitOnError: false,
+                        concurrent: cpus().length,
+                    };
+                });
+                return task.newListr(generateTasks);
+            },
         },
+    ], {
+        rendererOptions: {
+            clearOutput: false,
+            collapse: true,
+        },
+        ctx: { errors: [] },
+        rendererSilent: isTest || config.silent,
+        exitOnError: true,
     });
-    try {
-        await listr.run();
-    }
-    catch (err) {
-        if (isListrError(err)) {
-            const allErrs = err.errors.map(subErr => isDetailedError(subErr)
-                ? `${subErr.message} for "${subErr.source}"${subErr.details}`
-                : subErr.message || subErr.toString());
-            const newErr = new AggregateError(err.errors, `${err.message} ${allErrs.join('\n\n')}`);
-            // Best-effort to all stack traces for debugging
-            newErr.stack = `${newErr.stack}\n\n${err.errors.map(subErr => subErr.stack).join('\n\n')}`;
-            throw newErr;
-        }
-        throw err;
+    // All the errors throw in `listr2` are collected in context
+    // Running tasks doesn't throw anything
+    const executedContext = await tasks.run();
+    if (executedContext.errors.length > 0) {
+        const errors = executedContext.errors.map(subErr => isDetailedError(subErr)
+            ? `${subErr.message} for "${subErr.source}"${subErr.details}`
+            : subErr.message || subErr.toString());
+        const newErr = new AggregateError(executedContext.errors, `${errors.join('\n\n')}`);
+        // Best-effort to all stack traces for debugging
+        newErr.stack = `${newErr.stack}\n\n${executedContext.errors.map(subErr => subErr.stack).join('\n\n')}`;
+        throw newErr;
     }
     return result;
 }

package/esm/config.js

@@ -169,7 +169,7 @@ export function updateContextWithCliFlags(context, cliFlags) {
     const config = {
         configFilePath: context.filepath,
     };
-    if (cliFlags.watch) {
+    if (cliFlags.watch !== undefined) {
         config.watch = cliFlags.watch;
     }
     if (cliFlags.overwrite === true) {
@@ -181,6 +181,10 @@ export function updateContextWithCliFlags(context, cliFlags) {
     if (cliFlags.errorsOnly === true) {
         config.errorsOnly = cliFlags.errorsOnly;
     }
+    if (cliFlags['ignore-no-documents'] !== undefined) {
+        // for some reason parsed value is `'false'` string so this ensure it always is a boolean.
+        config.ignoreNoDocuments = cliFlags['ignore-no-documents'] === true;
+    }
     if (cliFlags.project) {
         context.useProject(cliFlags.project);
     }

package/esm/init/helpers.js

@@ -2,7 +2,7 @@ import chalk from 'chalk';
 import { resolve, relative } from 'path';
 import { writeFileSync, readFileSync } from 'fs';
 import detectIndent from 'detect-indent';
-import getLatestVersion from 'latest-version';
+import { getLatestVersion } from '../utils/get-latest-version.js';
 // Parses config and writes it to a file
 export async function writeConfig(answers, config) {
     const YAML = await import('json-to-pretty-yaml').then(m => ('default' in m ? m.default : m));

package/esm/load.js

@@ -45,16 +45,16 @@ export async function loadSchema(schemaPointers, config) {
 
         ${e.message || e}
         ${e.stack || ''}
-    
+
         GraphQL Code Generator supports:
           - ES Modules and CommonJS exports (export as default or named export "schema")
           - Introspection JSON File
           - URL of GraphQL endpoint
           - Multiple files with type definitions (glob expression)
           - String in config file
-    
+
         Try to use one of above options and run codegen again.
-    
+
       `);
     }
 }
@@ -77,12 +77,19 @@ export async function loadDocuments(documentPointers, config) {
         }
         ignore.push(join(process.cwd(), generatePath));
     }
-    const loadedFromToolkit = await loadDocumentsToolkit(documentPointers, {
-        ...defaultDocumentsLoadOptions,
-        ignore,
-        loaders,
-        ...config,
-        ...config.config,
-    });
-    return loadedFromToolkit;
+    try {
+        const loadedFromToolkit = await loadDocumentsToolkit(documentPointers, {
+            ...defaultDocumentsLoadOptions,
+            ignore,
+            loaders,
+            ...config,
+            ...config.config,
+        });
+        return loadedFromToolkit;
+    }
+    catch (error) {
+        if (config.ignoreNoDocuments)
+            return [];
+        throw error;
+    }
 }

package/esm/utils/get-latest-version.js

@@ -0,0 +1,11 @@
+import { fetch } from 'cross-undici-fetch';
+/**
+ * Fetches the version directly from the registry instead of depending on
+ * an ESM only module as latest-version does.
+ * @param packageName
+ */
+export async function getLatestVersion(packageName) {
+    return fetch(`https://unpkg.com/${packageName}/package.json`)
+        .then(res => res.json())
+        .then(pkg => pkg.version);
+}

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@graphql-codegen/cli",
-  "version": "2.8.0-alpha-bd464a586.0",
+  "version": "2.8.0",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
   },
   "dependencies": {
-    "@graphql-codegen/core": "2.6.0-alpha-bd464a586.0",
-    "@graphql-codegen/plugin-helpers": "^2.5.0-alpha-bd464a586.0",
+    "@graphql-codegen/core": "2.6.0",
+    "@graphql-codegen/plugin-helpers": "^2.5.0",
     "@graphql-tools/apollo-engine-loader": "^7.3.1",
     "@graphql-tools/code-file-loader": "^7.3.0",
     "@graphql-tools/git-loader": "^7.2.0",
@@ -19,24 +19,20 @@
     "@graphql-tools/utils": "^8.8.0",
     "ansi-escapes": "^4.3.1",
     "chalk": "^4.1.0",
-    "change-case-all": "1.0.14",
     "chokidar": "^3.5.2",
-    "common-tags": "^1.8.0",
     "cosmiconfig": "^7.0.0",
+    "cross-undici-fetch": "^0.4.11",
     "debounce": "^1.2.0",
     "detect-indent": "^6.0.0",
     "graphql-config": "^4.3.1",
     "inquirer": "^8.0.0",
     "is-glob": "^4.0.1",
     "json-to-pretty-yaml": "^1.2.2",
-    "latest-version": "5.1.0",
-    "listr": "^0.14.3",
-    "listr-update-renderer": "^0.5.0",
+    "listr2": "^4.0.5",
     "log-symbols": "^4.0.0",
     "mkdirp": "^1.0.4",
     "string-env-interpolation": "^1.0.1",
     "ts-log": "^2.2.3",
-    "wrap-ansi": "^7.0.0",
     "yaml": "^1.10.0",
     "yargs": "^17.0.0"
   },

package/typings/config.d.ts

@@ -10,6 +10,7 @@ export declare type YamlCliFlags = {
     silent: boolean;
     errorsOnly: boolean;
     profile: boolean;
+    ignoreNoDocuments?: boolean;
 };
 export declare function generateSearchPlaces(moduleName: string): string[];
 export interface LoadCodegenConfigOptions {

package/typings/utils/get-latest-version.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Fetches the version directly from the registry instead of depending on
+ * an ESM only module as latest-version does.
+ * @param packageName
+ */
+export declare function getLatestVersion(packageName: string): Promise<string>;

package/cjs/utils/indentString.js

@@ -1,37 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.indentString = void 0;
-/**
-Indent each line in a string.
-@param string - The string to indent.
-@param count - How many times you want `options.indent` repeated. Default: `1`.
-@example
-```
-import indentString from 'indent-string';
-indentString('Unicorns\nRainbows', 4);
-//=> '    Unicorns\n    Rainbows'
-indentString('Unicorns\nRainbows', 4, {indent: '♥'});
-//=> '♥♥♥♥Unicorns\n♥♥♥♥Rainbows'
-```
-*/
-function indentString(string, count = 1, options = {}) {
-    const { indent = ' ', includeEmptyLines = false } = options;
-    if (typeof string !== 'string') {
-        throw new TypeError(`Expected \`input\` to be a \`string\`, got \`${typeof string}\``);
-    }
-    if (typeof count !== 'number') {
-        throw new TypeError(`Expected \`count\` to be a \`number\`, got \`${typeof count}\``);
-    }
-    if (count < 0) {
-        throw new RangeError(`Expected \`count\` to be at least 0, got \`${count}\``);
-    }
-    if (typeof indent !== 'string') {
-        throw new TypeError(`Expected \`options.indent\` to be a \`string\`, got \`${typeof indent}\``);
-    }
-    if (count === 0) {
-        return string;
-    }
-    const regex = includeEmptyLines ? /^/gm : /^(?!\s*$)/gm;
-    return string.replace(regex, indent.repeat(count));
-}
-exports.indentString = indentString;