generator-jhipster-gql/generators/client/files.js

GraphQL integration for JHipster

const constants = require('../../utils/constants');
const { isAngular, isReact, isVue, getClientBaseDir, getDependabotPackageJSON } = require('../../utils/commons');
const { adjustAngularFiles, angularFiles } = require('./files-angular');
const { adjustReactFiles, reactFiles } = require('./files-react');
const { vueFiles, adjustVueFiles } = require('./files-vue');

const clientFiles = {
    common: [
        {
            templates: [
                {
                    file: 'common/codegen.yml',
                    renameTo: () => 'codegen.yml'
                }
            ]
        },
        {
            condition: generator => generator.typeDefinition === constants.TYPE_DEFINITION_TYPESCRIPT,
            templates: [
                {
                    file: 'common/graphql/graphql.common-types.ts',
                    renameTo: generator => `${getClientBaseDir(generator)}/graphql/graphql.common-types.ts`
                },
                {
                    file: 'common/entities/user/user.gql.ts',
                    renameTo: generator => `${getClientBaseDir(generator)}/entities/user/user.gql.ts`
                }
            ]
        },
        {
            condition: generator => generator.typeDefinition === constants.TYPE_DEFINITION_GRAPHQL,
            templates: [
                {
                    file: 'common/entities/user/user.graphql',
                    renameTo: generator => `${getClientBaseDir(generator)}/entities/user/user.graphql`
                }
            ]
        }
    ]
};

/**
 * Adjust package JSON: Install libraries and adjust build / dev scripts
 *
 * @param generator The Yeoman generators
 */
function adjustPackageJSON(generator) {
    const packageJsonStorage = generator.createStorage('package.json');
    const dependenciesStorage = packageJsonStorage.createStorage('dependencies');
    const devDependenciesStorage = packageJsonStorage.createStorage('devDependencies');
    const scriptsStorage = packageJsonStorage.createStorage('scripts');

    const dependabotPackageJSON = getDependabotPackageJSON(generator);

    dependenciesStorage.set('graphql', dependabotPackageJSON.dependencies.graphql);
    dependenciesStorage.set('@apollo/client', dependabotPackageJSON.dependencies['@apollo/client']);
    dependenciesStorage.set('pluralize', dependabotPackageJSON.dependencies.pluralize);
    devDependenciesStorage.set('@graphql-codegen/cli', dependabotPackageJSON.devDependencies['@graphql-codegen/cli']);
    devDependenciesStorage.set('@graphql-codegen/typescript', dependabotPackageJSON.devDependencies['@graphql-codegen/typescript']);
    devDependenciesStorage.set('@types/pluralize', dependabotPackageJSON.devDependencies['@types/pluralize']);

    if (generator.typeDefinition === constants.TYPE_DEFINITION_TYPESCRIPT) {
        dependenciesStorage.set('graphql-typeop', dependabotPackageJSON.dependencies['graphql-typeop']);
    } else {
        devDependenciesStorage.set(
            '@graphql-codegen/typescript-operations',
            dependabotPackageJSON.devDependencies['@graphql-codegen/typescript-operations']
        );
    }

    if (isAngular(generator)) {
        dependenciesStorage.set('apollo-angular', dependabotPackageJSON.dependencies['apollo-angular']);
        if (generator.typeDefinition === constants.TYPE_DEFINITION_GRAPHQL) {
            devDependenciesStorage.set(
                '@graphql-codegen/typescript-apollo-angular',
                dependabotPackageJSON.devDependencies['@graphql-codegen/typescript-apollo-angular']
            );
        }
        scriptsStorage.set('webapp:dev', 'concurrently "npm run codegen:watch" "ng serve"');
    }
    if (isReact(generator) || isVue(generator)) {
        if (generator.typeDefinition === constants.TYPE_DEFINITION_GRAPHQL) {
            devDependenciesStorage.set(
                '@graphql-codegen/typescript-react-apollo',
                dependabotPackageJSON.devDependencies['@graphql-codegen/typescript-react-apollo']
            );
        }
        scriptsStorage.set(
            'webapp:dev',
            'concurrently "npm run codegen:watch" "npm run webpack-dev-server -- --config webpack/webpack.dev.js --inline --port=9060 --env stats=minimal"'
        );
        scriptsStorage.set('webapp:build:dev', 'npm run codegen && npm run webpack -- --config webpack/webpack.dev.js --env stats=minimal');
        scriptsStorage.set(
            'webapp:build:prod',
            'npm run codegen && npm run webpack -- --config webpack/webpack.prod.js --progress=profile'
        );
    }
    scriptsStorage.set('codegen', 'graphql-codegen --config codegen.yml');
    scriptsStorage.set('codegen:watch', 'graphql-codegen --config codegen.yml --watch');
    packageJsonStorage.save();
}

/**
 * Writes the client files
 */
function writeFiles() {
    return {
        writeGraphQLFiles() {
            const files = { ...clientFiles };
            if (isAngular(this)) {
                files.angular = angularFiles;
            }
            if (isReact(this)) {
                files.react = reactFiles;
            }
            if (isVue(this)) {
                files.vue = vueFiles;
            }
            this.writeFilesToDisk(files, this, false);
        },
        adjustFiles() {
            if (isAngular(this)) {
                adjustAngularFiles(this);
            }
            if (isReact(this)) {
                adjustReactFiles(this);
            }
            if (isVue(this)) {
                adjustVueFiles(this);
            }
            adjustPackageJSON(this);
        }
    };
}

module.exports = {
    writeFiles
};