licrep

Documentation

Index

• Constants
• func Cli(opts appkit.Options, argsin []string) error
• func GenerateEmbeddedLicenses(opts appkit.Options, pkgs []Package) error
• type Package
  • func FilterPackages(opts appkit.Options, pkgs []Package) (ret []Package)
  • func GetPackages(pkgname string, dir string) (ret []Package, err error)

Constants

const (
	// UnknownLicense denotes the value of License of a Package for which
	// the license is not detected.
	UnknownLicense = "Unknown"
)

Functions

func Cli

func Cli(opts appkit.Options, argsin []string) error

Cli parses the command line interface

func GenerateEmbeddedLicenses

func GenerateEmbeddedLicenses(opts appkit.Options, pkgs []Package) error

GenerateEmbeddedLicenses creates a compressed license representation to a file or os.Stdout of the given Packages. The representation is go so it can be built as part of a program.

Types

type Package

type Package struct {
	Name          string
	ImportPath    string
	Dir           string
	License       string
	LicenseString string
}

Package reprsents an imported package

func FilterPackages

func FilterPackages(opts appkit.Options, pkgs []Package) (ret []Package)

FilterPackages filters out the ignored packages from the list

func GetPackages

func GetPackages(pkgname string, dir string) (ret []Package, err error)

GetPackages gets the dependencies of given pkgname in the given directory