Documentation
¶
Overview ¶
Package depsjson extracts packages from .NET deps.json files.
Index ¶
- Constants
- func NewDefault() filesystem.Extractor
- type Config
- type DepsJSON
- type Extractor
- func (e Extractor) Config() Config
- 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 = "dotnet/depsjson"
)
Variables ¶
This section is empty.
Functions ¶
func NewDefault ¶ added in v0.1.7
func NewDefault() filesystem.Extractor
NewDefault returns an extractor with the default config settings.
Types ¶
type Config ¶
type Config struct { // Stats is a stats collector for reporting metrics. Stats stats.Collector // MaxFileSizeBytes is the maximum file size this extractor will unmarshal. If // `FileRequired` gets a bigger file, it will return false. MaxFileSizeBytes int64 }
Config is the configuration for the deps.json extractor.
func DefaultConfig ¶
func DefaultConfig() Config
DefaultConfig returns the default configuration for the deps.json extractor.
type DepsJSON ¶
type DepsJSON struct { // Note: Libraries does not include transitive dependencies. // Targets is not currently extracted because it introduces significant // complexity and is not always necessary for basic dependency analysis. Libraries map[string]struct { Version string `json:"version"` // Type represents the package type, if present. Examples of types include: // - "package": Indicates a standard NuGet package dependency. // - "project": Represents a project-level dependency, such as the main application or a locally developed library. Type string `json:"type"` } `json:"libraries"` }
DepsJSON represents the structure of the deps.json file.
type Extractor ¶
type Extractor struct {
// contains filtered or unexported fields
}
Extractor structure for deps.json files.
func (Extractor) Ecosystem ¶
Ecosystem returns the OSV Ecosystem of the software extracted by this extractor.
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract parses the deps.json file to extract .NET package dependencies.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the specified file matches the deps.json pattern.
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
type Metadata ¶
type Metadata struct { PackageName string // The name of the package. PackageVersion string // The version of the package. // Type indicates the type of the package. Examples include: // - "package": Represents an external dependency, such as a NuGet package. // - "project": Represents an internal dependency, such as the main application Type string }
Metadata holds parsing information for a deps.json package.