autocommit

Documentation

Index

• Constants
• type Clipboard
  • func MakeClipboard() Clipboard
  • func NewClipboard() Clipboard
• type ClipboardCommand
  • func MakeClipboardCommand() ClipboardCommand
  • func NewClipboardCommand(clipboard Clipboard) ClipboardCommand
• type GeneratorCommand
  • func MakeGeneratorCommand() GeneratorCommand
  • func NewGeneratorCommand(chatCommand openai.ChatCommand, diffCommand git.DiffCommand) GeneratorCommand
• type PostCommitCli
  • func MakePostCommitCli() PostCommitCli
  • func NewPostCommitCli() PostCommitCli

Constants

const (
	CommitChangesOption   = "Commit changes to git"
	RegenerateOption      = "Regenerate commit message"
	CopyToClipboardOption = "Copy message to clipboard"
	ExitOption            = "Exit"
)

const SystemMsg = `` /* 3197-byte string literal not displayed */

SystemMsg is the message that will feed the OpenAI API to generate the commit message.

Types

type Clipboard

type Clipboard interface {
	// Copy copies the given message to the clipboard.
	Copy(message string) error
}

Clipboard is an interface that defines the Copy method.

func MakeClipboard

func MakeClipboard() Clipboard

func NewClipboard

func NewClipboard() Clipboard

NewClipboard creates a new instance of Clipboard.

type ClipboardCommand

type ClipboardCommand interface {
	Execute(message string) error
}

func MakeClipboardCommand

func MakeClipboardCommand() ClipboardCommand

func NewClipboardCommand

func NewClipboardCommand(clipboard Clipboard) ClipboardCommand

type GeneratorCommand

type GeneratorCommand interface {
	// Execute returns the commit message generated by OpenAI.
	Execute() (string, error)
}

GeneratorCommand is the interface that wraps the Execute method.

func MakeGeneratorCommand

func MakeGeneratorCommand() GeneratorCommand

func NewGeneratorCommand

func NewGeneratorCommand(chatCommand openai.ChatCommand, diffCommand git.DiffCommand) GeneratorCommand

NewGeneratorCommand creates a new instance of GeneratorCommand.

type PostCommitCli

type PostCommitCli interface {
	// Execute executes the post commit CLI.
	Execute() (string, error)
}

PostCommitCli is an interface for executing post commit CLI operations.

func MakePostCommitCli

func MakePostCommitCli() PostCommitCli

func NewPostCommitCli

func NewPostCommitCli() PostCommitCli

NewPostCommitCli creates a new instance of PostCommitCli.