Method logFilesAsync

tools/src/Git.ts:290–322

* Returns a list of files that have been modified, deleted or added between specified commits.

(options: GitLogOptions = {})

   * Returns a list of files that have been modified, deleted or added between specified commits.
   */
  async logFilesAsync(options: GitLogOptions = {}): Promise<GitFileLog[]> {
    const fromCommit = options.fromCommit ?? '';
    const toCommit = options.toCommit ?? 'HEAD';

    // This diff command returns a list of relative paths of files that have changed preceded by their status.
    // Status is just a letter, which is also a key of `GitFileStatus` enum.
    const { stdout } = await this.runAsync([
      'diff',
      '--name-status',
      `${fromCommit}..${toCommit}`,
      '--relative',
      '--',
      '.',
    ]);

    return stdout
      .split(/\n/g)
      .filter(Boolean)
      .map((line) => {
        // Consecutive columns are separated by horizontal tabs.
        // In case of `R` (rename) status, there are three columns instead of two,
        // where the third is the new path after renaming and we should use the new one.
        const [status, relativePath, relativePathAfterRename] = line.split(/\t+/g);
        const newPath = relativePathAfterRename ?? relativePath;

        return {
          relativePath: newPath,
          path: join(this.path, newPath),
          // `R` status also has a number, but we take care of only the first character.
          status: GitFileStatus[status[0]] ?? status,
        };
      });
  }

  /**
   * Adds files at given glob paths.