oss/syft
2
0
Fork 0
mirror of https://github.com/anchore/syft.git synced 2025-11-17 16:33:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

chore: improve --output help text and deprecate --file (#2187)

Browse Source 
Signed-off-by: Mohammad Sharief Baig <shariefmohammad007@gmail.com>
This commit is contained in:
Mohammad Sharief Baig 2023-10-03 20:43:07 +05:30 committed by GitHub
parent 86005d1593
commit 21878784a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
cmd/syft/cli/options/output.go
View File

@ -5,6 +5,7 @@ import (
"slices" "slices"
"github.com/anchore/clio" "github.com/anchore/clio"
"github.com/anchore/fangs"
"github.com/anchore/syft/syft/formats" "github.com/anchore/syft/syft/formats"
"github.com/anchore/syft/syft/formats/table" "github.com/anchore/syft/syft/formats/table"
"github.com/anchore/syft/syft/formats/template" "github.com/anchore/syft/syft/formats/template"
@ -30,7 +31,7 @@ func DefaultOutput() MultiOutput {
func (o *MultiOutput) AddFlags(flags clio.FlagSet) { func (o *MultiOutput) AddFlags(flags clio.FlagSet) {
flags.StringArrayVarP(&o.Outputs, "output", "o", 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", flags.StringVarP(&o.OutputTemplatePath, "template", "t",
"specify the path to a Go template file") "specify the path to a Go template file")
@ -63,7 +64,7 @@ func (o *SingleOutput) SBOMWriter(file string) (sbom.Writer, error) {
return makeSBOMWriter([]string{o.Output}, file, o.OutputTemplatePath) return makeSBOMWriter([]string{o.Output}, file, o.OutputTemplatePath)
} }
// OutputFile is only the --file argument // Deprecated: OutputFile is only the --file argument
type OutputFile struct { type OutputFile struct {
File string `yaml:"file" json:"file" mapstructure:"file"` // --file, the file to write report output to File string `yaml:"file" json:"file" mapstructure:"file"` // --file, the file to write report output to
} }
@ -76,6 +77,11 @@ var _ interface {
func (o *OutputFile) AddFlags(flags clio.FlagSet) { func (o *OutputFile) AddFlags(flags clio.FlagSet) {
flags.StringVarP(&o.File, "file", "", flags.StringVarP(&o.File, "file", "",
"file to write the default report output to (default is STDOUT)") "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 { func (o *OutputFile) PostLoad() error {