scrubber

package

v0.6.1 Latest Latest Go to latest Published: Apr 29, 2026 License: GPL-3.0 Imports: 9 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type ApplyInput struct {
	Files    []string
	Registry *detector.Registry
}

ApplyInput configures a scrub apply operation.

type ApplyResult struct {
	FilesModified int
	Redactions    int
	CountsByType  map[string]int
}

ApplyResult holds the outcome of applying redactions.

func Apply(ctx context.Context, input ApplyInput) (ApplyResult, error)

Apply scrubs credential patterns from the given files, writing changes back to disk. Call Preview first to discover which files need scrubbing.

type PreviewInput struct {
	Files    []string
	Registry *detector.Registry
}

PreviewInput configures a read-only scrub preview.

type PreviewResult struct {
	FilesScanned int
	Files        []string
	Redactions   int
	CountsByType map[string]int
}

PreviewResult holds the outcome of previewing files for redactable content. Files lists the paths that contain redactable content.

func Preview(ctx context.Context, input PreviewInput) (PreviewResult, error)

Preview reads files and counts what would be redacted without writing.