output

type GitHubActionsPrinter ¶ added in v3.46.0

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

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

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

type JSONPrinter ¶ added in v3.46.0

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

JSONPrinter is a printer that prints results in JSON format.

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 ¶ added in v3.46.0

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

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

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

type PlainPrinter ¶ added in v3.46.0

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

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

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

type SarifPrinter ¶ added in v3.97.0

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

SarifPrinter is a printer that accumulates results and, once the scan completes, emits them as a single SARIF 2.1.0 log. Unlike the other Printer implementations, SARIF results cannot be streamed one-per-line: the spec requires one JSON document containing every run and result, so Print only buffers results and Flush performs the actual marshal/write.

TODO: results are held in memory for the full scan and Flush marshals them in one pass, so peak memory grows with result count (roughly 2x at Flush, for the struct plus its marshaled JSON). Fine for typical scan sizes; if scans with very large result counts start OOMing, switch to writing results to the underlying writer incrementally as they're produced in Print.

func (p *SarifPrinter) Flush(w io.Writer) error

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