parser

Documentation

Index

• Constants
• func FindLockFileAsByExtension(extension string) (string, error)
• func List(experimental bool) []string
• func ResolveParseTarget(path, lockfileAs string, scopes []TargetScopeType) (string, string, error)
• type Parser
  • func FindParser(lockfilePath, lockfileAs string) (Parser, error)
• type ParserConfig
• type TargetScopeType

Constants

const (
	LockfileAsBomSpdx       = customParserSpdxSBOM
	LockfileAsBomCycloneDx  = customParserCycloneDXSBOM
	LockfileAsGitHubActions = customParserGitHubActions
)

Exporting as constants for use outside this package to refer to specific parsers. For example: Github reader

Functions

func FindLockFileAsByExtension

func FindLockFileAsByExtension(extension string) (string, error)

func List

func List(experimental bool) []string

func ResolveParseTarget

func ResolveParseTarget(path, lockfileAs string, scopes []TargetScopeType) (string, string, error)

ResolveParseTarget resolves the actual path and lockfileAs based on the provided path and lockfileAs. It supports some conventions such as embedded lockfileAs in path and auto-detection of lockfileAs based on file extension

Types

type Parser

type Parser interface {
	Ecosystem() string
	Parse(lockfilePath string) (*models.PackageManifest, error)
	ParseWithConfig(lockfilePath string, config *ParserConfig) (*models.PackageManifest, error)
}

func FindParser

func FindParser(lockfilePath, lockfileAs string) (Parser, error)

type ParserConfig

type ParserConfig struct {
	// A generic config flag (not specific to npm even though the name sounds like that) to indicate
	// if the parser should include non-production dependencies as well. But this will work
	// only for supported parsers such as npm graph parser
	IncludeDevDependencies bool
}

type TargetScopeType

type TargetScopeType string

const (
	TargetScopeAll                TargetScopeType = "all"
	TargetScopeEmbeddedType       TargetScopeType = "embedded"
	TargetScopeResolveByExtension TargetScopeType = "extension"
)