vendure/packages/create/src/create-vendure-app.ts

/* eslint-disable no-console */
import chalk from 'chalk';
import program from 'commander';
import detectPort from 'detect-port';
import fs from 'fs-extra';
import Listr from 'listr';
import os from 'os';
import path from 'path';
import { Observable } from 'rxjs';

import { REQUIRED_NODE_VERSION, SERVER_PORT } from './constants';
import { gatherCiUserResponses, gatherUserResponses } from './gather-user-responses';
import {
    checkDbConnection,
    checkNodeVersion,
    checkThatNpmCanReadCwd,
    getDependencies,
    installPackages,
    isSafeToCreateProjectIn,
    isServerPortInUse,
    scaffoldAlreadyExists,
    shouldUseYarn,
} from './helpers';
import { CliLogLevel } from './types';

// eslint-disable-next-line @typescript-eslint/no-var-requires
const packageJson = require('../package.json');
checkNodeVersion(REQUIRED_NODE_VERSION);

let projectName: string | undefined;

// Set the environment variable which can then be used to
// conditionally modify behaviour of core or plugins.
const createEnvVar: import('@vendure/common/lib/shared-constants').CREATING_VENDURE_APP =
    'CREATING_VENDURE_APP';
process.env[createEnvVar] = 'true';

program
    .version(packageJson.version)
    .arguments('<project-directory>')
    .usage(`${chalk.green('<project-directory>')} [options]`)
    .action(name => {
        projectName = name;
    })
    .option(
        '--log-level <logLevel>',
        'Log level, either \'silent\', \'info\', or \'verbose\'',
        /^(silent|info|verbose)$/i,
        'silent',
    )
    .option('--use-npm', 'Uses npm rather than Yarn as the default package manager')
    .option('--ci', 'Runs without prompts for use in CI scenarios')
    .parse(process.argv);

const options = program.opts();
void createApp(projectName, options.useNpm, options.logLevel || 'silent', options.ci);

async function createApp(
    name: string | undefined,
    useNpm: boolean,
    logLevel: CliLogLevel,
    isCi: boolean = false,
) {
    if (!runPreChecks(name, useNpm)) {
        return;
    }
    if (await isServerPortInUse()) {
        console.log(chalk.red(`Port ${SERVER_PORT} is in use. Please make it available and then re-try.`));
        process.exit(1);
    }

    console.log(chalk.cyan(`Welcome to @vendure/create v${packageJson.version as string}!`));
    console.log();
    console.log('Let\'s configure a new Vendure project. First a few questions:');
    console.log();

    const root = path.resolve(name);
    const appName = path.basename(root);
    const scaffoldExists = scaffoldAlreadyExists(root, name);
    const useYarn = useNpm ? false : shouldUseYarn();
    if (scaffoldExists) {
        console.log(
            chalk.green(
                'It appears that a new Vendure project scaffold already exists. Re-using the existing files...',
            ),
        );
        console.log();
    }
    const {
        dbType,
        configSource,
        envSource,
        envDtsSource,
        indexSource,
        indexWorkerSource,
        migrationSource,
        readmeSource,
        dockerfileSource,
        dockerComposeSource,
        populateProducts,
    } = isCi
        ? await gatherCiUserResponses(root, useYarn)
        : await gatherUserResponses(root, scaffoldExists, useYarn);
    const originalDirectory = process.cwd();
    process.chdir(root);
    if (!useYarn && !checkThatNpmCanReadCwd()) {
        process.exit(1);
    }

    const packageJsonContents = {
        name: appName,
        version: '0.1.0',
        private: true,
        scripts: {
            'dev:server': 'ts-node ./src/index.ts',
            'dev:worker': 'ts-node ./src/index-worker.ts',
            dev: useYarn ? 'concurrently yarn:dev:*' : 'concurrently npm:dev:*',
            build: 'tsc',
            'start:server': 'node ./dist/index.js',
            'start:worker': 'node ./dist/index-worker.js',
            start: useYarn ? 'concurrently yarn:start:*' : 'concurrently npm:start:*',
            'migration:generate': 'ts-node migration generate',
            'migration:run': 'ts-node migration run',
            'migration:revert': 'ts-node migration revert',
        },
    };

    console.log();
    console.log(`Setting up your new Vendure project in ${chalk.green(root)}`);
    console.log('This may take a few minutes...');
    console.log();

    const rootPathScript = (fileName: string): string => path.join(root, `${fileName}.ts`);
    const srcPathScript = (fileName: string): string => path.join(root, 'src', `${fileName}.ts`);

    const listrTasks: Listr.ListrTask[] = [];
    if (scaffoldExists) {
        // ...
    } else {
        listrTasks.push(
            {
                title: 'Installing dependencies',
                task: (() => {
                    return new Observable(subscriber => {
                        subscriber.next('Creating package.json');
                        fs.writeFileSync(
                            path.join(root, 'package.json'),
                            JSON.stringify(packageJsonContents, null, 2) + os.EOL,
                        );
                        const { dependencies, devDependencies } = getDependencies(
                            dbType,
                            isCi ? `@${packageJson.version as string}` : '',
                        );

                        subscriber.next(`Installing ${dependencies.join(', ')}`);
                        installPackages(root, useYarn, dependencies, false, logLevel, isCi)
                            .then(() => {
                                if (devDependencies.length) {
                                    subscriber.next(`Installing ${devDependencies.join(', ')}`);
                                    return installPackages(
                                        root,
                                        useYarn,
                                        devDependencies,
                                        true,
                                        logLevel,
                                        isCi,
                                    );
                                }
                            })
                            .then(() => subscriber.complete())
                            .catch(err => subscriber.error(err));
                    });
                }) as any,
            },
            {
                title: 'Generating app scaffold',
                task: ctx => {
                    return new Observable(subscriber => {
                        fs.ensureDirSync(path.join(root, 'src'));
                        const assetPath = (fileName: string) => path.join(__dirname, '../assets', fileName);
                        ctx.configFile = srcPathScript('vendure-config');

                        fs.writeFile(ctx.configFile, configSource)
                            .then(() => fs.writeFile(path.join(root, '.env'), envSource))
                            .then(() => fs.writeFile(srcPathScript('environment.d'), envDtsSource))
                            .then(() => fs.writeFile(srcPathScript('index'), indexSource))
                            .then(() => fs.writeFile(srcPathScript('index-worker'), indexWorkerSource))
                            .then(() => fs.writeFile(rootPathScript('migration'), migrationSource))
                            .then(() => fs.writeFile(path.join(root, 'README.md'), readmeSource))
                            .then(() => fs.writeFile(path.join(root, 'Dockerfile'), dockerfileSource))
                            .then(() =>
                                fs.writeFile(path.join(root, 'docker-compose.yml'), dockerComposeSource),
                            )
                            .then(() => fs.mkdir(path.join(root, 'src/plugins')))
                            .then(() =>
                                fs.copyFile(assetPath('gitignore.template'), path.join(root, '.gitignore')),
                            )
                            .then(() => {
                                subscriber.next('Created files');
                                return fs.copyFile(
                                    assetPath('tsconfig.template.json'),
                                    path.join(root, 'tsconfig.json'),
                                );
                            })
                            .then(() => createDirectoryStructure(root))
                            .then(() => {
                                subscriber.next('Created directory structure');
                                return copyEmailTemplates(root);
                            })
                            .then(() => {
                                subscriber.next('Copied email templates');
                                subscriber.complete();
                            })
                            .catch(err => subscriber.error(err));
                    }) as any;
                },
            },
        );
    }
    listrTasks.push({
        title: 'Initializing server',
        task: async ctx => {
            try {
                // register ts-node so that the config file can be loaded
                // eslint-disable-next-line @typescript-eslint/no-var-requires
                require(path.join(root, 'node_modules/ts-node')).register();
                const { populate } = await import(path.join(root, 'node_modules/@vendure/core/cli/populate'));
                const { bootstrap, DefaultLogger, LogLevel, JobQueueService } = await import(
                    path.join(root, 'node_modules/@vendure/core/dist/index')
                );
                const configFile = srcPathScript('vendure-config');
                const { config } = await import(configFile);
                const assetsDir = path.join(__dirname, '../assets');

                const initialDataPath = path.join(assetsDir, 'initial-data.json');
                const port = await detectPort(3000);
                const vendureLogLevel =
                    logLevel === 'silent'
                        ? LogLevel.Error
                        : logLevel === 'verbose'
                        ? LogLevel.Verbose
                        : LogLevel.Info;

                const bootstrapFn = async () => {
                    await checkDbConnection(config.dbConnectionOptions, root);
                    const _app = await bootstrap({
                        ...config,
                        apiOptions: {
                            ...(config.apiOptions ?? {}),
                            port,
                        },
                        silent: logLevel === 'silent',
                        dbConnectionOptions: {
                            ...config.dbConnectionOptions,
                            synchronize: true,
                        },
                        logger: new DefaultLogger({ level: vendureLogLevel }),
                        importExportOptions: {
                            importAssetsDir: path.join(assetsDir, 'images'),
                        },
                    });
                    await _app.get(JobQueueService).start();
                    return _app;
                };

                const app = await populate(
                    bootstrapFn,
                    initialDataPath,
                    populateProducts ? path.join(assetsDir, 'products.csv') : undefined,
                );

                // Pause to ensure the worker jobs have time to complete.
                if (isCi) {
                    console.log('[CI] Pausing before close...');
                }
                await new Promise(resolve => setTimeout(resolve, isCi ? 30000 : 2000));
                await app.close();
                if (isCi) {
                    console.log('[CI] Pausing after close...');
                    await new Promise(resolve => setTimeout(resolve, 10000));
                }
            } catch (e: any) {
                console.log();
                console.error(chalk.red(e.message));
                console.log();
                console.log(e);
                throw e;
            }
        },
    });

    const tasks = new Listr(listrTasks);

    try {
        await tasks.run();
    } catch (e: any) {
        process.exit(1);
    }
    const startCommand = useYarn ? 'yarn dev' : 'npm run dev';
    console.log();
    console.log(chalk.green(`Success! Created a new Vendure server at ${root}`));
    console.log();
    console.log('We suggest that you start by typing:');
    console.log();
    console.log(chalk.green(`    cd ${name}`));
    console.log(chalk.green(`    ${startCommand}`));
    console.log();
    console.log('Happy hacking!');
    process.exit(0);
}

/**
 * Run some initial checks to ensure that it is okay to proceed with creating
 * a new Vendure project in the given location.
 */
function runPreChecks(name: string | undefined, useNpm: boolean): name is string {
    if (typeof name === 'undefined') {
        console.error('Please specify the project directory:');
        console.log(`  ${chalk.cyan(program.name())} ${chalk.green('<project-directory>')}`);
        console.log();
        console.log('For example:');
        console.log(`  ${chalk.cyan(program.name())} ${chalk.green('my-vendure-app')}`);
        process.exit(1);
        return false;
    }

    const root = path.resolve(name);
    fs.ensureDirSync(name);
    if (!isSafeToCreateProjectIn(root, name)) {
        process.exit(1);
    }
    return true;
}

/**
 * Generate the default directory structure for a new Vendure project
 */
async function createDirectoryStructure(root: string) {
    await fs.ensureDir(path.join(root, 'static', 'email', 'test-emails'));
    await fs.ensureDir(path.join(root, 'static', 'assets'));
}

/**
 * Copy the email templates into the app
 */
async function copyEmailTemplates(root: string) {
    const templateDir = path.join(root, 'node_modules/@vendure/email-plugin/templates');
    try {
        await fs.copy(templateDir, path.join(root, 'static', 'email', 'templates'));
    } catch (err: any) {
        console.error(chalk.red('Failed to copy email templates.'));
    }
}