@graphql-codegen/cli 2.7.0-alpha-05066c85f.0 → 2.7.1-alpha-223b75f49.0

package/esm/config.js

@@ -0,0 +1,290 @@
+import { cosmiconfig, defaultLoaders } from 'cosmiconfig';
+import { resolve } from 'path';
+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';
+import { loadSchema, loadDocuments, defaultSchemaLoadOptions, defaultDocumentsLoadOptions } from './load.js';
+import { print } from 'graphql';
+import yaml from 'yaml';
+import { createRequire } from 'module';
+import { promises } from 'fs';
+import { createHash } from 'crypto';
+const { lstat } = promises;
+export function generateSearchPlaces(moduleName) {
+    const extensions = ['json', 'yaml', 'yml', 'js', 'config.js'];
+    // gives codegen.json...
+    const regular = extensions.map(ext => `${moduleName}.${ext}`);
+    // gives .codegenrc.json... but no .codegenrc.config.js
+    const dot = extensions.filter(ext => ext !== 'config.js').map(ext => `.${moduleName}rc.${ext}`);
+    return [...regular.concat(dot), 'package.json'];
+}
+function customLoader(ext) {
+    function loader(filepath, content) {
+        if (typeof process !== 'undefined' && 'env' in process) {
+            content = env(content);
+        }
+        if (ext === 'json') {
+            return defaultLoaders['.json'](filepath, content);
+        }
+        if (ext === 'yaml') {
+            try {
+                const result = yaml.parse(content, { prettyErrors: true, merge: true });
+                return result;
+            }
+            catch (error) {
+                error.message = `YAML Error in ${filepath}:\n${error.message}`;
+                throw error;
+            }
+        }
+        if (ext === 'js') {
+            return defaultLoaders['.js'](filepath, content);
+        }
+    }
+    return loader;
+}
+export async function loadCodegenConfig({ configFilePath, moduleName, searchPlaces: additionalSearchPlaces, packageProp, loaders: customLoaders, }) {
+    configFilePath = configFilePath || process.cwd();
+    moduleName = moduleName || 'codegen';
+    packageProp = packageProp || moduleName;
+    const cosmi = cosmiconfig(moduleName, {
+        searchPlaces: generateSearchPlaces(moduleName).concat(additionalSearchPlaces || []),
+        packageProp,
+        loaders: {
+            '.json': customLoader('json'),
+            '.yaml': customLoader('yaml'),
+            '.yml': customLoader('yaml'),
+            '.js': customLoader('js'),
+            noExt: customLoader('yaml'),
+            ...customLoaders,
+        },
+    });
+    const pathStats = await lstat(configFilePath);
+    return pathStats.isDirectory() ? cosmi.search(configFilePath) : cosmi.load(configFilePath);
+}
+export async function loadContext(configFilePath) {
+    const graphqlConfig = await findAndLoadGraphQLConfig(configFilePath);
+    if (graphqlConfig) {
+        return new CodegenContext({
+            graphqlConfig,
+        });
+    }
+    const result = await loadCodegenConfig({ configFilePath });
+    if (!result) {
+        if (configFilePath) {
+            throw new DetailedError(`Config ${configFilePath} does not exist`, `
+        Config ${configFilePath} does not exist.
+
+          $ graphql-codegen --config ${configFilePath}
+
+        Please make sure the --config points to a correct file.
+      `);
+        }
+        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 DetailedError(`Found Codegen config file but it was empty!`, `
+        Please make sure that you have a valid configuration file under the current directory!
+      `);
+    }
+    return new CodegenContext({
+        filepath: result.filepath,
+        config: result.config,
+    });
+}
+function getCustomConfigPath(cliFlags) {
+    const configFile = cliFlags.config;
+    return configFile ? resolve(process.cwd(), configFile) : null;
+}
+export function buildOptions() {
+    return {
+        c: {
+            alias: 'config',
+            type: 'string',
+            describe: 'Path to GraphQL codegen YAML config file, defaults to "codegen.yml" on the current directory',
+        },
+        w: {
+            alias: 'watch',
+            describe: 'Watch for changes and execute generation automatically. You can also specify a glob expreession for custom watch list.',
+            coerce: (watch) => {
+                if (watch === 'false') {
+                    return false;
+                }
+                if (typeof watch === 'string' || Array.isArray(watch)) {
+                    return watch;
+                }
+                return !!watch;
+            },
+        },
+        r: {
+            alias: 'require',
+            describe: 'Loads specific require.extensions before running the codegen and reading the configuration',
+            type: 'array',
+            default: [],
+        },
+        o: {
+            alias: 'overwrite',
+            describe: 'Overwrites existing files',
+            type: 'boolean',
+        },
+        s: {
+            alias: 'silent',
+            describe: 'Suppresses printing errors',
+            type: 'boolean',
+        },
+        e: {
+            alias: 'errors-only',
+            describe: 'Only print errors',
+            type: 'boolean',
+        },
+        profile: {
+            describe: 'Use profiler to measure performance',
+            type: 'boolean',
+        },
+        p: {
+            alias: 'project',
+            describe: 'Name of a project in GraphQL Config',
+            type: 'string',
+        },
+    };
+}
+export function parseArgv(argv = process.argv) {
+    return yargs(argv).options(buildOptions()).parse(argv);
+}
+export async function createContext(cliFlags = parseArgv(process.argv)) {
+    if (cliFlags.require && cliFlags.require.length > 0) {
+        const relativeRequire = createRequire(process.cwd());
+        await Promise.all(cliFlags.require.map(mod => import(relativeRequire.resolve(mod, {
+            paths: [process.cwd()],
+        }))));
+    }
+    const customConfigPath = getCustomConfigPath(cliFlags);
+    const context = await loadContext(customConfigPath);
+    updateContextWithCliFlags(context, cliFlags);
+    return context;
+}
+export function updateContextWithCliFlags(context, cliFlags) {
+    const config = {
+        configFilePath: context.filepath,
+    };
+    if (cliFlags.watch) {
+        config.watch = cliFlags.watch;
+    }
+    if (cliFlags.overwrite === true) {
+        config.overwrite = cliFlags.overwrite;
+    }
+    if (cliFlags.silent === true) {
+        config.silent = cliFlags.silent;
+    }
+    if (cliFlags.errorsOnly === true) {
+        config.errorsOnly = cliFlags.errorsOnly;
+    }
+    if (cliFlags.project) {
+        context.useProject(cliFlags.project);
+    }
+    if (cliFlags.profile === true) {
+        context.useProfiler();
+    }
+    context.updateConfig(config);
+}
+export class CodegenContext {
+    constructor({ config, graphqlConfig, filepath, }) {
+        this._pluginContext = {};
+        this._config = config;
+        this._graphqlConfig = graphqlConfig;
+        this.filepath = this._graphqlConfig ? this._graphqlConfig.filepath : filepath;
+        this.cwd = this._graphqlConfig ? this._graphqlConfig.dirpath : process.cwd();
+        this.profiler = createNoopProfiler();
+    }
+    useProject(name) {
+        this._project = name;
+    }
+    getConfig(extraConfig) {
+        if (!this.config) {
+            if (this._graphqlConfig) {
+                const project = this._graphqlConfig.getProject(this._project);
+                this.config = {
+                    ...project.extension('codegen'),
+                    schema: project.schema,
+                    documents: project.documents,
+                    pluginContext: this._pluginContext,
+                };
+            }
+            else {
+                this.config = { ...this._config, pluginContext: this._pluginContext };
+            }
+        }
+        return {
+            ...extraConfig,
+            ...this.config,
+        };
+    }
+    updateConfig(config) {
+        this.config = {
+            ...this.getConfig(),
+            ...config,
+        };
+    }
+    useProfiler() {
+        this.profiler = createProfiler();
+        const now = new Date(); // 2011-10-05T14:48:00.000Z
+        const datetime = now.toISOString().split('.')[0]; // 2011-10-05T14:48:00
+        const datetimeNormalized = datetime.replace(/-|:/g, ''); // 20111005T144800
+        this.profilerOutput = `codegen-${datetimeNormalized}.json`;
+    }
+    getPluginContext() {
+        return this._pluginContext;
+    }
+    async loadSchema(pointer) {
+        const config = this.getConfig(defaultSchemaLoadOptions);
+        if (this._graphqlConfig) {
+            // TODO: SchemaWithLoader won't work here
+            return addHashToSchema(this._graphqlConfig.getProject(this._project).loadSchema(pointer, 'GraphQLSchema', config));
+        }
+        return addHashToSchema(loadSchema(pointer, config));
+    }
+    async loadDocuments(pointer) {
+        const config = this.getConfig(defaultDocumentsLoadOptions);
+        if (this._graphqlConfig) {
+            // TODO: pointer won't work here
+            return addHashToDocumentFiles(this._graphqlConfig.getProject(this._project).loadDocuments(pointer, config));
+        }
+        return addHashToDocumentFiles(loadDocuments(pointer, config));
+    }
+}
+export function ensureContext(input) {
+    return input instanceof CodegenContext ? input : new CodegenContext({ config: input });
+}
+function hashContent(content) {
+    return createHash('sha256').update(content).digest('hex');
+}
+function hashSchema(schema) {
+    return hashContent(print(getCachedDocumentNodeFromSchema(schema)));
+}
+function addHashToSchema(schemaPromise) {
+    return schemaPromise.then(schema => {
+        // It's consumed later on. The general purpose is to use it for caching.
+        if (!schema.extensions) {
+            schema.extensions = {};
+        }
+        schema.extensions['hash'] = hashSchema(schema);
+        return schema;
+    });
+}
+function hashDocument(doc) {
+    if (doc.rawSDL) {
+        return hashContent(doc.rawSDL);
+    }
+    if (doc.document) {
+        return hashContent(print(doc.document));
+    }
+    return null;
+}
+function addHashToDocumentFiles(documentFilesPromise) {
+    return documentFilesPromise.then(documentFiles => documentFiles.map(doc => {
+        doc.hash = hashDocument(doc);
+        return doc;
+    }));
+}

package/esm/generate-and-save.js

@@ -0,0 +1,105 @@
+import { lifecycleHooks } from './hooks.js';
+import { executeCodegen } from './codegen.js';
+import { createWatcher } from './utils/watcher.js';
+import { fileExists, readFile, writeFile, unlinkFile } from './utils/file-system.js';
+import mkdirp from 'mkdirp';
+import { dirname, join, isAbsolute } from 'path';
+import { debugLog } from './utils/debugging.js';
+import { ensureContext } from './config.js';
+import { createHash } from 'crypto';
+const hash = (content) => createHash('sha1').update(content).digest('base64');
+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 = [];
+    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));
+        staleFilenames.forEach(filename => {
+            if (shouldOverwrite(config, filename)) {
+                return unlinkFile(filename, err => {
+                    const prettyFilename = filename.replace(`${input.cwd || process.cwd()}/`, '');
+                    if (err) {
+                        debugLog(`Cannot remove stale file: ${prettyFilename}\n${err}`);
+                    }
+                    else {
+                        debugLog(`Removed stale file: ${prettyFilename}`);
+                    }
+                });
+            }
+        });
+        previouslyGeneratedFilenames = filenames;
+    }
+    const recentOutputHash = new Map();
+    async function writeOutput(generationResult) {
+        if (!saveToFile) {
+            return generationResult;
+        }
+        if (config.watch) {
+            removeStaleFiles(config, generationResult);
+        }
+        await context.profiler.run(async () => {
+            await lifecycleHooks(config.hooks).beforeAllFileWrite(generationResult.map(r => r.filename));
+        }, 'Lifecycle: beforeAllFileWrite');
+        await context.profiler.run(() => Promise.all(generationResult.map(async (result) => {
+            const exists = await fileExists(result.filename);
+            if (!shouldOverwrite(config, result.filename) && exists) {
+                return;
+            }
+            const content = result.content || '';
+            const currentHash = hash(content);
+            let previousHash = recentOutputHash.get(result.filename);
+            if (!previousHash && exists) {
+                previousHash = hash(await readFile(result.filename));
+            }
+            if (previousHash && currentHash === previousHash) {
+                debugLog(`Skipping file (${result.filename}) writing due to indentical hash...`);
+                return;
+            }
+            if (content.length === 0) {
+                return;
+            }
+            recentOutputHash.set(result.filename, currentHash);
+            const basedir = dirname(result.filename);
+            await lifecycleHooks(result.hooks).beforeOneFileWrite(result.filename);
+            await lifecycleHooks(config.hooks).beforeOneFileWrite(result.filename);
+            await mkdirp(basedir);
+            const absolutePath = isAbsolute(result.filename)
+                ? result.filename
+                : join(input.cwd || process.cwd(), result.filename);
+            await writeFile(absolutePath, result.content);
+            await lifecycleHooks(result.hooks).afterOneFileWrite(result.filename);
+            await lifecycleHooks(config.hooks).afterOneFileWrite(result.filename);
+        })), 'Write files');
+        await context.profiler.run(() => lifecycleHooks(config.hooks).afterAllFileWrite(generationResult.map(r => r.filename)), 'Lifecycle: afterAllFileWrite');
+        return generationResult;
+    }
+    // watch mode
+    if (config.watch) {
+        return createWatcher(context, writeOutput);
+    }
+    const outputFiles = await context.profiler.run(() => executeCodegen(context), 'executeCodegen');
+    await context.profiler.run(() => writeOutput(outputFiles), 'writeOutput');
+    await context.profiler.run(() => lifecycleHooks(config.hooks).beforeDone(), 'Lifecycle: beforeDone');
+    if (context.profilerOutput) {
+        await writeFile(join(context.cwd, context.profilerOutput), JSON.stringify(context.profiler.collect()));
+    }
+    return outputFiles;
+}
+function shouldOverwrite(config, outputPath) {
+    const globalValue = config.overwrite === undefined ? true : !!config.overwrite;
+    const outputConfig = config.generates[outputPath];
+    if (!outputConfig) {
+        debugLog(`Couldn't find a config of ${outputPath}`);
+        return globalValue;
+    }
+    if (isConfiguredOutput(outputConfig) && typeof outputConfig.overwrite === 'boolean') {
+        return outputConfig.overwrite;
+    }
+    return globalValue;
+}
+function isConfiguredOutput(output) {
+    return typeof output.plugins !== 'undefined';
+}

package/esm/graphql-config.js

@@ -0,0 +1,64 @@
+import { loadConfig } from 'graphql-config';
+import { ApolloEngineLoader } from '@graphql-tools/apollo-engine-loader';
+import { CodeFileLoader } from '@graphql-tools/code-file-loader';
+import { GitLoader } from '@graphql-tools/git-loader';
+import { GithubLoader } from '@graphql-tools/github-loader';
+import { PrismaLoader } from '@graphql-tools/prisma-loader';
+export const CodegenExtension = (api) => {
+    // Schema
+    api.loaders.schema.register(new CodeFileLoader({
+        pluckConfig: {
+            skipIndent: true,
+        },
+    }));
+    api.loaders.schema.register(new GitLoader());
+    api.loaders.schema.register(new GithubLoader());
+    api.loaders.schema.register(new ApolloEngineLoader());
+    api.loaders.schema.register(new PrismaLoader());
+    // Documents
+    api.loaders.documents.register(new CodeFileLoader({
+        pluckConfig: {
+            skipIndent: true,
+        },
+    }));
+    api.loaders.documents.register(new GitLoader());
+    api.loaders.documents.register(new GithubLoader());
+    return {
+        name: 'codegen',
+    };
+};
+export async function findAndLoadGraphQLConfig(filepath) {
+    const config = await loadConfig({
+        filepath,
+        rootDir: process.cwd(),
+        extensions: [CodegenExtension],
+        throwOnEmpty: false,
+        throwOnMissing: false,
+    });
+    if (isGraphQLConfig(config)) {
+        return config;
+    }
+}
+// Kamil: user might load a config that is not GraphQL Config
+//        so we need to check if it's a regular config or not
+function isGraphQLConfig(config) {
+    if (!config) {
+        return false;
+    }
+    try {
+        return config.getDefault().hasExtension('codegen');
+    }
+    catch (e) { }
+    try {
+        for (const projectName in config.projects) {
+            if (config.projects.hasOwnProperty(projectName)) {
+                const project = config.projects[projectName];
+                if (project.hasExtension('codegen')) {
+                    return true;
+                }
+            }
+        }
+    }
+    catch (e) { }
+    return false;
+}

package/esm/hooks.js

@@ -0,0 +1,83 @@
+import { debugLog } from './utils/debugging.js';
+import { exec } from 'child_process';
+import { delimiter, sep } from 'path';
+const DEFAULT_HOOKS = {
+    afterStart: [],
+    beforeDone: [],
+    onWatchTriggered: [],
+    onError: [],
+    afterOneFileWrite: [],
+    afterAllFileWrite: [],
+    beforeOneFileWrite: [],
+    beforeAllFileWrite: [],
+};
+function normalizeHooks(_hooks) {
+    const keys = Object.keys({
+        ...DEFAULT_HOOKS,
+        ..._hooks,
+    });
+    return keys.reduce((prev, hookName) => {
+        if (typeof _hooks[hookName] === 'string') {
+            return {
+                ...prev,
+                [hookName]: [_hooks[hookName]],
+            };
+        }
+        if (typeof _hooks[hookName] === 'function') {
+            return {
+                ...prev,
+                [hookName]: [_hooks[hookName]],
+            };
+        }
+        if (Array.isArray(_hooks[hookName])) {
+            return {
+                ...prev,
+                [hookName]: _hooks[hookName],
+            };
+        }
+        return prev;
+    }, {});
+}
+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);
+            }
+            else {
+                resolve(stdout || stderr);
+            }
+        });
+    });
+}
+async function executeHooks(hookName, scripts = [], args = []) {
+    debugLog(`Running lifecycle hook "${hookName}" scripts...`);
+    for (const script of scripts) {
+        if (typeof script === 'string') {
+            debugLog(`Running lifecycle hook "${hookName}" script: ${script} with args: ${args.join(' ')}...`);
+            await execShellCommand(`${script} ${args.join(' ')}`);
+        }
+        else {
+            debugLog(`Running lifecycle hook "${hookName}" script: ${script.name} with args: ${args.join(' ')}...`);
+            await script(...args);
+        }
+    }
+}
+export const lifecycleHooks = (_hooks = {}) => {
+    const hooks = normalizeHooks(_hooks);
+    return {
+        afterStart: async () => executeHooks('afterStart', hooks.afterStart),
+        onWatchTriggered: async (event, path) => executeHooks('onWatchTriggered', hooks.onWatchTriggered, [event, path]),
+        onError: async (error) => executeHooks('onError', hooks.onError, [`"${error}"`]),
+        afterOneFileWrite: async (path) => executeHooks('afterOneFileWrite', hooks.afterOneFileWrite, [path]),
+        afterAllFileWrite: async (paths) => executeHooks('afterAllFileWrite', hooks.afterAllFileWrite, paths),
+        beforeOneFileWrite: async (path) => executeHooks('beforeOneFileWrite', hooks.beforeOneFileWrite, [path]),
+        beforeAllFileWrite: async (paths) => executeHooks('beforeAllFileWrite', hooks.beforeAllFileWrite, paths),
+        beforeDone: async () => executeHooks('beforeDone', hooks.beforeDone),
+    };
+};

package/esm/index.js

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

package/esm/init/helpers.js

@@ -0,0 +1,55 @@
+import chalk from 'chalk';
+import { resolve, relative } from 'path';
+import { writeFileSync, readFileSync } from 'fs';
+import detectIndent from 'detect-indent';
+import getLatestVersion from 'latest-version';
+// 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().endsWith('.json') ? 'json' : 'yml';
+    const content = ext === 'json' ? JSON.stringify(config) : YAML.stringify(config);
+    const fullPath = resolve(process.cwd(), answers.config);
+    const relativePath = relative(process.cwd(), answers.config);
+    writeFileSync(fullPath, content, {
+        encoding: 'utf-8',
+    });
+    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, {
+        encoding: 'utf-8',
+    });
+    const pkg = JSON.parse(pkgContent);
+    const { indent } = detectIndent(pkgContent);
+    if (!pkg.scripts) {
+        pkg.scripts = {};
+    }
+    pkg.scripts[answers.script] = `graphql-codegen --config ${configLocation}`;
+    // plugin
+    if (!pkg.devDependencies) {
+        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');
+    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,55 @@
+import inquirer from 'inquirer';
+import { getQuestions } from './questions.js';
+import { guessTargets } from './targets.js';
+import { Tags } from './types.js';
+import { writeConfig, writePackage, bold } from './helpers.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 inquirer.prompt(getQuestions(possibleTargets));
+    // define config
+    const config = {
+        overwrite: true,
+        schema: answers.schema,
+        documents: answers.targets.includes(Tags.browser) ? answers.documents : null,
+        generates: {
+            [answers.output]: {
+                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'],
+    };
+}