config

Documentation

Index

• Constants
• func DisplayConfig()
• func GenerateDefaultConfigFile(filePath string) error
• func GetConfigPath() string
• func LoadConfigFromPath(configPath string) error
• func MakeConfigFile(path string)
• func ReadConfigFile(config *Configuration, path string) error
• func ReloadConfig() error
• func ReplaceConfigFile(config Configuration, path string)
• func SetConfigPath(customPath string)
• func SetupFailCriteria(failCriteria string)
• func ValidateAndFillConfig(config *Configuration) bool
• type AdvancedPerformanceConfig
• type CIConfiguration
• type Configuration
  • func GetDefaultConfiguration() Configuration
  • func GetDefaultScannerConfig() Configuration
  • func InitializeConfig(configFile string) *Configuration
  • func New() Configuration
• type FailCriteria
• type LegacyPerformanceConfig
• type PerformanceConfig
• type ScannerSpecificConfig

Constants

const (
	DefaultConfigFilename = ".jacked.yaml"
	ErrorGeneratingConfig = "Error generating default config file: "
)

Functions

func DisplayConfig

func DisplayConfig()

DisplayConfig prints the current configuration for debugging

func GenerateDefaultConfigFile

func GenerateDefaultConfigFile(filePath string) error

GenerateDefaultConfigFile creates a minimal configuration file with only implemented features

func GetConfigPath

func GetConfigPath() string

GetConfigPath returns the current configuration file path

func LoadConfigFromPath

func LoadConfigFromPath(configPath string) error

LoadConfigFromPath loads configuration from a specific file path

func MakeConfigFile

func MakeConfigFile(path string)

MakeConfigFile creates a new configuration file with default values

func ReadConfigFile

func ReadConfigFile(config *Configuration, path string) error

func ReloadConfig

func ReloadConfig() error

func ReplaceConfigFile

func ReplaceConfigFile(config Configuration, path string)

func SetConfigPath

func SetConfigPath(customPath string)

SetConfigPath allows setting a custom configuration file path

func SetupFailCriteria

func SetupFailCriteria(failCriteria string)

SetupFailCriteria configures the fail criteria for CI mode

func ValidateAndFillConfig

func ValidateAndFillConfig(config *Configuration) bool

ValidateAndFillConfig validates the configuration and fills missing fields with defaults

Types

type AdvancedPerformanceConfig

type AdvancedPerformanceConfig = PerformanceConfig

Legacy type aliases for backward compatibility

type CIConfiguration

type CIConfiguration struct {
	FailCriteria FailCriteria `yaml:"fail_criteria,omitempty"`
}

CIConfiguration for CI/CD integration

type Configuration

type Configuration struct {
	// Legacy field for backward compatibility
	MaxFileSize int `yaml:"maxFileSize,omitempty"`

	// Performance configuration - the main configuration used by the app
	Performance PerformanceConfig `yaml:"performance"`

	// CI configuration for CI/CD pipeline integration
	CI CIConfiguration `yaml:"ci,omitempty"`
}

Configuration is the unified configuration structure for all Jacked settings

var Config Configuration

func GetDefaultConfiguration

func GetDefaultConfiguration() Configuration

GetDefaultConfiguration returns a Configuration with sensible defaults

func GetDefaultScannerConfig

func GetDefaultScannerConfig() Configuration

GetDefaultScannerConfig returns the default configuration (alias for GetDefaultConfiguration)

func InitializeConfig

func InitializeConfig(configFile string) *Configuration

InitializeConfig handles all configuration setup

func New

func New() Configuration

New creates a new configuration with default values

type FailCriteria

type FailCriteria struct {
	Severity string `yaml:"severity,omitempty"` // "low", "medium", "high", "critical"
}

FailCriteria defines when CI should fail

type LegacyPerformanceConfig

type LegacyPerformanceConfig = PerformanceConfig

type PerformanceConfig

type PerformanceConfig struct {
	// Legacy fields that are actually used in the codebase
	MaxConcurrentScanners int           `yaml:"max_concurrent_scanners"`
	ScanTimeout           time.Duration `yaml:"scan_timeout,omitempty"`
	EnableCaching         bool          `yaml:"enable_caching"`
	CacheTimeout          time.Duration `yaml:"cache_timeout"`
	MaxCacheSize          int           `yaml:"max_cache_size"`
	MaxDBConnections      int           `yaml:"max_db_connections"`
	MaxIdleConnections    int           `yaml:"max_idle_connections"`
	ConnectionTimeout     time.Duration `yaml:"connection_timeout"`
	BatchSize             int           `yaml:"batch_size"`
	EnableBatchProcessing bool          `yaml:"enable_batch_processing"`

	// Experimental features for backward compatibility
	EnableExperimentalFeatures bool                             `yaml:"enable_experimental_features,omitempty"`
	Scanners                   map[string]ScannerSpecificConfig `yaml:"scanners,omitempty"`
}

PerformanceConfig controls performance optimization settings

type ScannerSpecificConfig

type ScannerSpecificConfig struct {
	Enabled        bool          `yaml:"enabled"`
	Timeout        time.Duration `yaml:"timeout"`
	MaxConcurrency int           `yaml:"max_concurrency"`
	CachingEnabled bool          `yaml:"caching_enabled"`
	Priority       int           `yaml:"priority"`
}

ScannerSpecificConfig for backward compatibility