pr-check / src / interfaces / CommitDiff.ts
CommitDiff.ts
Raw
import { FileDiff } from './FileDiff';

/**
 * @description Wraps the components of a git diff, as output by the command `git log --online`
 * @field commitHash The hash of the commit
 * @field author The author of the commit. This is a string that includes whatever is shown in the `git show` output, like name, email, or any other identifiers in the 'author' field.
 * @field date The date of the commit
 * @field title The title of the commit
 * @field message The message of the commit
 * @field diffs The diffs for each individual file of the commit
 */
export interface CommitDiff {
  commitHash: string;
  author: string;
  date: string;
  title: string;
  message: string;
  diffs: FileDiff[];
}