CommitOpts

CommitOpts = object

Defined in: src/core/repo.ts:651

Options for git commit

Properties

all?

optional all: boolean

Defined in: src/core/repo.ts:660

Add all tracked modified files

---

allowEmpty?

optional allowEmpty: boolean

Defined in: src/core/repo.ts:656

Allow empty commit

---

allowEmptyMessage?

optional allowEmptyMessage: boolean

Defined in: src/core/repo.ts:708

Allow commit with empty message

---

amend?

optional amend: boolean

Defined in: src/core/repo.ts:658

Amend previous commit

---

author?

optional author: string

Defined in: src/core/repo.ts:662

Author name and email

---

cleanup?

optional cleanup: "strip" | "whitespace" | "verbatim" | "scissors" | "default"

Defined in: src/core/repo.ts:696

How to clean up the commit message

---

date?

optional date: string | Date

Defined in: src/core/repo.ts:664

Override commit date

---

dryRun?

optional dryRun: boolean

Defined in: src/core/repo.ts:666

Do not create commit, just update message

---

file?

optional file: string

Defined in: src/core/repo.ts:680

Read commit message from file

---

fixup?

optional fixup: string

Defined in: src/core/repo.ts:686

Create a fixup commit for the specified commit

---

gpgSign?

optional gpgSign: boolean

Defined in: src/core/repo.ts:670

GPG-sign the commit with the default key

---

include?

optional include: boolean

Defined in: src/core/repo.ts:698

Before committing, also stage specified paths

---

message?

optional message: string

Defined in: src/core/repo.ts:654

Commit message

---

noGpgSign?

optional noGpgSign: boolean

Defined in: src/core/repo.ts:672

Do not GPG-sign the commit (override commit.gpgSign config)

---

noPostRewrite?

optional noPostRewrite: boolean

Defined in: src/core/repo.ts:702

Bypass post-rewrite hook

---

noVerify?

optional noVerify: boolean

Defined in: src/core/repo.ts:668

Bypass pre-commit and commit-msg hooks

---

only?

optional only: boolean

Defined in: src/core/repo.ts:700

Commit only specified paths, ignoring staged changes

---

pathspecFromFile?

optional pathspecFromFile: string

Defined in: src/core/repo.ts:706

Read pathspecs from file instead of command line

---

quiet?

optional quiet: boolean

Defined in: src/core/repo.ts:676

Suppress commit summary message

---

reeditMessage?

optional reeditMessage: string

Defined in: src/core/repo.ts:682

Take existing commit message and re-edit it

---

resetAuthor?

optional resetAuthor: boolean

Defined in: src/core/repo.ts:690

Override author date and ignore cached author identity

---

reuseMessage?

optional reuseMessage: string

Defined in: src/core/repo.ts:684

Take existing commit message and reuse it

---

signoff?

optional signoff: boolean

Defined in: src/core/repo.ts:694

Add Signed-off-by trailer

---

squash?

optional squash: string

Defined in: src/core/repo.ts:688

Create a squash commit for the specified commit

---

trailer?

optional trailer: string | string[]

Defined in: src/core/repo.ts:692

Add trailers to the commit message

---

untrackedFiles?

optional untrackedFiles: "no" | "normal" | "all"

Defined in: src/core/repo.ts:704

How to show untracked files

---

verbose?

optional verbose: boolean

Defined in: src/core/repo.ts:678

Show unified diff between HEAD and working tree