@depup/graphql-codegen__cli 6.2.1-depup.0

package/esm/hooks.js

@@ -0,0 +1,89 @@
+import { exec } from 'child_process';
+import { delimiter, sep } from 'path';
+import { quote } from 'shell-quote';
+import { debugLog } from './utils/debugging.js';
+const DEFAULT_HOOKS = {
+    afterStart: [],
+    beforeDone: [],
+    onWatchTriggered: [],
+    onError: [],
+    afterOneFileWrite: [],
+    afterAllFileWrite: [],
+    beforeOneFileWrite: [],
+    beforeAllFileWrite: [],
+};
+function execShellCommand(cmd) {
+    return new Promise((resolve, reject) => {
+        exec(cmd, {
+            env: {
+                ...process.env,
+                PATH: `${process.env.PATH}${delimiter}${process.cwd()}${sep}node_modules${sep}.bin`,
+            },
+        }, (error, stdout, stderr) => {
+            if (error) {
+                reject(error);
+                // eslint-disable-next-line no-console
+                console.error(error);
+            }
+            else {
+                debugLog(stdout || stderr);
+                resolve(stdout || stderr);
+            }
+        });
+    });
+}
+async function executeHooks(hookName, _scripts = [], args = [], initialState) {
+    debugLog(`Running lifecycle hook "${hookName}" scripts...`);
+    let state = initialState;
+    const scripts = Array.isArray(_scripts) ? _scripts : [_scripts];
+    const quotedArgs = quote(args);
+    for (const script of scripts) {
+        if (typeof script === 'string') {
+            debugLog(`Running lifecycle hook "${hookName}" script: ${script} with args: ${quotedArgs}...`);
+            await execShellCommand(`${script} ${quotedArgs}`);
+        }
+        else {
+            debugLog(`Running lifecycle hook "${hookName}" script: ${script.name} with args: ${args.join(' ')}...`);
+            const hookArgs = state === undefined ? args : [...args, state];
+            const hookResult = await script(...hookArgs);
+            if (typeof hookResult === 'string' && typeof state === 'string') {
+                debugLog(`Received new content from lifecycle hook "${hookName}" script: ${script.name}`);
+                state = hookResult;
+            }
+        }
+    }
+    return state;
+}
+export const lifecycleHooks = (_hooks = {}) => {
+    const hooks = {
+        ...DEFAULT_HOOKS,
+        ..._hooks,
+    };
+    return {
+        afterStart: async () => {
+            await executeHooks('afterStart', hooks.afterStart);
+        },
+        onWatchTriggered: async (event, path) => {
+            await executeHooks('onWatchTriggered', hooks.onWatchTriggered, [event, path]);
+        },
+        onError: async (error) => {
+            await executeHooks('onError', hooks.onError, [error]);
+        },
+        afterOneFileWrite: async (path) => {
+            await executeHooks('afterOneFileWrite', hooks.afterOneFileWrite, [path]);
+        },
+        afterAllFileWrite: async (paths) => {
+            await executeHooks('afterAllFileWrite', hooks.afterAllFileWrite, paths);
+        },
+        beforeOneFileWrite: async (path, content) => {
+            const result = await executeHooks('beforeOneFileWrite', hooks.beforeOneFileWrite, [path], content);
+            return typeof result === 'string' ? result : content;
+        },
+        beforeAllFileWrite: async (paths) => {
+            await executeHooks('beforeAllFileWrite', hooks.beforeAllFileWrite, paths);
+        },
+        beforeDone: async () => {
+            await executeHooks('beforeDone', hooks.beforeDone);
+        },
+    };
+};

package/esm/index.js

@@ -0,0 +1,7 @@
+export * from './cli.js';
+export { executeCodegen } from './codegen.js';
+export * from './config.js';
+export { generate } from './generate-and-save.js';
+export * from './graphql-config.js';
+export * from './init/index.js';
+export * from './utils/cli-error.js';

package/esm/init/helpers.js

@@ -0,0 +1,82 @@
+import { readFileSync, writeFileSync } from 'fs';
+import { relative, resolve } from 'path';
+import generate from '@babel/generator';
+import template from '@babel/template';
+import * as t from '@babel/types';
+import chalk from 'chalk';
+import detectIndent from 'detect-indent';
+import { getLatestVersion } from '../utils/get-latest-version.js';
+import { Tags } from './types.js';
+function jsObjectToBabelObjectExpression(obj) {
+    const objExp = t.objectExpression([]);
+    for (const [key, val] of Object.entries(obj)) {
+        if (Array.isArray(val)) {
+            objExp.properties.push(t.objectProperty(/^[a-zA-Z0-9]+$/.test(key) ? t.identifier(key) : t.stringLiteral(key), t.arrayExpression(val.map(v => (typeof v === 'object' ? jsObjectToBabelObjectExpression(v) : t.valueToNode(v))))));
+        }
+        else {
+            objExp.properties.push(t.objectProperty(/^[a-zA-Z0-9]+$/.test(key) ? t.identifier(key) : t.stringLiteral(key), typeof val === 'object' ? jsObjectToBabelObjectExpression(val) : t.valueToNode(val)));
+        }
+    }
+    return objExp;
+}
+// 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));
+    const ext = answers.config.toLocaleLowerCase().split('.')[1];
+    const fullPath = resolve(process.cwd(), answers.config);
+    const relativePath = relative(process.cwd(), answers.config);
+    let content;
+    if (ext === 'ts') {
+        const buildRequire = template.statement(`%%config%%`);
+        const ast = buildRequire({
+            config: jsObjectToBabelObjectExpression(config),
+        });
+        content = `
+import type { CodegenConfig } from '@graphql-codegen/cli';
+
+const config: CodegenConfig = ${generate(ast).code.replace(/\(|\)/g, '')}
+
+export default config;
+`;
+    }
+    else {
+        content = ext === 'json' ? JSON.stringify(config) : YAML.stringify(config);
+    }
+    writeFileSync(fullPath, content, 'utf8');
+    return {
+        relativePath,
+        fullPath,
+    };
+}
+// Updates package.json (script and plugins as dependencies)
+export async function writePackage(answers, configLocation) {
+    // script
+    const pkgPath = resolve(process.cwd(), 'package.json');
+    const pkgContent = readFileSync(pkgPath, 'utf8');
+    const pkg = JSON.parse(pkgContent);
+    const { indent } = detectIndent(pkgContent);
+    pkg.scripts ||= {};
+    pkg.scripts[answers.script] = `graphql-codegen --config ${configLocation}`;
+    // plugin
+    pkg.devDependencies ||= {};
+    await Promise.all((answers.plugins || []).map(async (plugin) => {
+        pkg.devDependencies[plugin.package] = await getLatestVersion(plugin.package);
+    }));
+    if (answers.introspection) {
+        pkg.devDependencies['@graphql-codegen/introspection'] = await getLatestVersion('@graphql-codegen/introspection');
+    }
+    pkg.devDependencies['@graphql-codegen/cli'] = await getLatestVersion('@graphql-codegen/cli');
+    if (answers.targets.includes(Tags.client)) {
+        pkg.devDependencies['@graphql-codegen/client-preset'] = await getLatestVersion('@graphql-codegen/client-preset');
+    }
+    writeFileSync(pkgPath, JSON.stringify(pkg, null, indent));
+}
+export function bold(str) {
+    return chalk.bold(str);
+}
+export function grey(str) {
+    return chalk.grey(str);
+}
+export function italic(str) {
+    return chalk.italic(str);
+}

package/esm/init/index.js

@@ -0,0 +1,59 @@
+import { bold, writeConfig, writePackage } from './helpers.js';
+import { getAnswers } from './questions.js';
+import { guessTargets } from './targets.js';
+import { Tags } from './types.js';
+function log(...msgs) {
+    // eslint-disable-next-line no-console
+    console.log(...msgs);
+}
+export async function init() {
+    log(`
+    Welcome to ${bold('GraphQL Code Generator')}!
+    Answer few questions and we will setup everything for you.
+  `);
+    const possibleTargets = await guessTargets();
+    const answers = await getAnswers(possibleTargets);
+    // define config
+    const config = {
+        overwrite: true,
+        schema: answers.schema,
+        ...(answers.targets.includes(Tags.client) ||
+            answers.targets.includes(Tags.angular) ||
+            answers.targets.includes(Tags.stencil)
+            ? { documents: answers.documents }
+            : {}),
+        generates: {
+            [answers.output]: {
+                ...(answers.targets.includes(Tags.client) ? { preset: 'client' } : {}),
+                plugins: answers.plugins ? answers.plugins.map(p => p.value) : [],
+            },
+        },
+    };
+    // introspection
+    if (answers.introspection) {
+        addIntrospection(config);
+    }
+    // config file
+    const { relativePath } = await writeConfig(answers, config);
+    log(`Fetching latest versions of selected plugins...`);
+    // write package.json
+    await writePackage(answers, relativePath);
+    // Emit status to the terminal
+    log(`
+    Config file generated at ${bold(relativePath)}
+
+      ${bold('$ npm install')}
+
+    To install the plugins.
+
+      ${bold(`$ npm run ${answers.script}`)}
+
+    To run GraphQL Code Generator.
+  `);
+}
+// adds an introspection to `generates`
+function addIntrospection(config) {
+    config.generates['./graphql.schema.json'] = {
+        plugins: ['introspection'],
+    };
+}

package/esm/init/plugins.js

@@ -0,0 +1,133 @@
+import { italic } from './helpers.js';
+import { Tags } from './types.js';
+export const plugins = [
+    {
+        name: `TypeScript ${italic('(required by other typescript plugins)')}`,
+        package: '@graphql-codegen/typescript',
+        value: 'typescript',
+        pathInRepo: 'typescript/typescript',
+        available: hasTag(Tags.typescript),
+        shouldBeSelected: tags => oneOf(tags, Tags.angular, Tags.stencil) || allOf(tags, Tags.typescript, Tags.react) || noneOf(tags, Tags.flow),
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript Operations ${italic('(operations and fragments)')}`,
+        package: '@graphql-codegen/typescript-operations',
+        value: 'typescript-operations',
+        pathInRepo: 'typescript/operations',
+        available: tags => allOf(tags, Tags.client, Tags.typescript) || hasTag(Tags.stencil)(tags),
+        shouldBeSelected: tags => oneOf(tags, Tags.angular, Tags.stencil) || allOf(tags, Tags.typescript, Tags.react),
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript Resolvers ${italic('(strongly typed resolve functions)')}`,
+        package: '@graphql-codegen/typescript-resolvers',
+        value: 'typescript-resolvers',
+        pathInRepo: 'typescript/resolvers',
+        available: tags => allOf(tags, Tags.node, Tags.typescript),
+        shouldBeSelected: tags => noneOf(tags, Tags.flow),
+        defaultExtension: '.ts',
+    },
+    {
+        name: `Flow ${italic('(required by other flow plugins)')}`,
+        package: '@graphql-codegen/flow',
+        value: 'flow',
+        pathInRepo: 'flow/flow',
+        available: hasTag(Tags.flow),
+        shouldBeSelected: tags => noneOf(tags, Tags.typescript),
+        defaultExtension: '.js',
+    },
+    {
+        name: `Flow Operations ${italic('(operations and fragments)')}`,
+        package: '@graphql-codegen/flow-operations',
+        value: 'flow-operations',
+        pathInRepo: 'flow/operations',
+        available: tags => allOf(tags, Tags.client, Tags.flow),
+        shouldBeSelected: tags => noneOf(tags, Tags.typescript),
+        defaultExtension: '.js',
+    },
+    {
+        name: `Flow Resolvers ${italic('(strongly typed resolve functions)')}`,
+        package: '@graphql-codegen/flow-resolvers',
+        value: 'flow-resolvers',
+        pathInRepo: 'flow/resolvers',
+        available: tags => allOf(tags, Tags.node, Tags.flow),
+        shouldBeSelected: tags => noneOf(tags, Tags.typescript),
+        defaultExtension: '.js',
+    },
+    {
+        name: `TypeScript Stencil Apollo ${italic('(typed components)')}`,
+        package: '@graphql-codegen/typescript-stencil-apollo',
+        value: 'typescript-stencil-apollo',
+        pathInRepo: 'typescript/stencil-apollo',
+        available: hasTag(Tags.stencil),
+        shouldBeSelected: () => true,
+        defaultExtension: '.tsx',
+    },
+    {
+        name: `TypeScript MongoDB ${italic('(typed MongoDB objects)')}`,
+        package: '@graphql-codegen/typescript-mongodb',
+        value: 'typescript-mongodb',
+        pathInRepo: 'typescript/mongodb',
+        available: tags => allOf(tags, Tags.node, Tags.typescript),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript GraphQL files modules ${italic('(declarations for .graphql files)')}`,
+        package: '@graphql-codegen/typescript-graphql-files-modules',
+        value: 'typescript-graphql-files-modules',
+        pathInRepo: 'typescript/graphql-files-modules',
+        available: tags => allOf(tags, Tags.client, Tags.typescript) || hasTag(Tags.stencil)(tags),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript GraphQL document nodes ${italic('(embedded GraphQL document)')}`,
+        package: '@graphql-codegen/typescript-document-nodes',
+        value: 'typescript-document-nodes',
+        pathInRepo: 'typescript/document-nodes',
+        available: tags => allOf(tags, Tags.typescript) || hasTag(Tags.stencil)(tags),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `Introspection Fragment Matcher ${italic('(for Apollo Client)')}`,
+        package: '@graphql-codegen/fragment-matcher',
+        value: 'fragment-matcher',
+        pathInRepo: 'other/fragment-matcher',
+        available: tags => hasTag(Tags.client)(tags) || hasTag(Tags.angular)(tags) || hasTag(Tags.stencil)(tags),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `Urql Introspection ${italic('(for Urql Client)')}`,
+        package: '@graphql-codegen/urql-introspection',
+        value: 'urql-introspection',
+        pathInRepo: 'other/urql-introspection',
+        available: tags => hasTag(Tags.client)(tags) || hasTag(Tags.stencil)(tags),
+        shouldBeSelected: () => false,
+        defaultExtension: '.ts',
+    },
+    {
+        name: `TypeScript Apollo Angular ${italic('(typed GQL services)')}`,
+        package: '@graphql-codegen/typescript-apollo-angular',
+        value: 'typescript-apollo-angular',
+        pathInRepo: 'typescript/apollo-angular',
+        available: hasTag(Tags.angular),
+        shouldBeSelected: () => true,
+        defaultExtension: '.ts',
+    },
+];
+function hasTag(tag) {
+    return (tags) => tags.includes(tag);
+}
+function oneOf(list, ...items) {
+    return list.some(i => items.includes(i));
+}
+function noneOf(list, ...items) {
+    return !list.some(i => items.includes(i));
+}
+function allOf(list, ...items) {
+    return items.every(i => list.includes(i));
+}

package/esm/init/questions.js

@@ -0,0 +1,172 @@
+import { checkbox, input, select, confirm } from '@inquirer/prompts';
+import { grey } from './helpers.js';
+import { plugins } from './plugins.js';
+import { Tags } from './types.js';
+export async function getAnswers(possibleTargets) {
+    try {
+        const targetChoices = getApplicationTypeChoices(possibleTargets);
+        const targets = await select({
+            message: `What type of application are you building?`,
+            choices: targetChoices,
+            default: targetChoices.find(c => c.checked)?.value,
+        });
+        const schema = await input({
+            message: `Where is your schema?: ${grey('(path or url)')}`,
+            default: 'http://localhost:4000', // matches Apollo Server's default
+            validate: str => str.length > 0,
+        });
+        let documents;
+        if (targets.includes(Tags.client) || targets.includes(Tags.angular) || targets.includes(Tags.stencil))
+            documents = await input({
+                message: 'Where are your operations and fragments?:',
+                default: getDocumentsDefaultValue(targets),
+                validate: str => str.length > 0,
+            });
+        let plugins;
+        if (!targets.includes(Tags.client)) {
+            plugins = await checkbox({
+                message: 'Pick plugins:',
+                choices: getPluginChoices(targets),
+                validate: plugins => plugins.length > 0,
+            });
+        }
+        const output = await input({
+            message: 'Where to write the output:',
+            default: getOutputDefaultValue({ targets, plugins }),
+            validate: str => str.length > 0,
+        });
+        const introspection = await confirm({
+            message: 'Do you want to generate an introspection file?',
+            default: false,
+        });
+        const config = await input({
+            message: 'How to name the config file?',
+            default: (() => targets.includes(Tags.client) || targets.includes(Tags.typescript) || targets.includes(Tags.angular)
+                ? 'codegen.ts'
+                : 'codegen.yml')(),
+            validate: str => {
+                const isNotEmpty = str.length > 0;
+                const hasCorrectExtension = ['json', 'yml', 'yaml', 'js', 'ts'].some(ext => str.toLocaleLowerCase().endsWith(`.${ext}`));
+                return isNotEmpty && hasCorrectExtension;
+            },
+        });
+        const script = await input({
+            default: 'codegen',
+            message: 'What script in package.json should run the codegen?',
+            validate: (str) => str.length > 0,
+        });
+        return {
+            targets,
+            schema,
+            documents,
+            plugins,
+            output,
+            introspection,
+            config,
+            script,
+        };
+    }
+    catch (error) {
+        if (error instanceof Error && error.name === 'ExitPromptError') {
+            // This error because user exited using CMD+C, just exit gracefully or else user would see an ugly error message
+            // https://github.com/SBoudrias/Inquirer.js/blob/ee16061a1e3f99a6cc714a3d473f7cd12b06a3f1/packages/prompts/README.md#handling-ctrlc-gracefully
+            process.exit();
+        }
+        else {
+            throw error;
+        }
+    }
+}
+export function getApplicationTypeChoices(possibleTargets) {
+    function withFlowOrTypescript(tags) {
+        if (possibleTargets.TypeScript) {
+            tags.push(Tags.typescript);
+        }
+        else if (possibleTargets.Flow) {
+            tags.push(Tags.flow);
+        }
+        else if (possibleTargets.Node) {
+            tags.push(Tags.typescript, Tags.flow);
+        }
+        return tags;
+    }
+    return [
+        {
+            name: 'Backend - API or server',
+            key: 'backend',
+            value: withFlowOrTypescript([Tags.node]),
+            checked: possibleTargets.Node,
+        },
+        {
+            name: 'Application built with Angular',
+            key: 'angular',
+            value: [Tags.angular],
+            checked: possibleTargets.Angular,
+        },
+        {
+            name: 'Application built with React',
+            key: 'react',
+            value: withFlowOrTypescript([Tags.react, Tags.client]),
+            checked: possibleTargets.React,
+        },
+        {
+            name: 'Application built with Stencil',
+            key: 'stencil',
+            value: [Tags.stencil, Tags.typescript],
+            checked: possibleTargets.Stencil,
+        },
+        {
+            name: 'Application built with Vue',
+            key: 'vue',
+            value: [Tags.vue, Tags.client],
+            checked: possibleTargets.Vue,
+        },
+        {
+            name: 'Application using graphql-request',
+            key: 'graphqlRequest',
+            value: [Tags.graphqlRequest, Tags.client],
+            checked: possibleTargets.graphqlRequest,
+        },
+        {
+            name: 'Application built with other framework or vanilla JS',
+            key: 'client',
+            value: [Tags.typescript, Tags.flow],
+            checked: possibleTargets.Browser && !possibleTargets.Angular && !possibleTargets.React && !possibleTargets.Stencil,
+        },
+    ];
+}
+export function getPluginChoices(targets) {
+    return plugins
+        .filter(p => p.available(targets))
+        .map(p => {
+        return {
+            name: p.name,
+            value: p,
+            checked: p.shouldBeSelected(targets),
+        };
+    });
+}
+function getOutputDefaultValue({ targets, plugins }) {
+    if (targets.includes(Tags.client)) {
+        return 'src/gql/';
+    }
+    if (plugins.some(plugin => plugin.defaultExtension === '.tsx')) {
+        return 'src/generated/graphql.tsx';
+    }
+    if (plugins.some(plugin => plugin.defaultExtension === '.ts')) {
+        return 'src/generated/graphql.ts';
+    }
+    return 'src/generated/graphql.js';
+}
+function getDocumentsDefaultValue(targets) {
+    if (targets.includes(Tags.vue)) {
+        return 'src/**/*.vue';
+    }
+    if (targets.includes(Tags.angular)) {
+        return 'src/**/*.ts';
+    }
+    if (targets.includes(Tags.client)) {
+        return 'src/**/*.tsx';
+    }
+    return 'src/**/*.graphql';
+}

package/esm/init/targets.js

@@ -0,0 +1,42 @@
+import { readFileSync } from 'fs';
+import { resolve } from 'path';
+import { Tags } from './types.js';
+export async function guessTargets() {
+    const pkg = JSON.parse(readFileSync(resolve(process.cwd(), 'package.json'), 'utf8'));
+    const dependencies = Object.keys({
+        ...pkg.dependencies,
+        ...pkg.devDependencies,
+    });
+    return {
+        [Tags.angular]: isAngular(dependencies),
+        [Tags.react]: isReact(dependencies),
+        [Tags.stencil]: isStencil(dependencies),
+        [Tags.vue]: isVue(dependencies),
+        [Tags.client]: false,
+        [Tags.node]: false,
+        [Tags.typescript]: isTypescript(dependencies),
+        [Tags.flow]: isFlow(dependencies),
+        [Tags.graphqlRequest]: isGraphqlRequest(dependencies),
+    };
+}
+function isAngular(dependencies) {
+    return dependencies.includes('@angular/core');
+}
+function isReact(dependencies) {
+    return dependencies.includes('react');
+}
+function isStencil(dependencies) {
+    return dependencies.includes('@stencil/core');
+}
+function isVue(dependencies) {
+    return dependencies.includes('vue') || dependencies.includes('nuxt');
+}
+function isTypescript(dependencies) {
+    return dependencies.includes('typescript');
+}
+function isFlow(dependencies) {
+    return dependencies.includes('flow');
+}
+function isGraphqlRequest(dependencies) {
+    return dependencies.includes('graphql-request');
+}

package/esm/init/types.js

@@ -0,0 +1,12 @@
+export var Tags;
+(function (Tags) {
+    Tags["client"] = "Browser";
+    Tags["node"] = "Node";
+    Tags["typescript"] = "TypeScript";
+    Tags["flow"] = "Flow";
+    Tags["angular"] = "Angular";
+    Tags["stencil"] = "Stencil";
+    Tags["react"] = "React";
+    Tags["vue"] = "Vue";
+    Tags["graphqlRequest"] = "graphqlRequest";
+})(Tags || (Tags = {}));