report

package
v1.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BaseDir

func BaseDir() string

BaseDir returns the directory where JSON reports are written. Each save creates a fresh timestamped file so the user can diff or archive reports across runs.

func PrintSummary

func PrintSummary(result *types.ScanResult, cleaned *types.CleanResult)

PrintSummary writes a human-readable summary to stdout. Used by the `report` CLI after Save so users get immediate feedback without opening the JSON file.

func Save

func Save(result *types.ScanResult, cleaned *types.CleanResult) (string, error)

Save writes a JSON report of the scan (and optional clean) to disk and returns the resulting file path. The human-readable summary that the `report` CLI prints after this is a separate call to PrintSummary — kept out of Save so library callers (e.g. the TUI) can persist the file silently.

func SaveTo added in v1.7.0

func SaveTo(path string, result *types.ScanResult, cleaned *types.CleanResult) error

SaveTo writes a JSON report to an explicit file path. The directory must already exist. Writes atomically via a temp file + rename.

Types

This section is empty.

Jump to

Keyboard shortcuts

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