reader

Documentation

Index

• func Read(config *Config) (ps []*packages.Package, err error)
• type Config

Functions

func Read

func Read(config *Config) (ps []*packages.Package, err error)

Read reads a project and all its packages and files.

Types

type Config

type Config struct {
	// Verbose indicates that the parse logs
	// should be written to the standard out.
	Verbose bool

	// Dir is the path to the main package or primary package.
	// The path should contain the mod file.
	// The path follows the standard patter for go tools.
	Dir string

	// Patterns is the patterns to load the packages with.
	Patterns []string

	// Context is the optional context to cancel a build with.
	Context context.Context

	// BuildFlags are the optional build flags to build with.
	// Example: // +build tag_name
	BuildFlags []string
}

Config is the read and parse configuration.