secret-polar-reworks/src/internal/util/fetch.ts

Polar is a development environment to compile, deploy, test, run scrt contracts on different networks.

import chalk from "chalk";
import download from "download-git-repo";
import fse from "fs-extra";
import path from "path";
import tmp from "tmp";
import { promisify } from "util";

interface TmpI {
  path: string
  cleanupCallback: () => void
}

/**
 * Creates a temporary directory in /tmp to download templates
 * eg. tmp-86625-iMiAxZVeTy1U/templates
 */
export async function setUpTempDirectory (): Promise<TmpI> {
  const options = {
    unsafeCleanup: true
  };
  try {
    const tmpDir = tmp.dirSync(options);
    return {
      path: path.join(tmpDir.name, "templates"),
      cleanupCallback: tmpDir.removeCallback
    };
  } catch (error) {
    console.error('Failed to initialize');
    throw error;
  }
}

/**
 * Creates a prompt for each overwriting file, and confirms overwrite.
 * if overwrite is confirmed the file is deleted
 * @param contentCollisions Colliding files
 * @param destination location to copy template from tempDir
 */
async function promptOverwrites (
  contentCollisions: string[],
  destination: string
): Promise<string[]> {
  const { default: enquirer } = await import("enquirer");
  const overwriteContents = [];
  let response: {
    overwrite: boolean
  };

  for (const file of contentCollisions) {
    console.log(chalk.yellow(`${file} already exists in this directory..`));
    const overwriteToggle = [
      {
        type: "Toggle",
        name: "overwrite",
        message: `Overwrite ${file}?`,
        enabled: 'Yes',
        disabled: 'No'
      }
    ];

    response = await enquirer.prompt(overwriteToggle);
    if (response.overwrite) {
      fse.removeSync(`${destination}/${file}`);
      overwriteContents.push(file);
    }
  }

  return overwriteContents;
}

/**
 * Copies template files from tempory directory to destination directory.
 * If --force is not used, user is asked by a promt to overwrite colliding files or not
 * @param tmpDir template directory to copy from
 * @param destination directory to copy template to
 * @param force if true, the colliding files are overwritten by default
 */
export async function copyTemplatetoDestination (
  tmpDir: string,
  destination: string,
  force: boolean
): Promise<void> {
  fse.ensureDirSync(destination);
  const templateContents = fse.readdirSync(tmpDir);
  const destinationContents = fse.readdirSync(destination);

  const newContents = templateContents.filter(
    filename => !destinationContents.includes(filename)
  );

  const contentCollisions = templateContents.filter(filename =>
    destinationContents.includes(filename)
  );

  let shouldCopy;
  if (force) {
    shouldCopy = templateContents;
  } else {
    const overwriteContents = await promptOverwrites(contentCollisions, destination);
    shouldCopy = [...newContents, ...overwriteContents];
  }

  for (const file of shouldCopy) {
    fse.copySync(`${tmpDir}/${file}`, `${destination}/${file}`);
  }
}

/**
 * Downloads repo from git url to destination path
 * @param url git url (<organization/repo>)
 * @param destination location to download repo
 */
export async function fetchRepository (url: string, destination: string): Promise<void> {
  try {
    // eslint-disable-next-line @typescript-eslint/no-misused-promises
    await promisify(download)(url, destination);
  } catch (error) {
    console.error(`Failed to initialize ${url}`);
    throw error;
  }
}