javascript

Documentation

Overview

Package javascript provides a concrete Cataloger implementation for packages relating to the JavaScript language ecosystem.

Index

• func NewLockCataloger(cfg CatalogerConfig) pkg.Cataloger
• func NewPackageCataloger() pkg.Cataloger
• type CatalogerConfig
  • func DefaultCatalogerConfig() CatalogerConfig
  • func (j CatalogerConfig) WithIncludeDevDependencies(input bool) CatalogerConfig
  • func (j CatalogerConfig) WithNpmBaseURL(input string) CatalogerConfig
  • func (j CatalogerConfig) WithSearchRemoteLicenses(input bool) CatalogerConfig

Functions

func NewLockCataloger

func NewLockCataloger(cfg CatalogerConfig) pkg.Cataloger

NewLockCataloger returns a new cataloger object for NPM (and NPM-adjacent, such as yarn) lock files.

func NewPackageCataloger

func NewPackageCataloger() pkg.Cataloger

NewPackageCataloger returns a new cataloger object for NPM.

Types

type CatalogerConfig

type CatalogerConfig struct {
	SearchRemoteLicenses   bool   `json:"search-remote-licenses" yaml:"search-remote-licenses" mapstructure:"search-remote-licenses"`
	NPMBaseURL             string `json:"npm-base-url" yaml:"npm-base-url" mapstructure:"npm-base-url"`
	IncludeDevDependencies bool   `json:"include-dev-dependencies" yaml:"include-dev-dependencies" mapstructure:"include-dev-dependencies"`
}

func DefaultCatalogerConfig

func DefaultCatalogerConfig() CatalogerConfig

func (CatalogerConfig) WithIncludeDevDependencies

func (j CatalogerConfig) WithIncludeDevDependencies(input bool) CatalogerConfig

func (CatalogerConfig) WithNpmBaseURL

func (j CatalogerConfig) WithNpmBaseURL(input string) CatalogerConfig

func (CatalogerConfig) WithSearchRemoteLicenses

func (j CatalogerConfig) WithSearchRemoteLicenses(input bool) CatalogerConfig