internal

Documentation

Index

• Variables
• func Debugf(format string, v ...any)
• func EnableDebug()
• func Infof(format string, v ...any)
• type Fetcher
  • func NewFetcher() *Fetcher
  • func NewFetcherWithClient(client HTTPClient) *Fetcher
  • func (f *Fetcher) FetchLicenses(ctx context.Context, modules Modules) <-chan License
• type GoListLoader
  • func (*GoListLoader) Load() (Modules, error)
• type GoModLoader
  • func (*GoModLoader) Load() (Modules, error)
• type HTTPClient
• type License
• type Loader
• type Module
  • func (m *Module) String() string
• type Modules
  • func (ms Modules) Filter(p func(*Module) bool) Modules
  • func (ms Modules) ForEach(f func(*Module))
  • func (ms Modules) RemoveError() Modules
  • func (ms Modules) RemoveIndirect() Modules

Variables

var (
	ErrStatusNotOK   = errors.New("status not ok")
	ErrLoadingModule = errors.New("loading module")
)

Functions

func Debugf

func Debugf(format string, v ...any)

Debugf writes debug logs.

func EnableDebug

func EnableDebug()

EnableDebug enables debug logs.

func Infof

func Infof(format string, v ...any)

Infof writes info logs.

Types

type Fetcher

type Fetcher struct {
	// contains filtered or unexported fields
}

func NewFetcher

func NewFetcher() *Fetcher

func NewFetcherWithClient

func NewFetcherWithClient(client HTTPClient) *Fetcher

func (*Fetcher) FetchLicenses

func (f *Fetcher) FetchLicenses(ctx context.Context, modules Modules) <-chan License

FetchLicenses searches the licenses of the modules from pkg.go.dev.

type GoListLoader

type GoListLoader struct{}

GoListLoader requires go list command.

func (*GoListLoader) Load

func (*GoListLoader) Load() (Modules, error)

type GoModLoader

type GoModLoader struct{}

GoModLoader requires go.mod file.

func (*GoModLoader) Load

func (*GoModLoader) Load() (Modules, error)

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type License

type License interface {
	URI() string
	Module() *Module
	Source() string
	Content() string
	Type() string
	Err() error
}

type Loader

type Loader interface {
	// Load loads and returns the Go modules.
	Load() (Modules, error)
}

type Module

type Module struct {
	Path     string // module path
	Version  string // module version
	Indirect bool   // indirect dependency?
	Error    any    // error on loading module
}

func (*Module) String

func (m *Module) String() string

type Modules

type Modules []*Module

func (Modules) Filter

func (ms Modules) Filter(p func(*Module) bool) Modules

func (Modules) ForEach

func (ms Modules) ForEach(f func(*Module))

func (Modules) RemoveError

func (ms Modules) RemoveError() Modules

func (Modules) RemoveIndirect

func (ms Modules) RemoveIndirect() Modules