Documentation
¶
Overview ¶
Package homebrew extracts package information from OSX homebrew INSTALL_RECEIPT.json files.
Index ¶
- Constants
- func New() filesystem.Extractor
- type BrewPath
- type Extractor
- func (Extractor) Ecosystem(p *extractor.Package) string
- func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
- func (e Extractor) FileRequired(api filesystem.FileAPI) bool
- func (e Extractor) Name() string
- func (e Extractor) Requirements() *plugin.Capabilities
- func (e Extractor) ToPURL(p *extractor.Package) *purl.PackageURL
- func (e Extractor) Version() int
- type Metadata
Constants ¶
const (
// Name is the unique name of this extractor.
Name = "os/homebrew"
)
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.
Types ¶
type BrewPath ¶
BrewPath struct holds homebrew package information from homebrew package path. ../${appClass}/${appName}/${version}/${appFile} e.g. ../Caskroom/firefox/1.1/firefox.wrapper.sh or ../Cellar/tree/1.1/INSTALL_RECEIPT.json
type Extractor ¶
type Extractor struct{}
Extractor extracts software details from a OSX Homebrew package path.
func (Extractor) Ecosystem ¶
Ecosystem returns no Ecosystem since the ecosystem is not known by OSV yet.
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract parses the recognised Homebrew file path and returns information about the installed package.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the specified file path matches the homebrew path.
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.