npm

Documentation

Index

• type Generator
  • func (g *Generator) Configure() error
  • func (g *Generator) GenerateBOM(path string) (*cyclonedx.BOM, error)

Types

type Generator

type Generator struct {
	gobom.BaseGenerator

	NpmDevDependencies bool           `gobom:"set to true to include devDependencies"`
	NpmExcludes        *regexp.Regexp `gobom:"regexp of paths to exclude"`
}

Generator generates BOMs for npm projects

func (*Generator) Configure

func (g *Generator) Configure() error

Configure sets the options for this Generator

func (*Generator) GenerateBOM

func (g *Generator) GenerateBOM(path string) (*cyclonedx.BOM, error)

GenerateBOM returns a CycloneDX BOM for the specified package path