create-plasttic-boilerplate/lib/starter-cli.js

Quick start for Plasttic Boilerplate

/** Imports */

import chalk from 'chalk';
import fs from 'fs-extra';
import elapsed from 'elapsed-time-logger';
import glob from 'fast-glob';
import inquirer from 'inquirer';
import inquirerAutocomplete from 'inquirer-autocomplete-prompt';
import ora from 'ora';
import os from 'os';
import path from 'path';
import pacote from 'pacote';

/** Variables */

const PROJECT = 'plasttic-boilerplate';
const TEMPDIR = `${os.tmpdir()}/${PROJECT}-staging`;

/** Question for project name (folder) */

const QUESTIONS = [
  {
    name: 'folder',
    type: 'input',
    message: 'Project name:',
    validate(input) {
      if (/^([A-Za-z\-_\d])+$/.test(input)) {
        return true;
      }
      return 'Project name may only include letters, numbers, underscores and dashes.';
    },
  },
];

/** Start CLI app */

inquirer.registerPrompt('autocomplete', inquirerAutocomplete);

/** Check if folder exists and ask if to override, or create new */

const checkFolder = async (targetDir, arg) => {
  if (targetDir && arg) {
    const folderExists = await fs.pathExists(targetDir);
    // folder doesn't exist, create new folder
    if (!folderExists) {
      await fs.ensureDir(targetDir);
      return true;
    }
    // folder exists, ask if to override
    if (folderExists) {
      const { override } = await inquirer.prompt({
        type: 'confirm',
        name: 'override',
        message: `The ${arg} folder already exists, proceed?`,
        default: true,
      });
      if (!override) {
        return override;
      }

      // folder exists and has files, ask if to override
      const folderFiles = await fs.readdir(targetDir);
      if (folderFiles.length !== 0) {
        // eslint-disable-next-line no-shadow
        const { override } = await inquirer.prompt({
          type: 'confirm',
          name: 'override',
          message: `The ${arg} folder is not an empty, proceed?`,
          default: true,
        });
        return override;
      }
    }
  }
  return true;
};

/** Rename .##gitignore## to .gitignore */

async function renameGitignore(targetDir) {
  const npmIgnoreFile = await glob(`${targetDir}/**/.##gitignore##`);

  npmIgnoreFile.map((fileName) =>
    fs.rename(fileName, fileName.replace(/\.##gitignore##$/, '.gitignore')),
  );
}

/** Export the CLI app */

export default async function starterCli() {
  // Ask for the project name
  const ANSWERS = await inquirer.prompt(QUESTIONS);
  if (!ANSWERS) {
    console.log(chalk.red('Error!'));
    process.exit(0);
  }

  // Start timer
  const timer = elapsed.start();

  // Define Target Directory and check if it's nor the root folder
  const targetDir = path.resolve(process.cwd(), ANSWERS.folder || './');
  if (targetDir === './') {
    console.log(chalk.red('Error!'));
    process.exit(0);
  }

  // Check if the folder already exists
  const override = await checkFolder(targetDir, ANSWERS.folder);
  if (!override) {
    console.log(chalk.red('Cancelled!'));
    return;
  }

  // Start spinner
  const spinner = ora(
    `Downloading ${PROJECT} to the ${ANSWERS.folder} folder`,
  ).start();

  // Create temp folder
  await fs.ensureDir(TEMPDIR);

  // Download the boilerplate and copy it to the target directory
  try {
    // Download to temp folder
    const { from: nameWithVersion } = await pacote.extract(
      `${PROJECT}@latest`,
      TEMPDIR,
      {},
    );
    // Copy to target directory
    await fs.copy(`${TEMPDIR}/public`, targetDir);
    await renameGitignore(targetDir);
    // Success message
    const timerDownloaded = timer.get();
    spinner.succeed(
      `${nameWithVersion} copied to ${ANSWERS.folder} in ${timerDownloaded}!`,
    );
  } catch (err) {
    // Error: Target folder not found
    if (err.code === 'ETARGET') {
      const msg404 = chalk.red(`${err.wanted} not found in npm registry!\n`);
      spinner.fail(msg404);
      throw err.code;
    }
    // Error: Unknown error
    const msgFail = chalk.red(`Unexpected error!\n`);
    spinner.fail(msgFail);
    throw new Error(err);
  } finally {
    // Remove temp folder after success or error
    await fs.remove(TEMPDIR);
  }
}