Diff Variants

function diffCommits(
  from: string,
  to: string,
  paths?: readonly string[]
): Promise<string>

const changes = await git.diffCommits("HEAD~1", "HEAD")
const srcChanges = await git.diffCommits("main", "dev", ["src"])

function diffFiles(
  fileA: string,
  fileB: string
): Promise<string>

const diff = await git.diffFiles("config.json", "config.backup.json")

function diffHead(
  paths?: readonly string[]
): Promise<string>

const changes = await git.diffHead()
const readmeChanges = await git.diffHead(["README.md"])

function diffRange(
  range: `${string}...${string}`,
  paths?: readonly string[]
): Promise<string>

const changes = await git.diffRange("main...dev")
const releaseChanges = await git.diffRange("v1.0.0...v1.1.0", ["src"])

function diffStaged(
  paths?: readonly string[]
): Promise<string>

const staged = await git.diffStaged()
const stagedSrc = await git.diffStaged(["src/index.ts"])

function diffWorkingTree(
  paths?: readonly string[]
): Promise<string>

const changes = await git.diffWorkingTree()
const srcChanges = await git.diffWorkingTree(["src"])

function getChangedFiles(): Promise<string[]>

const files = await git.getChangedFiles()
console.log(files) // ["src/index.ts", "README.md"]

function getStagedFiles(): Promise<string[]>

const files = await git.getStagedFiles()
console.log(files) // ["src/index.ts"]

function changedFileCount(): Promise<number>

const count = await git.changedFileCount()
console.log(`${count} files changed`)

function stagedFileCount(): Promise<number>

const count = await git.stagedFileCount()
console.log(`${count} files staged`)

function hasDiff(): Promise<boolean>

if (await git.hasDiff()) {
  console.log("Working tree has changes")
}

function hasStagedDiff(): Promise<boolean>

if (await git.hasStagedDiff()) {
  console.log("There are staged changes")
}

function hasBinaryChanges(): Promise<boolean>

if (await git.hasBinaryChanges()) {
  console.log("Binary file changes present")
}

function hasOnlyWhitespaceChanges(): Promise<boolean>

if (await git.hasOnlyWhitespaceChanges()) {
  console.log("Only formatting changes detected")
}

function hasOnlyEOLChanges(): Promise<boolean>

if (await git.hasOnlyEOLChanges()) {
  console.log("Only EOL changes detected")
}