Documentation ¶
Overview ¶
Package module defines a FOSSA CLI module.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Hashes ¶ added in v0.6.3
Hashes contains hexadecimal checksums of code libraries brought in by running a Build.
type Module ¶
type Module struct { Name string `yaml:"name"` // Uniquely identifies the module. Type pkg.Type `yaml:"type"` // Type of the root package, used to select the module's analyzer. IsExecutable bool `yaml:"-"` // Used for filtering discovered projects. BuildTarget string `yaml:"target,omitempty"` // Exact build target in the semantics of the module's analyzers. Dir string `yaml:"cwd,omitempty"` // CWD to analyze the module from. Options map[string]interface{} `yaml:"options,omitempty"` // Analyzer option struct of the module type. Context interface{} `yaml:"-"` // Extra metadata set by analyzers. Imports []pkg.Import `yaml:"-"` // Direct dependencies of the root package. Deps map[pkg.ID]pkg.Package `yaml:"-"` // All transitive dependencies of the root package (including Imports). }
A Module is a single compilable unit of code (e.g. an entrypoint) to analyze. Modules consist of a root Package, and the transitive dependencies of that package.
func (*Module) IsAnalyzed ¶ added in v0.7.0
IsAnalyzed returns true if a module has already been analyzed, and false otherwise.
Click to show internal directories.
Click to hide internal directories.