Documentation
¶
Overview ¶
Package gomod extracts go.mod files.
Index ¶
Constants ¶
const (
// Name is the unique name of this extractor.
Name = "go/gomod"
)
Variables ¶
This section is empty.
Functions ¶
func New ¶ added in v0.1.7
func New() filesystem.Extractor
New returns a new instance of the extractor with the default configuration.
func NewWithConfig ¶ added in v0.3.0
func NewWithConfig(cfg Config) filesystem.Extractor
NewWithConfig returns a new instance of the extractor with the given configuration.
Types ¶
type Config ¶ added in v0.3.0
type Config struct {
ExcludeIndirect bool
}
Config is the configuration for the Extractor.
func DefaultConfig ¶ added in v0.3.0
func DefaultConfig() Config
DefaultConfig returns a default configuration for the extractor.
type Extractor ¶
type Extractor struct {
// contains filtered or unexported fields
}
Extractor extracts go packages from a go.mod file, including the stdlib version by using the top level go version
The output is not sorted and will not be in a consistent order
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract extracts packages from a go.mod file passed through the scan input.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the specified file matches go.mod files.
go.sum is not considered since the 'go.mod' file is necessary to determine the Go version before opening it.
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
Source Files