git

Documentation

Index

• Variables
• func IsAuthError(err error) bool
• func IsNoRemoteError(err error) bool
• func IsNotRepositoryError(err error) bool
• type GitError
  • func (e *GitError) Error() string
  • func (e *GitError) Unwrap() error
• type GitRepository
  • func NewMemoryRepository(workingDir string) GitRepository
  • func NewRepository(workingDir string) (GitRepository, error)
• type MemoryRepository
  • func (r *MemoryRepository) Add(patterns ...string) error
  • func (r *MemoryRepository) Commit(message string) error
  • func (r *MemoryRepository) CreateFile(filename, content string) error
  • func (r *MemoryRepository) Exists() (bool, error)
  • func (r *MemoryRepository) GetWorkingDirectory() string
  • func (r *MemoryRepository) HasRemote() (bool, error)
  • func (r *MemoryRepository) Init(branch string) error
  • func (r *MemoryRepository) Push() error
  • func (r *MemoryRepository) PushContext(ctx context.Context) error
  • func (r *MemoryRepository) SetRemote(name, url string) error
  • func (r *MemoryRepository) Status() ([]string, error)
• type Repository
  • func (r *Repository) Add(patterns ...string) error
  • func (r *Repository) Commit(message string) error
  • func (r *Repository) Exists() (bool, error)
  • func (r *Repository) GetWorkingDirectory() string
  • func (r *Repository) HasRemote() (bool, error)
  • func (r *Repository) Init(branch string) error
  • func (r *Repository) Push() error
  • func (r *Repository) PushContext(ctx context.Context) error
  • func (r *Repository) SetRemote(name, url string) error
  • func (r *Repository) Status() ([]string, error)

Variables

var (
	ErrNoRemote      = errors.New("no remote origin configured")
	ErrAuthFailed    = errors.New("authentication failed")
	ErrNotRepository = errors.New("not a git repository")
)

Common git operation errors

Functions

func IsAuthError

func IsAuthError(err error) bool

IsAuthError checks if an error is due to authentication failure

func IsNoRemoteError

func IsNoRemoteError(err error) bool

IsNoRemoteError checks if an error is due to missing remote configuration

func IsNotRepositoryError

func IsNotRepositoryError(err error) bool

IsNotRepositoryError checks if an error is due to not being in a git repository

Types

type GitError

type GitError struct {
	Op   string // Operation that failed (e.g., "init", "add", "commit", "push")
	Path string // Path where the operation failed
	Err  error  // Underlying error
}

GitError represents a git operation error with context

func (*GitError) Error

func (e *GitError) Error() string

func (*GitError) Unwrap

func (e *GitError) Unwrap() error

type GitRepository

type GitRepository interface {
	// Init initializes a git repository with the specified branch name
	Init(branch string) error

	// Add stages files for commit. Use "." to add all files
	Add(patterns ...string) error

	// Commit creates a commit with the given message
	Commit(message string) error

	// Push pushes commits to the remote repository
	Push() error

	// PushContext pushes commits to the remote repository with context for cancellation
	PushContext(ctx context.Context) error

	// Status returns a list of changed files
	Status() ([]string, error)

	// HasRemote checks if a remote named "origin" is configured
	HasRemote() (bool, error)

	// SetRemote sets a remote repository URL
	SetRemote(name, url string) error

	// GetWorkingDirectory returns the path to the working directory
	GetWorkingDirectory() string

	// Exists checks if a git repository exists at the working directory
	Exists() (bool, error)
}

GitRepository defines the interface for git operations This interface allows for easy testing by providing mockable methods

func NewMemoryRepository

func NewMemoryRepository(workingDir string) GitRepository

NewMemoryRepository creates a new in-memory repository for testing

func NewRepository

func NewRepository(workingDir string) (GitRepository, error)

NewRepository creates a new Repository instance

type MemoryRepository

type MemoryRepository struct {
	// contains filtered or unexported fields
}

MemoryRepository implements GitRepository using in-memory storage This is perfect for testing as it doesn't touch the filesystem

func (*MemoryRepository) Add

func (r *MemoryRepository) Add(patterns ...string) error

Add stages files for commit

func (*MemoryRepository) Commit

func (r *MemoryRepository) Commit(message string) error

Commit creates a commit with the given message

func (*MemoryRepository) CreateFile

func (r *MemoryRepository) CreateFile(filename, content string) error

CreateFile creates a file in the in-memory filesystem for testing

func (*MemoryRepository) Exists

func (r *MemoryRepository) Exists() (bool, error)

Exists checks if a git repository exists (always true for memory repos after Init)

func (*MemoryRepository) GetWorkingDirectory

func (r *MemoryRepository) GetWorkingDirectory() string

GetWorkingDirectory returns the path to the working directory

func (*MemoryRepository) HasRemote

func (r *MemoryRepository) HasRemote() (bool, error)

HasRemote checks if a remote named "origin" is configured

func (*MemoryRepository) Init

func (r *MemoryRepository) Init(branch string) error

Init initializes a git repository with the specified branch name

func (*MemoryRepository) Push

func (r *MemoryRepository) Push() error

Push pushes commits to the remote repository

func (*MemoryRepository) PushContext

func (r *MemoryRepository) PushContext(ctx context.Context) error

PushContext pushes commits to the remote repository with context

func (*MemoryRepository) SetRemote

func (r *MemoryRepository) SetRemote(name, url string) error

SetRemote sets a remote repository URL

func (*MemoryRepository) Status

func (r *MemoryRepository) Status() ([]string, error)

Status returns a list of changed files

type Repository

type Repository struct {
	// contains filtered or unexported fields
}

Repository implements GitRepository using go-git library

func (*Repository) Add

func (r *Repository) Add(patterns ...string) error

Add stages files for commit

func (*Repository) Commit

func (r *Repository) Commit(message string) error

Commit creates a commit with the given message

func (*Repository) Exists

func (r *Repository) Exists() (bool, error)

Exists checks if a git repository exists at the working directory

func (*Repository) GetWorkingDirectory

func (r *Repository) GetWorkingDirectory() string

GetWorkingDirectory returns the path to the working directory

func (*Repository) HasRemote

func (r *Repository) HasRemote() (bool, error)

HasRemote checks if any remote is configured

func (*Repository) Init

func (r *Repository) Init(branch string) error

Init initializes a git repository with the specified branch name

func (*Repository) Push

func (r *Repository) Push() error

Push pushes commits to the remote repository

func (*Repository) PushContext

func (r *Repository) PushContext(ctx context.Context) error

PushContext pushes commits to the remote repository with context

func (*Repository) SetRemote

func (r *Repository) SetRemote(name, url string) error

SetRemote sets a remote repository URL

func (*Repository) Status

func (r *Repository) Status() ([]string, error)

Status returns a list of changed files