chrome-ext-react/bin/install.mjs

Chrome Extension Boilerplate with React and TypeScript

#!/usr/bin/env node
import { promisify } from "util";
import cp from "child_process";
import path from "path";
import fs from "fs";

// cli spinners
import ora from "ora";

// convert libs to promises
const exec = promisify(cp.exec);
const rm = promisify(fs.rm);

if (process.argv.length < 3) {
  console.log("You have to provide a name to your extension.");
  console.log("For example :");
  console.log("    npx chrome-ext-react my-app");
  process.exit(1);
}

const projectName = process.argv[2];
const currentPath = process.cwd();
const projectPath = path.join(currentPath, projectName);

const projectNameHasSpace = projectName.indexOf(" ") > -1;

const git_repo =
  "https://github.com/ZaifSenpai/react-chrome-extension-boilerplate.git";

// create project directory
if (fs.existsSync(projectPath)) {
  console.log(
    `"${projectName}" already exist in the current directory, please give it another name.`
  );
  process.exit(1);
} else {
  fs.mkdirSync(projectPath);
}

try {
  const gitSpinner = ora("Downloading files...").start();
  // clone the repo into the project folder -> creates the new boilerplate
  await exec(`git clone --depth 1 ${git_repo} "${projectPath}" --quiet`);
  gitSpinner.succeed();

  const cleanSpinner = ora("Removing useless files").start();
  // remove my git history
  const rmGit = rm(path.join(projectPath, ".git"), {
    recursive: true,
    force: true,
  });
  // remove the installation file
  const rmBin = rm(path.join(projectPath, "bin"), {
    recursive: true,
    force: true,
  });
  await Promise.all([rmGit, rmBin]);

  // Remove useless keys from package.json
  const packageJsonPath = path.join(projectPath, "package.json");
  const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf8"));
  delete packageJson.bin;
  delete packageJson.keywords;
  delete packageJson.repository;
  delete packageJson.bugs;
  delete packageJson.homepage;
  delete packageJson.scripts.deploy;
  packageJson.author = "";
  packageJson.name = projectName.toLowerCase().replace(/ /g, "-");
  packageJson.version = "1.0.0";

  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2));

  process.chdir(projectPath);
  // remove the packages needed for cli
  await exec("npm uninstall ora cli-spinners");
  cleanSpinner.succeed();

  const npmSpinner = ora("Installing dependencies...").start();
  await exec("npm install");
  npmSpinner.succeed();

  console.log("The installation is done!");
  console.log("You can now run your app with:");
  console.log(
    `    cd ${projectNameHasSpace ? `"${projectName}"` : projectName}`
  );
  console.log(`    npm run start`);
} catch (error) {
  // clean up in case of error, so the user does not have to do it manually
  fs.rmSync(projectPath, { recursive: true, force: true });
  console.log(error);
}