gitparse

package

v3.0.0-...-838862a Latest Latest Go to latest Published: Oct 2, 2023 License: AGPL-3.0 Imports: 12 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gitpwned/gitpwned

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 ParseState
- func (state ParseState) String() string
type Parser
- func NewParser(options ...Option) *Parser

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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

Source Files ¶

View all Source files

gitparse.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL