gitparse

Documentation

Index

• type Commit
  • func (c1 *Commit) Equal(c2 *Commit) bool
• type Diff
• type Option
  • func WithMaxCommitSize(maxCommitSize int) Option
  • func WithMaxDiffSize(maxDiffSize int) Option
• type Parser
  • func NewParser(options ...Option) *Parser
  • func (c *Parser) FromReader(ctx context.Context, stdOut io.Reader, commitChan chan Commit)
  • func (c *Parser) RepoPath(ctx context.Context, source string, head string, abbreviatedLog bool, ...) (chan Commit, error)
  • func (c *Parser) Unstaged(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(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
	Content   bytes.Buffer
	IsBinary  bool
}

Diff contains the info about a file diff in a commit.

type Option

type Option func(*Parser)

Option is used for adding options to Config.

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 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)

func (*Parser) RepoPath

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

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

func (*Parser) Unstaged

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

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