project setup

src/service/git/git-cli.ts

@@ -0,0 +1,110 @@
+import LoggerService from "@gb/service/logger/logger-service";
+import LoggerServiceFactory from "@gb/service/logger/logger-service-factory";
+import simpleGit, { SimpleGit } from "simple-git";
+import fs from "fs";
+
+/**
+ * Command line git commands executor service
+ */
+export default class GitCLIService {
+
+  private readonly logger: LoggerService;
+
+  constructor() {
+    this.logger = LoggerServiceFactory.getLogger();
+  }
+
+  /**
+   * Return a pre-configured SimpleGit instance able to execute commands from current
+   * directory or the provided one
+   * @param cwd [optional] current working directory
+   * @returns {SimpleGit} 
+   */
+  private git(cwd?: string): SimpleGit {
+    const gitConfig = { ...(cwd ? { baseDir: cwd } : {})};
+    return simpleGit(gitConfig).addConfig("user.name", "Github").addConfig("user.email", "noreply@github.com");
+  }
+
+  /**
+   * Return the git version
+   * @returns {Promise<string | undefined>}
+   */
+  async version(): Promise<string | undefined> {
+    const rawOutput = await this.git().raw("version");
+    const match = rawOutput.match(/(\d+\.\d+(\.\d+)?)/);
+    return match ? match[1] : undefined;
+  }
+
+  /**
+   * Clone a git repository
+   * @param from url or path from which the repository should be cloned from
+   * @param to location at which the repository should be cloned at
+   * @param branch branch which should be cloned
+   */
+  async clone(from: string, to: string, branch: string): Promise<void> {
+    this.logger.info(`Cloning repository ${from}..`);
+    if (!fs.existsSync(to)) {
+      await this.git().clone(from, to, ["--quiet", "--shallow-submodules", "--no-tags", "--branch", branch]);
+    } else {
+      this.logger.warn(`Folder ${to} already exist. Won't clone`);
+    }
+  }
+
+  /**
+   * Create a new branch starting from the current one and checkout in it
+   * @param cwd repository in which createBranch should be performed
+   * @param newBranch new branch name
+   */
+  async createLocalBranch(cwd: string, newBranch: string): Promise<void> {
+    this.logger.info(`Creating branch ${newBranch}..`);
+    await this.git(cwd).checkoutLocalBranch(newBranch);
+  }
+
+  /**
+   * Add a new remote to the current repository
+   * @param cwd repository in which addRemote should be performed
+   * @param remote remote git link
+   * @param remoteName [optional] name of the remote, by default 'fork' is used 
+   */
+  async addRemote(cwd: string, remote: string, remoteName = "fork"): Promise<void> {
+    this.logger.info(`Adding new remote ${remote}..`);
+    await this.git(cwd).addRemote(remoteName, remote);
+  }
+
+  /**
+   * Git fetch from a particular branch
+   * @param cwd repository in which fetch should be performed
+   * @param branch fetch from the given branch
+   * @param remote [optional] the remote to fetch, by default origin
+   */
+  async fetch(cwd: string, branch: string, remote = "origin"): Promise<void> {
+    await this.git(cwd).fetch(remote, branch, ["--quiet"]);
+  }
+
+  /**
+   * Get cherry-pick a specific sha
+   * @param cwd repository in which the sha should be cherry picked to
+   * @param sha commit sha
+   */
+  async cherryPick(cwd: string, sha: string): Promise<void> {
+    this.logger.info(`Cherry picking ${sha}..`);
+    await this.git(cwd).raw(["cherry-pick", "--strategy=recursive", "-X", "theirs", sha]);
+  }
+
+  /**
+   * Push a branch to a remote
+   * @param cwd repository in which the push should be performed
+   * @param branch branch to be pushed
+   * @param remote [optional] remote to which the branch should be pushed to, by default 'origin'
+   */
+  async push(cwd: string, branch: string, remote = "origin", force = false): Promise<void> {
+    this.logger.info(`Pushing ${branch} to ${remote}..`);
+    
+    const options = ["--quiet"];
+    if (force) {
+      options.push("--force-with-lease");
+    }
+    await this.git(cwd).push(remote, branch, options);
+  }
+
+}