output

Documentation

Index

• func BranchHeads(repo *gogit.Repository) (map[string]*object.Commit, error)
• func FindBranch(commit *object.Commit, repo *gogit.Repository) string
• func GenerateDiff(commit *object.Commit, fileName string) string
• type GitHubActionsPrinter
  • func (p *GitHubActionsPrinter) Print(_ context.Context, r *detectors.ResultWithMetadata) error
• type JSONPrinter
  • func (p *JSONPrinter) Print(_ context.Context, r *detectors.ResultWithMetadata) error
• type LegacyJSONCompatibleSource
• type LegacyJSONOutput
• type LegacyJSONPrinter
  • func (p *LegacyJSONPrinter) Print(ctx context.Context, r *detectors.ResultWithMetadata) error
• type PlainPrinter
  • func (p *PlainPrinter) Print(_ context.Context, r *detectors.ResultWithMetadata) error

Functions

func BranchHeads

func BranchHeads(repo *gogit.Repository) (map[string]*object.Commit, error)

BranchHeads creates a map of branch names to their head commit. This can be used to find if a commit is an ancestor of a branch head.

func FindBranch

func FindBranch(commit *object.Commit, repo *gogit.Repository) string

FindBranch returns the first branch a commit is a part of. Not the most accurate, but it should work similar to pre v3.0.

func GenerateDiff

func GenerateDiff(commit *object.Commit, fileName string) string

GenerateDiff will take a commit and create a string diff between the commit and its first parent.

Types

type GitHubActionsPrinter

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

GitHubActionsPrinter is a printer that prints results in GitHub Actions format.

func (*GitHubActionsPrinter) Print

func (p *GitHubActionsPrinter) Print(_ context.Context, r *detectors.ResultWithMetadata) error

type JSONPrinter

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

JSONPrinter is a printer that prints results in JSON format.

func (*JSONPrinter) Print

func (p *JSONPrinter) Print(_ context.Context, r *detectors.ResultWithMetadata) error

type LegacyJSONCompatibleSource

type LegacyJSONCompatibleSource interface {
	GetCommit() string
	GetFile() string
}

type LegacyJSONOutput

type LegacyJSONOutput struct {
	Branch       string   `json:"branch"`
	Commit       string   `json:"commit"`
	CommitHash   string   `json:"commitHash"`
	Date         string   `json:"date"`
	Diff         string   `json:"diff"`
	Path         string   `json:"path"`
	PrintDiff    string   `json:"printDiff"`
	Reason       string   `json:"reason"`
	StringsFound []string `json:"stringsFound"`
}

type LegacyJSONPrinter

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

LegacyJSONPrinter is a printer that prints results in legacy JSON format for backwards compatibility.

func (*LegacyJSONPrinter) Print

func (p *LegacyJSONPrinter) Print(ctx context.Context, r *detectors.ResultWithMetadata) error

type PlainPrinter

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

PlainPrinter is a printer that prints results in plain text format.

func (*PlainPrinter) Print

func (p *PlainPrinter) Print(_ context.Context, r *detectors.ResultWithMetadata) error