Commit Variants

function commitAll(
  message: string,
  description?: string
): Promise<string>

import { commitAll } from "usegit"

// Automatically stage all tracked files and commit
await commitAll("chore: update deps")

// With description
await commitAll(
  "refactor: restructure modules",
  "Moved components to separate directories for better organization."
)

function commitAmend(
  message?: string,
  description?: string
): Promise<string>

import { add, commitAmend } from "usegit"

// Fix a typo in the last commit message
await commitAmend("fix: typo in component")

// Add forgotten files to last commit
await add(["src/forgotten.ts"])
await commitAmend() // Keeps existing message

function commitEmpty(message: string): Promise<string>

import { commitEmpty } from "usegit"

// Trigger CI without actual changes
await commitEmpty("chore: trigger CI")

// Mark a milestone
await commitEmpty("milestone: v2.0.0 planning complete")

function commitFixup(commitId: string): Promise<string>

import { add, commitFixup } from "usegit"

// Create fixup commit for a previous commit
await add(["src/bug-fix.ts"])
await commitFixup("abc123")

// Later, during interactive rebase:
// git rebase -i --autosquash main

function commitNoEdit(): Promise<string>

import { add, commitNoEdit } from "usegit"

// Add forgotten files and amend without changing message
await add(["src/forgotten.ts"])
await commitNoEdit()

function commitReuseMessage(commitId: string): Promise<string>

import { add, commitReuseMessage } from "usegit"

// Make similar changes and reuse the message
await add(["src/another-fix.ts"])
await commitReuseMessage("abc123")

function commitSignoff(
  message: string,
  description?: string
): Promise<string>

import { add, commitSignoff } from "usegit"

// Commit with signoff
await add(".")
await commitSignoff("feat: add API endpoint")

// The commit message will include:
// feat: add API endpoint
//
// Signed-off-by: Your Name <[email protected]>

function commitWithAuthor(
  message: string,
  author: string,
  description?: string
): Promise<string>

import { add, commitWithAuthor } from "usegit"

// Commit code written by someone else
await add(".")
await commitWithAuthor(
  "feat: initial import",
  "Alice <[email protected]>"
)

// With description
await commitWithAuthor(
  "fix: resolve merge conflict",
  "Bob <[email protected]>",
  "Applied Bob's fix after manual merge."
)