Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor --output help text and deprecate --file. #2187

Merged
merged 3 commits into from
Oct 3, 2023
Merged

Refactor --output help text and deprecate --file. #2187

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29cea9a
Refactor CLI help text for output option
sharief007 Oct 2, 2023
b18aa65
Mark file option as deprecated
sharief007 Oct 2, 2023
26b6f66
Refactor cli help text for output option
sharief007 Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions cmd/syft/cli/options/output.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"slices"

"github.com/anchore/clio"
"github.com/anchore/fangs"
"github.com/anchore/syft/syft/formats"
"github.com/anchore/syft/syft/formats/table"
"github.com/anchore/syft/syft/formats/template"
Expand All @@ -30,7 +31,7 @@ func DefaultOutput() MultiOutput {

func (o *MultiOutput) AddFlags(flags clio.FlagSet) {
flags.StringArrayVarP(&o.Outputs, "output", "o",
fmt.Sprintf("report output format, options=%v", formats.AllIDs()))
fmt.Sprintf("report output format (<format>=<file> to output to a file), formats=%v", formats.AllIDs()))

flags.StringVarP(&o.OutputTemplatePath, "template", "t",
"specify the path to a Go template file")
Expand Down Expand Up @@ -63,7 +64,7 @@ func (o *SingleOutput) SBOMWriter(file string) (sbom.Writer, error) {
return makeSBOMWriter([]string{o.Output}, file, o.OutputTemplatePath)
}

// OutputFile is only the --file argument
// Deprecated: OutputFile is only the --file argument
type OutputFile struct {
File string `yaml:"file" json:"file" mapstructure:"file"` // --file, the file to write report output to
}
Expand All @@ -76,6 +77,11 @@ var _ interface {
func (o *OutputFile) AddFlags(flags clio.FlagSet) {
flags.StringVarP(&o.File, "file", "",
"file to write the default report output to (default is STDOUT)")

if pfp, ok := flags.(fangs.PFlagSetProvider); ok {
flagSet := pfp.PFlagSet()
flagSet.Lookup("file").Deprecated = "use: output"
}
}

func (o *OutputFile) PostLoad() error {
Expand Down