turbo-gulp/utils/branch-publish.ts

Gulp tasks to boost high-quality projects.

import del from "del";
import { copy } from "fs-extra";
import * as posixPath from "path";
import {dir as tmpDir } from "tmp";
import { toPosix } from "../project";
import { AbsPosixPath } from "../types";
import { gitAdd, gitClone as gitClone, gitCommit, gitPush } from "./git";

/**
 * Run executor inside a tmp directory. Clean the directory once executor is done.
 */
async function withTmpDir(executor: (path: AbsPosixPath) => Promise<void>): Promise<void> {
  return new Promise<void>((resolve, reject): void => {
    tmpDir({unsafeCleanup: true}, async (err: Error | null, path: string, done: (cb: any) => void): Promise<void> => {
      if (err !== null) {
        reject(err);
        return;
      }
      try {
        await executor(toPosix(path));
        done(() => {
          resolve();
        });
      } catch (err) {
        done(() => {
          reject(err);
        });
      }
    });
  });
}

export interface BranchPublishOptions {
  /**
   * Directory to publish
   */
  dir: string;

  /**
   * Name of the branch to update.
   */
  branch: string;

  /**
   * Repo where to publish.
   */
  repository: string;

  /**
   * Message to use when commiting changes.
   */
  commitMessage: string;

  /**
   * Overide the default Git `user` config for this commit. Use the format "John Doe <john.doe@example.com>".
   */
  commitAuthor?: string;
}

export async function branchPublish(options: BranchPublishOptions): Promise<void> {
  return withTmpDir(async (tmpDirPath: AbsPosixPath): Promise<void> => {
    console.log(`Using temporary directory: ${tmpDirPath}`);
    const localPath: AbsPosixPath = posixPath.join(tmpDirPath, "repo");
    await gitClone({branch: options.branch, depth: 1, repository: options.repository, directory: localPath});
    await del([posixPath.join(localPath, "**", "*"), `!${posixPath.join(localPath, ".git")}`], {force: true});
    await copy(options.dir, localPath);
    await gitAdd({repository: localPath, paths: ["."]});
    await gitCommit({
      repository: localPath,
      message: options.commitMessage,
      author: options.commitAuthor,
    });
    await gitPush({
      local: localPath,
      remote: "origin",
    });
    console.log(`Pushed to: ${options.repository} on branch ${options.branch}`);
  });
}