config

Documentation

Index

• Constants
• Variables
• func AppNameVersion() string
• func DefaultLogPath() string
• func UserAppHome() string
• type ArtifactConfig
  • func (cfg *ArtifactConfig) IgnoreDirsSet() *pattern_set.PatternSet
  • func (cfg *ArtifactConfig) InitIgnoreDirs()
• type AssemblyConfig
• type ConvertConfig
• type GenerateConfig
• type LogConfig
  • func NewLogConfig() *LogConfig
• type ModifyConfig
• type PackageConfig
  • func (cfg *PackageConfig) IgnoreDirsSet() *pattern_set.PatternSet
  • func (cfg *PackageConfig) InitIgnoreDirs()
• type SourceConfig
  • func (cfg *SourceConfig) IgnoreDirsSet() *pattern_set.PatternSet
  • func (cfg *SourceConfig) InitIgnoreDirs()
• type ValidateConfig

Constants

const APPDESC = "CLI tool for generating SBOM"

const APPNAME = "sbom-tool"

APPNAME is the name of the application

const DefaultParallelism = 8

DefaultParallelism is the default value of parallelism

Variables

var VERSION = "(dev)"

VERSION is the version of the application

Functions

func AppNameVersion

func AppNameVersion() string

func DefaultLogPath

func DefaultLogPath() string

DefaultLogPath returns the default log path

func UserAppHome

func UserAppHome() string

UserAppHome returns the home directory of the application

Types

type ArtifactConfig

type ArtifactConfig struct {
	Parallelism     int
	PackageName     string
	PackageVersion  string
	PackageSupplier string
	DistPath        string
	Output          string
	ExtractFiles    bool
	IgnoreDirs      string
	// contains filtered or unexported fields
}

ArtifactConfig is the configuration for artifact subcommand

func (*ArtifactConfig) IgnoreDirsSet

func (cfg *ArtifactConfig) IgnoreDirsSet() *pattern_set.PatternSet

IgnoreDirsSet returns the ignoreDirsSet

func (*ArtifactConfig) InitIgnoreDirs

func (cfg *ArtifactConfig) InitIgnoreDirs()

InitIgnoreDirs initializes the ignoreDirsSet

type AssemblyConfig

type AssemblyConfig struct {
	Path         string
	Format       string
	Output       string
	NamespaceURI string
}

AssemblyConfig is the configuration for assembly subcommand

type ConvertConfig

type ConvertConfig struct {
	Input    string
	Original string
	Format   string
	Output   string
}

ConvertConfig is the configuration for convert subcommand

type GenerateConfig

type GenerateConfig struct {
	SourceConfig
	PackageConfig
	ArtifactConfig
	AssemblyConfig
	NamespaceURI string
	IgnoreSrc    string
	IgnoreDist   string
	IgnorePkg    string
	SkipPhases   string
	Path         string
	Parallelism  int
	Output       string
}

GenerateConfig is the configuration for generate subcommand

type LogConfig

type LogConfig struct {
	LogPath  string
	LogLevel string
	Quiet    bool
}

LogConfig is the configuration for logging

func NewLogConfig

func NewLogConfig() *LogConfig

NewLogConfig returns a new LogConfig

type ModifyConfig

type ModifyConfig struct {
	Input  string
	Format string
	Output string
	Update map[string]*[]string
}

ModifyConfig is the configuration for modify subcommand

type PackageConfig

type PackageConfig struct {
	Parallelism int
	Collectors  string
	Path        string
	Output      string
	IgnoreDirs  string
	// contains filtered or unexported fields
}

PackageConfig is the configuration for package subcommand

func (*PackageConfig) IgnoreDirsSet

func (cfg *PackageConfig) IgnoreDirsSet() *pattern_set.PatternSet

IgnoreDirsSet returns the ignoreDirsSet

func (*PackageConfig) InitIgnoreDirs

func (cfg *PackageConfig) InitIgnoreDirs()

InitIgnoreDirs initializes the ignoreDirsSet

type SourceConfig

type SourceConfig struct {
	Path        string
	Parallelism int
	SrcPath     string
	Output      string
	Mode        string
	Language    string
	IgnoreDirs  string
	// contains filtered or unexported fields
}

SourceConfig is the configuration for source subcommand

func (*SourceConfig) IgnoreDirsSet

func (cfg *SourceConfig) IgnoreDirsSet() *pattern_set.PatternSet

IgnoreDirsSet returns the ignoreDirsSet

func (*SourceConfig) InitIgnoreDirs

func (cfg *SourceConfig) InitIgnoreDirs()

InitIgnoreDirs initializes the ignoreDirsSet

type ValidateConfig

type ValidateConfig struct {
	Input  string
	Format string
	Output string
}

ValidateConfig is the configuration for validate subcommand