Class GitClient

ng-dev/utils/git/git-client.ts:34–249

/** Class that can be used to perform Git interactions with a given remote. **/
export class GitClient {
  /** Short-hand for accessing the default remote configuration. */
  readonly remoteConfig: GithubConfig;

  /** Octokit request parameters object for targeting the configured remote. */
  readonly remoteParams: {owner: string; repo: string};

  /** Name of the primary branch of the upstream remote. */
  readonly mainBranchName: string;

  /** Instance of the Github client. */
  readonly github = new GithubClient();

  /** The configuration, containing the github specific configuration. */
  readonly config: {github: GithubConfig};

  /**
   * Path to the Git executable. By default, `git` is assumed to exist
   * in the shell environment (using `$PATH`).
   */
  readonly gitBinPath: string = 'git';

  constructor(
    /** The configuration, containing the github specific configuration. */
    config: {github: GithubConfig},
    /** The full path to the root of the repository base. */
    readonly baseDir = determineRepoBaseDirFromCwd(),
  ) {
    this.config = config;
    this.remoteConfig = config.github;
    this.remoteParams = {owner: config.github.owner, repo: config.github.name};
    this.mainBranchName = config.github.mainBranchName;
  }

  /** Executes the given git command. Throws if the command fails. */
  run(args: string[], options?: GitCommandRunOptions): Omit<SpawnSyncReturns<string>, 'status'> {
    const result = this.runGraceful(args, options);
    if (result.status !== 0) {
      throw new GitCommandError(this, args);
    }
    // Omit `status` from the type so that it's obvious that the status is never
    // non-zero as explained in the method description.
    return result as Omit<SpawnSyncReturns<string>, 'status'>;
  }

  /**
   * Spawns a given Git command process. Does not throw if the command fails. Additionally,
   * if there is any stderr output, the output will be printed. This makes it easier to
   * info failed commands.
   */
  runGraceful(args: string[], options: GitCommandRunOptions = {}): SpawnSyncReturns<string> {
    /** The git command to be run. */
    const gitCommand = args[0];

    if (isDryRun() && gitCommand === 'push') {
      Log.debug(`"git push" is not able to be run in dryRun mode.`);
      throw new DryRunError();
    }