create-ima-app/scripts/create.js

Create a IMA.js App easily.

/* eslint-disable import/no-named-as-default-member */

import { spawnSync } from 'child_process';
import fs from 'fs';
import path from 'path';
import { fileURLToPath } from 'url';

import chalk from 'chalk';
import fsExtra from 'fs-extra/esm';

import { info, error, mergePkgJson } from './utils.js';

export async function create(projDir, useTS) {
  const __dirname = path.dirname(fileURLToPath(import.meta.url));

  info(
    `Creating new IMA.js application inside the ${chalk.magenta(
      projDir
    )} directory...`,
    true
  );

  const projName = projDir.split(path.sep).pop();
  const appRoot = path.resolve(projDir.toString());
  const tplRoot = path.join(__dirname, '../template/common');
  const tplTypeRoot = path.join(
    __dirname,
    `../template/${useTS ? 'ts' : 'js'}`
  );

  if (!fs.existsSync(projDir)) {
    try {
      info(
        `Creating basic directory structure${
          useTS ? chalk.blue(' for TypeScript template') : ''
        }...`
      );

      // Copy base "common" template
      await fsExtra.copy(tplRoot, appRoot);

      // Copy JS/TS specific files
      await fsExtra.copy(tplTypeRoot, appRoot, {
        overwrite: false,
        filter: filePath =>
          !filePath.includes('package.json') && !filePath.includes('.eslintrc'),
      });

      // Merge pkgJson files
      await mergePkgJson(tplRoot, tplTypeRoot, appRoot);

      // Copy eslintrc.js file
      await fsExtra.copy(
        path.join(tplTypeRoot, '.eslintrc.template.js'),
        path.join(appRoot, '.eslintrc.js')
      );
    } catch (err) {
      error(err.message);
      process.exit(1);
    }
  } else {
    error(
      `Aborting... the directory ${projDir} ${chalk.bold.red(
        'already exists'
      )}.\n`
    );
    process.exit(0);
  }

  // Overwrite package.json with new name
  const pkgJsonPath = path.join(appRoot, 'package.json');
  const pkgJson = JSON.parse(await fs.promises.readFile(pkgJsonPath, 'utf8'));

  pkgJson.name = projName;
  await fs.promises.writeFile(pkgJsonPath, JSON.stringify(pkgJson, null, 2));

  // Run npm install
  info(
    `Running ${chalk.magenta(
      'npm install'
    )} inside app directory, this might take a while...`
  );

  console.log(chalk.dim('      Press CTRL+C to cancel.\n'));

  const npm = process.platform === 'win32' ? 'npm.cmd' : 'npm';
  spawnSync(npm, ['install'], {
    stdio: 'inherit',
    cwd: appRoot,
  });

  // Show final info
  console.log('');
  info(`${chalk.bold.green('Success!')} Created ${chalk.magenta(
    projName
  )} inside the ${chalk.magenta(appRoot)} directory.

From there you can run several commands:

  ${chalk.blue('npm run test')}
    To run test runners.

  ${chalk.blue('npm run lint')}
    To run eslint on your application source files.

  ${chalk.blue('npm run dev')}
    To start development server.

  ${chalk.blue('npm run build')}
    To build the application.

  ${chalk.blue('npm run start')}
    To start IMA.js application server.

We suggest that you start with:

  ${chalk.blue('cd')} ${projDir}
  ${chalk.blue('npm run dev')}
`);
}