analyzers

Documentation

Overview

Package analyzers defines analyzers for various package types.

Index

• Variables
• type Analyzer
  • func New(key pkg.Type, options map[string]interface{}) (Analyzer, error)

Variables

var (
	ErrUnknownPackageType     = errors.New("could not find analyzer for package type")
	ErrAnalyzerNotImplemented = errors.New("analyzer is not implemented for package type")
)

Errors that occur when loading analyzers.

Types

type Analyzer

type Analyzer interface {
	Discover(dir string) ([]module.Module, error) // Finds modules in a given directory.

	// These methods all make best-effort attempts.
	Clean(config module.Module) error           // Cleans build artifacts.
	Build(config module.Module) error           // Builds the module.
	IsBuilt(config module.Module) (bool, error) // Checks whether a module has been built.

	Analyze(config module.Module) (module.Module, error) // Runs an analysis of a module.
}

An Analyzer is an implementation of functionality for different build systems.

func New

func New(key pkg.Type, options map[string]interface{}) (Analyzer, error)

New returns the analyzer for any given package type.