config

Documentation

Index

• Constants
• Variables
• type Config
  • func GetInstance() *Config
  • func (c *Config) GetApiToken() string
  • func (c *Config) GetApiUrl() string
  • func (c *Config) GetDefaultConfigFolder() string
  • func (c *Config) GetResultFilePath() string
  • func (c *Config) GetScanRoot() string
  • func (c *Config) GetScanSettingsFilePath() string
  • func (c *Config) InitializeConfig(cfgFile, scanRoot, apiKey, apiUrl, inputFile, scanossSettingsFilePath string, ...) error
  • func (c *Config) RegisterListener(listener func(*Config))
  • func (c *Config) SetApiToken(token string) error
  • func (c *Config) SetApiUrl(url string) error
  • func (c *Config) SetResultFilePath(path string)
  • func (c *Config) SetScanRoot(path string)
  • func (c *Config) SetScanSettingsFilePath(path string)

Constants

const (
	DEFAULT_API_URL               = "https://api.osskb.org"
	DEFAULT_RESULTS_FILE          = "results.json"
	DEFAULT_SCANOSS_SETTINGS_FILE = "scanoss.json"
	DEFAULT_CONFIG_FILE_NAME      = "scanoss-cc-settings"
	DEFAULT_CONFIG_FILE_TYPE      = "json"
	ROOT_FOLDER                   = "."
	SCANOSS_HIDDEN_FOLDER         = ".scanoss"
	SCANOSS_PREMIUM_API_URL       = "https://api.scanoss.com"
)

Variables

var (
	ErrReadingFile       = errors.New("error reading file")
	ErrUnmarshallingFile = errors.New("error unmarshalling file")
)

Types

type Config

type Config struct {
	ApiToken             string `json:"apitoken"`
	ApiUrl               string `json:"apiurl"`
	ResultFilePath       string `json:"resultfilepath,omitempty"`
	ScanRoot             string `json:"scanroot,omitempty"`
	ScanSettingsFilePath string `json:"scansettingsfilepath,omitempty"`
	Debug                bool   `json:"debug,omitempty"`
	// contains filtered or unexported fields
}

func GetInstance

func GetInstance() *Config

func (*Config) GetApiToken

func (c *Config) GetApiToken() string

func (*Config) GetApiUrl

func (c *Config) GetApiUrl() string

func (*Config) GetDefaultConfigFolder

func (c *Config) GetDefaultConfigFolder() string

func (*Config) GetResultFilePath

func (c *Config) GetResultFilePath() string

func (*Config) GetScanRoot

func (c *Config) GetScanRoot() string

func (*Config) GetScanSettingsFilePath

func (c *Config) GetScanSettingsFilePath() string

func (*Config) InitializeConfig

func (c *Config) InitializeConfig(cfgFile, scanRoot, apiKey, apiUrl, inputFile, scanossSettingsFilePath string, originalWorkDir string, debug bool) error

func (*Config) RegisterListener

func (c *Config) RegisterListener(listener func(*Config))

func (*Config) SetApiToken

func (c *Config) SetApiToken(token string) error

func (*Config) SetApiUrl

func (c *Config) SetApiUrl(url string) error

func (*Config) SetResultFilePath

func (c *Config) SetResultFilePath(path string)

func (*Config) SetScanRoot

func (c *Config) SetScanRoot(path string)

func (*Config) SetScanSettingsFilePath

func (c *Config) SetScanSettingsFilePath(path string)