@graphql-codegen/cli 2.13.8-alpha-20221025134913-ec8a36be2 → 2.13.8-alpha-20221027114749-e39e1c05f

package/cjs/cli.js

@@ -28,6 +28,7 @@ const generate_and_save_js_1 = require("./generate-and-save.js");
 const index_js_1 = require("./init/index.js");
 const config_js_1 = require("./config.js");
 const hooks_js_1 = require("./hooks.js");
+const plugin_helpers_1 = require("@graphql-codegen/plugin-helpers");
 async function runCli(cmd) {
     await ensureGraphQlPackage();
     if (cmd === 'init') {
@@ -55,11 +56,12 @@ async function ensureGraphQlPackage() {
         await Promise.resolve().then(() => __importStar(require('graphql')));
     }
     catch (e) {
-        throw new Error(`Unable to load "graphql" package. Please make sure to install "graphql" as a dependency! \n
-       To install "graphql", run:
-         yarn add graphql
-       Or, with NPM:
-         npm install --save graphql`);
+        throw new plugin_helpers_1.DetailedError(`Unable to load "graphql" package. Please make sure to install "graphql" as a dependency!`, `
+  To install "graphql", run:
+    yarn add graphql
+  Or, with NPM:
+    npm install --save graphql
+`);
     }
 }
 exports.ensureGraphQlPackage = ensureGraphQlPackage;

package/cjs/codegen.js

@@ -92,7 +92,7 @@ async function executeCodegen(input) {
         /* Normalize "generators" field */
         const generateKeys = Object.keys(config.generates || {});
         if (generateKeys.length === 0) {
-            throw new Error(`Invalid Codegen Configuration! \n
+            throw new plugin_helpers_1.DetailedError('Invalid Codegen Configuration!', `
         Please make sure that your codegen config file contains the "generates" field, with a specification for the plugins you need.
 
         It should looks like that:
@@ -103,12 +103,13 @@ async function executeCodegen(input) {
           my-file.ts:
             - plugin1
             - plugin2
-            - plugin3`);
+            - plugin3
+        `);
         }
         for (const filename of generateKeys) {
             const output = (generates[filename] = (0, plugin_helpers_1.normalizeOutputParam)(config.generates[filename]));
             if (!output.preset && (!output.plugins || output.plugins.length === 0)) {
-                throw new Error(`Invalid Codegen Configuration! \n
+                throw new plugin_helpers_1.DetailedError('Invalid Codegen Configuration!', `
           Please make sure that your codegen config file has defined plugins list for output "${filename}".
 
           It should looks like that:
@@ -127,7 +128,7 @@ async function executeCodegen(input) {
             Object.keys(generates).some(filename => !generates[filename].schema ||
                 (Array.isArray(generates[filename].schema === 'object') &&
                     generates[filename].schema.length === 0))) {
-            throw new Error(`Invalid Codegen Configuration! \n
+            throw new plugin_helpers_1.DetailedError('Invalid Codegen Configuration!', `
         Please make sure that your codegen config file contains either the "schema" field
         or every generated file has its own "schema" field.
 
@@ -319,7 +320,9 @@ async function executeCodegen(input) {
         (0, debugging_js_1.printLogs)();
     }
     if (executedContext.errors.length > 0) {
-        const errors = executedContext.errors.map(subErr => subErr.message || subErr.toString());
+        const errors = executedContext.errors.map(subErr => (0, plugin_helpers_1.isDetailedError)(subErr)
+            ? `${subErr.message} for "${subErr.source}"${subErr.details}`
+            : subErr.message || subErr.toString());
         const newErr = new utils_1.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')}`;

package/cjs/config.js

@@ -85,7 +85,7 @@ async function loadContext(configFilePath) {
     const result = await loadCodegenConfig({ configFilePath });
     if (!result) {
         if (configFilePath) {
-            throw new Error(`
+            throw new plugin_helpers_1.DetailedError(`Config ${configFilePath} does not exist`, `
         Config ${configFilePath} does not exist.
 
           $ graphql-codegen --config ${configFilePath}
@@ -93,12 +93,12 @@ async function loadContext(configFilePath) {
         Please make sure the --config points to a correct file.
       `);
         }
-        throw new Error(`Unable to find Codegen config file! \n
+        throw new plugin_helpers_1.DetailedError(`Unable to find Codegen config file!`, `
         Please make sure that you have a configuration file under the current directory!
       `);
     }
     if (result.isEmpty) {
-        throw new Error(`Found Codegen config file but it was empty! \n
+        throw new plugin_helpers_1.DetailedError(`Found Codegen config file but it was empty!`, `
         Please make sure that you have a valid configuration file under the current directory!
       `);
     }

package/cjs/plugins.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPluginByName = void 0;
+const plugin_helpers_1 = require("@graphql-codegen/plugin-helpers");
 const path_1 = require("path");
 async function getPluginByName(name, pluginLoader) {
     const possibleNames = [
@@ -21,7 +22,7 @@ async function getPluginByName(name, pluginLoader) {
         }
         catch (err) {
             if (err.code !== 'MODULE_NOT_FOUND' && err.code !== 'ERR_MODULE_NOT_FOUND') {
-                throw new Error(`
+                throw new plugin_helpers_1.DetailedError(`Unable to load template plugin matching ${name}`, `
               Unable to load template plugin matching '${name}'.
               Reason:
                 ${err.message}
@@ -34,7 +35,7 @@ async function getPluginByName(name, pluginLoader) {
         - ${name}
     `.trimRight())
         .join('');
-    throw new Error(`
+    throw new plugin_helpers_1.DetailedError(`Unable to find template plugin matching ${name}`, `
         Unable to find template plugin matching '${name}'
         Install one of the following packages:
 

package/esm/cli.js

@@ -2,6 +2,7 @@ import { generate } from './generate-and-save.js';
 import { init } from './init/index.js';
 import { createContext } from './config.js';
 import { lifecycleHooks } from './hooks.js';
+import { DetailedError } from '@graphql-codegen/plugin-helpers';
 export async function runCli(cmd) {
     await ensureGraphQlPackage();
     if (cmd === 'init') {
@@ -28,10 +29,11 @@ export async function ensureGraphQlPackage() {
         await import('graphql');
     }
     catch (e) {
-        throw new Error(`Unable to load "graphql" package. Please make sure to install "graphql" as a dependency! \n
-       To install "graphql", run:
-         yarn add graphql
-       Or, with NPM:
-         npm install --save graphql`);
+        throw new DetailedError(`Unable to load "graphql" package. Please make sure to install "graphql" as a dependency!`, `
+  To install "graphql", run:
+    yarn add graphql
+  Or, with NPM:
+    npm install --save graphql
+`);
     }
 }

package/esm/codegen.js

@@ -1,4 +1,4 @@
-import { normalizeOutputParam, normalizeInstanceOrArray, normalizeConfig, getCachedDocumentNodeFromSchema, } from '@graphql-codegen/plugin-helpers';
+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 { GraphQLError } from 'graphql';
@@ -88,7 +88,7 @@ export async function executeCodegen(input) {
         /* Normalize "generators" field */
         const generateKeys = Object.keys(config.generates || {});
         if (generateKeys.length === 0) {
-            throw new Error(`Invalid Codegen Configuration! \n
+            throw new DetailedError('Invalid Codegen Configuration!', `
         Please make sure that your codegen config file contains the "generates" field, with a specification for the plugins you need.
 
         It should looks like that:
@@ -99,12 +99,13 @@ export async function executeCodegen(input) {
           my-file.ts:
             - plugin1
             - plugin2
-            - plugin3`);
+            - plugin3
+        `);
         }
         for (const filename of generateKeys) {
             const output = (generates[filename] = normalizeOutputParam(config.generates[filename]));
             if (!output.preset && (!output.plugins || output.plugins.length === 0)) {
-                throw new Error(`Invalid Codegen Configuration! \n
+                throw new DetailedError('Invalid Codegen Configuration!', `
           Please make sure that your codegen config file has defined plugins list for output "${filename}".
 
           It should looks like that:
@@ -123,7 +124,7 @@ export async function executeCodegen(input) {
             Object.keys(generates).some(filename => !generates[filename].schema ||
                 (Array.isArray(generates[filename].schema === 'object') &&
                     generates[filename].schema.length === 0))) {
-            throw new Error(`Invalid Codegen Configuration! \n
+            throw new DetailedError('Invalid Codegen Configuration!', `
         Please make sure that your codegen config file contains either the "schema" field
         or every generated file has its own "schema" field.
 
@@ -315,7 +316,9 @@ export async function executeCodegen(input) {
         printLogs();
     }
     if (executedContext.errors.length > 0) {
-        const errors = executedContext.errors.map(subErr => subErr.message || subErr.toString());
+        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')}`;

package/esm/config.js

@@ -1,7 +1,7 @@
 import { cosmiconfig, defaultLoaders } from 'cosmiconfig';
 import { TypeScriptLoader } from 'cosmiconfig-typescript-loader';
 import { resolve } from 'path';
-import { createProfiler, createNoopProfiler, getCachedDocumentNodeFromSchema, } from '@graphql-codegen/plugin-helpers';
+import { DetailedError, createProfiler, createNoopProfiler, getCachedDocumentNodeFromSchema, } from '@graphql-codegen/plugin-helpers';
 import { env } from 'string-env-interpolation';
 import yargs from 'yargs';
 import { findAndLoadGraphQLConfig } from './graphql-config.js';
@@ -79,7 +79,7 @@ export async function loadContext(configFilePath) {
     const result = await loadCodegenConfig({ configFilePath });
     if (!result) {
         if (configFilePath) {
-            throw new Error(`
+            throw new DetailedError(`Config ${configFilePath} does not exist`, `
         Config ${configFilePath} does not exist.
 
           $ graphql-codegen --config ${configFilePath}
@@ -87,12 +87,12 @@ export async function loadContext(configFilePath) {
         Please make sure the --config points to a correct file.
       `);
         }
-        throw new Error(`Unable to find Codegen config file! \n
+        throw new DetailedError(`Unable to find Codegen config file!`, `
         Please make sure that you have a configuration file under the current directory!
       `);
     }
     if (result.isEmpty) {
-        throw new Error(`Found Codegen config file but it was empty! \n
+        throw new DetailedError(`Found Codegen config file but it was empty!`, `
         Please make sure that you have a valid configuration file under the current directory!
       `);
     }

package/esm/plugins.js

@@ -1,3 +1,4 @@
+import { DetailedError } from '@graphql-codegen/plugin-helpers';
 import { resolve } from 'path';
 export async function getPluginByName(name, pluginLoader) {
     const possibleNames = [
@@ -18,7 +19,7 @@ export async function getPluginByName(name, pluginLoader) {
         }
         catch (err) {
             if (err.code !== 'MODULE_NOT_FOUND' && err.code !== 'ERR_MODULE_NOT_FOUND') {
-                throw new Error(`
+                throw new DetailedError(`Unable to load template plugin matching ${name}`, `
               Unable to load template plugin matching '${name}'.
               Reason:
                 ${err.message}
@@ -31,7 +32,7 @@ export async function getPluginByName(name, pluginLoader) {
         - ${name}
     `.trimRight())
         .join('');
-    throw new Error(`
+    throw new DetailedError(`Unable to find template plugin matching ${name}`, `
         Unable to find template plugin matching '${name}'
         Install one of the following packages:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphql-codegen/cli",
-  "version": "2.13.8-alpha-20221025134913-ec8a36be2",
+  "version": "2.13.8-alpha-20221027114749-e39e1c05f",
   "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"
   },
@@ -8,15 +8,15 @@
     "@babel/generator": "^7.18.13",
     "@babel/template": "^7.18.10",
     "@babel/types": "^7.18.13",
-    "@graphql-codegen/core": "2.6.3-alpha-20221025134913-ec8a36be2",
-    "@graphql-codegen/plugin-helpers": "2.7.2-alpha-20221025134913-ec8a36be2",
+    "@graphql-codegen/core": "2.6.2",
+    "@graphql-codegen/plugin-helpers": "^2.6.2",
     "@graphql-tools/apollo-engine-loader": "^7.3.6",
     "@graphql-tools/code-file-loader": "^7.3.1",
     "@graphql-tools/git-loader": "^7.2.1",
     "@graphql-tools/github-loader": "^7.3.6",
     "@graphql-tools/graphql-file-loader": "^7.5.0",
     "@graphql-tools/json-file-loader": "^7.4.1",
-    "@graphql-tools/load": "^7.7.1",
+    "@graphql-tools/load": "7.8.0",
     "@graphql-tools/prisma-loader": "^7.2.7",
     "@graphql-tools/url-loader": "^7.13.2",
     "@graphql-tools/utils": "^8.9.0",

package/typings/utils/cli-error.d.cts

@@ -1,4 +1,5 @@
-declare type CompositeError = Error;
+import { DetailedError } from '@graphql-codegen/plugin-helpers';
+declare type CompositeError = Error | DetailedError;
 declare type ListrError = Error & {
     errors: CompositeError[];
 };

package/typings/utils/cli-error.d.ts

@@ -1,4 +1,5 @@
-declare type CompositeError = Error;
+import { DetailedError } from '@graphql-codegen/plugin-helpers';
+declare type CompositeError = Error | DetailedError;
 declare type ListrError = Error & {
     errors: CompositeError[];
 };