List and Check Branches

function listBranches(): Promise<string[]>

import { listBranches } from 'usegit';

const branches = await listBranches();
console.log(branches);
// ['main', 'feature/login', 'feature/dashboard']

// Check if a specific branch exists in local branches
const branches = await listBranches();
const hasFeature = branches.includes('feature/login');

if (hasFeature) {
  console.log('Feature branch exists locally');
}

function listAllBranches<T extends BranchListFormat>(
  format?: T
): Promise<BranchListResult<T>>

import { listAllBranches } from 'usegit';

// Get flat array of all branches
const allBranches = await listAllBranches('flat');
console.log(allBranches);
// ['main', 'feature/login', 'remotes/origin/main']

// Get structured JSON format
const branches = await listAllBranches('json');

console.log('Local branches:', branches.local);
console.log('Remote branches:', branches.remote);
console.log('Default branch:', branches.head);

// Output:
// Local branches: ['main', 'feature/login', 'develop']
// Remote branches: ['origin/main', 'origin/develop', 'origin/feature/payment']
// Default branch: 'origin/main'

// Get CSV format for export
const csv = await listAllBranches('csv');
console.log(csv);

// Output:
// type,name
// local,main
// local,develop
// remote,origin/main
// head,origin/main

// Default format (flat)
const branches = await listAllBranches();
// Returns string[]

function listRemoteBranches(): Promise<string[]>

import { listRemoteBranches } from 'usegit';

const remoteBranches = await listRemoteBranches();
console.log(remoteBranches);
// ['origin/main', 'origin/develop', 'upstream/main']

// Find all branches on a specific remote
const remoteBranches = await listRemoteBranches();
const originBranches = remoteBranches.filter(b => b.startsWith('origin/'));

console.log('Branches on origin:', originBranches);
// ['origin/main', 'origin/develop', 'origin/feature/login']

function branchExists(name: string): Promise<boolean>

import { branchExists } from 'usegit';

const exists = await branchExists('main');
console.log(exists); // true

const missing = await branchExists('nonexistent-branch');
console.log(missing); // false

// Conditional branch creation
import { branchExists, createBranch } from 'usegit';

const branchName = 'feature/new-feature';

if (await branchExists(branchName)) {
  console.log(`Branch ${branchName} already exists`);
} else {
  await createBranch(branchName);
  console.log(`Created branch ${branchName}`);
}

function currentBranch(): Promise<string>

import { currentBranch } from 'usegit';

const branch = await currentBranch();
console.log(`Currently on branch: ${branch}`);
// Currently on branch: main

// Verify current branch before operations
import { currentBranch, deleteBranch } from 'usegit';

const current = await currentBranch();
const branchToDelete = 'feature/old';

if (current === branchToDelete) {
  console.error('Cannot delete the current branch. Switch branches first.');
} else {
  await deleteBranch(branchToDelete);
}

// Display branch in CLI output
const branch = await currentBranch();
console.log(`[${branch}] Running tests...`);
// [feature/login] Running tests...

function getDefaultBranch(): Promise<string | undefined>

import { getDefaultBranch } from 'usegit';

const defaultBranch = await getDefaultBranch();
console.log(`Default branch: ${defaultBranch}`);
// Default branch: main

// Fallback to main if default cannot be determined
const defaultBranch = await getDefaultBranch() ?? 'main';
console.log(`Using branch: ${defaultBranch}`);

// Create feature branch from default branch
import { getDefaultBranch, createBranch } from 'usegit';

const base = await getDefaultBranch();
if (base) {
  console.log(`Creating feature branch from ${base}`);
  await createBranch('feature/new-feature');
} else {
  console.error('Could not determine default branch');
}