insights

Documentation

Index

• type DependencyData
• type LicenseData
• type NpmReport
  • func ProduceInsights(language string, projectPath string) (*NpmReport, error)
• type RiskyKeywordHit
• type Vulnerabilities

Types

type DependencyData

type DependencyData struct {
	Version              string                     `json:"version"`
	From                 string                     `json:"from"`
	Resolved             string                     `json:"resolved"`
	Dependencies         map[string]*DependencyData `json:"dependencies"`
	Path                 string                     `json:"path"`
	Audit                map[string]interface{}     `json:"audit"`
	LicenseAnalysis      map[string]api.Match       `json:"licenseAnalysis"`
	LicenseAnalysisError string                     `json:"licenseAnalysisError"`
	DeclaredLicenses     string                     `json:"declaredLicenses"`
	Vulnerabilities      *Vulnerabilities           `json:"Vulnerabilities"`
	ChildVulnerabilities *Vulnerabilities           `json:"childVulnerabilities"`
	LicenseData          *LicenseData               `json:"licenseData"`
	ChildLicenseData     *LicenseData               `json:"childLicenseData"`
	RiskyKeywords        []*RiskyKeywordHit         `json:"riskKeywords"`
}

DependencyData is the data structure representing a single dependency and its sub dependencies

type LicenseData

type LicenseData struct {
	Unknown              int    `json:"unknown"`
	RiskyKeywords        int    `json:"riskyKeywords"`
	LicenseCompatability int    `json:"licenseCompatability"`
	Comment              string `json:"comment"`
}

LicenseData stores data about licensing issues for a package

type NpmReport

type NpmReport struct {
	Dependencies         map[string]*DependencyData
	Version              string
	Name                 string
	Problems             []string
	Audit                map[string]interface{}
	ChildVulnerabilities *Vulnerabilities
	ChildLicenseData     *LicenseData
}

NpmReport contains information about the parent project, dependencies, npm audit and project issues

func ProduceInsights

func ProduceInsights(language string, projectPath string) (*NpmReport, error)

ProduceInsights calls the appropriate crawling function for the provided language and then reports on licensing

type RiskyKeywordHit

type RiskyKeywordHit struct {
	File       string `json:"file"`
	LineNumber string `json:"lineNumber"`
	LineText   string `json:"lineText"`
}

RiskyKeywordHit represents a successful finding of a risky keyword

type Vulnerabilities

type Vulnerabilities struct {
	High   int `json:"high"`
	Medium int `json:"medium"`
	Low    int `json:"low"`
}

Vulnerabilities stores the number of vulnerabilities a package has