gitparse

Documentation

Index

• type Commit
  • func (c1 *Commit) Equal(ctx context.Context, c2 *Commit) bool
• type Diff
  • func NewDiff(opts ...diffOption) *Diff
  • func (d *Diff) Len() int
  • func (d *Diff) ReadCloser() (io.ReadCloser, error)
• type Option
  • func UseCustomContentWriter() Option
  • func WithMaxCommitSize(maxCommitSize int) Option
  • func WithMaxDiffSize(maxDiffSize int) Option
• type ParseState
  • func (state ParseState) String() string
• type Parser
  • func NewParser(options ...Option) *Parser
  • func (c *Parser) FromReader(ctx context.Context, stdOut io.Reader, commitChan chan Commit, isStaged bool)
  • func (c *Parser) RepoPath(ctx context.Context, source string, head string, abbreviatedLog bool, ...) (chan Commit, error)
  • func (c *Parser) Staged(ctx context.Context, source string) (chan Commit, error)

Types

type Commit

type Commit struct {
	Hash    string
	Author  string
	Date    time.Time
	Message strings.Builder
	Diffs   []Diff
	Size    int // in bytes
}

Commit contains commit header info and diffs.

func (*Commit) Equal

func (c1 *Commit) Equal(ctx context.Context, c2 *Commit) bool

Equal compares the content of two Commits to determine if they are the same.

type Diff

type Diff struct {
	PathB     string
	LineStart int
	IsBinary  bool
	// contains filtered or unexported fields
}

Diff contains the information about a file diff in a commit. It abstracts the underlying content representation, allowing for flexible handling of diff content. The use of contentWriter enables the management of diff data either in memory or on disk, based on its size, optimizing resource usage and performance.

func NewDiff

func NewDiff(opts ...diffOption) *Diff

NewDiff creates a new Diff with a threshold.

func (*Diff) Len

func (d *Diff) Len() int

Len returns the length of the storage.

func (*Diff) ReadCloser

func (d *Diff) ReadCloser() (io.ReadCloser, error)

ReadCloser returns a ReadCloser for the contentWriter.

type Option

type Option func(*Parser)

Option is used for adding options to Config.

func UseCustomContentWriter

func UseCustomContentWriter() Option

UseCustomContentWriter sets useCustomContentWriter option.

func WithMaxCommitSize

func WithMaxCommitSize(maxCommitSize int) Option

WithMaxCommitSize sets maxCommitSize option. Commits larger than maxCommitSize will be put in the commit channel and additional diffs will be added to a new commit.

func WithMaxDiffSize

func WithMaxDiffSize(maxDiffSize int) Option

WithMaxDiffSize sets maxDiffSize option. Diffs larger than maxDiffSize will be truncated.

type ParseState

type ParseState int

const (
	Initial ParseState = iota
	CommitLine
	MergeLine
	AuthorLine
	DateLine
	MessageStartLine
	MessageLine
	MessageEndLine
	DiffLine
	ModeLine
	IndexLine
	FromFileLine
	ToFileLine
	BinaryFileLine
	HunkLineNumberLine
	HunkContentLine
	ParseFailure
)

func (ParseState) String

func (state ParseState) String() string

type Parser

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

Parser sets values used in GitParse.

func NewParser

func NewParser(options ...Option) *Parser

NewParser creates a GitParse config from options and sets defaults.

func (*Parser) FromReader

func (c *Parser) FromReader(ctx context.Context, stdOut io.Reader, commitChan chan Commit, isStaged bool)

func (*Parser) RepoPath

func (c *Parser) RepoPath(ctx context.Context, source string, head string, abbreviatedLog bool, excludedGlobs []string, isBare bool) (chan Commit, error)

RepoPath parses the output of the `git log` command for the `source` path.

func (*Parser) Staged

func (c *Parser) Staged(ctx context.Context, source string) (chan Commit, error)

Staged parses the output of the `git diff` command for the `source` path.