scanner

Documentation

Index

• Variables
• func AskForConfig(scanResult models.ScanResultModel) (bitriseModels.BitriseDataModel, error)
• func AskForOptions(options models.OptionNode) (string, []envmanModels.EnvironmentItemModel, error)
• func Config(searchDir string, hasSSHKey bool) models.ScanResultModel
• func GenerateAndWriteResults(searchDir string, outputDir string, format output.Format) (models.ScanResultModel, error)
• func GenerateScanResult(searchDir string, hasSSHKey bool) (models.ScanResultModel, bool)
• func ManualConfig() (models.ScanResultModel, error)
• type DetectionResult
• type UnknownToolDetector

Variables

var UnknownToolDetectors = []UnknownToolDetector{
	toolDetector{/* contains filtered or unexported fields */},
	toolDetector{/* contains filtered or unexported fields */},
	toolDetector{/* contains filtered or unexported fields */},
	toolDetector{/* contains filtered or unexported fields */},
	kotlinMultiplatformDetector{},
}

UnknownToolDetectors ...

Functions

func AskForConfig

func AskForConfig(scanResult models.ScanResultModel) (bitriseModels.BitriseDataModel, error)

AskForConfig ...

func AskForOptions

func AskForOptions(options models.OptionNode) (string, []envmanModels.EnvironmentItemModel, error)

AskForOptions ...

func Config

func Config(searchDir string, hasSSHKey bool) models.ScanResultModel

Config ...

func GenerateAndWriteResults

func GenerateAndWriteResults(searchDir string, outputDir string, format output.Format) (models.ScanResultModel, error)

GenerateAndWriteResults runs the scanner and saves results to the given output dir.

func GenerateScanResult

func GenerateScanResult(searchDir string, hasSSHKey bool) (models.ScanResultModel, bool)

GenerateScanResult runs the scanner, returns the results and if any platform was detected.

func ManualConfig

func ManualConfig() (models.ScanResultModel, error)

ManualConfig ...

Types

type DetectionResult

type DetectionResult struct {
	Detected    bool
	ProjectTree string
}

DetectionResult ...

type UnknownToolDetector

type UnknownToolDetector interface {
	// ToolName is the human-readable name of a tool/framework/platform
	ToolName() string

	// DetectToolIn should search recursively in rootPath looking for the given tool
	DetectToolIn(rootPath string) (DetectionResult, error)
}

UnknownToolDetector ...