license

Mar 31, 2023

Changes in this version

+ const BaseReleaseURL

+ const EmbeddedDataDir

+ const LatestReleaseURL

type CatalogOptions

+ Version string

type DefaultDownloaderImpl

+ func (ddi *DefaultDownloaderImpl) DownloadLicenseArchive(tag string) (zipData []byte, err error)

+ func (ddi *DefaultDownloaderImpl) GetLatestTag() (string, error)

+ func (ddi *DefaultDownloaderImpl) Version() string

type Downloader

+ func (d *Downloader) DownloadLicenseListToFile(tag, path string) (err error)

+ func (d *Downloader) GetLatestTag() (string, error)

type DownloaderImplementation

+ DownloadLicenseArchive func(tag string) (zipData []byte, err error)

+ GetLatestTag func() (string, error)

+ Version func() string

type DownloaderOptions

+ Version string

type ReaderOptions

+ LicenseListVersion string

Nov 22, 2021

Changes in this version

+ const LicenseDataURL

+ const LicenseListFilename

+ var DebianLicenseLabels = map[string]string

+ var DefaultCatalogOpts = &CatalogOptions

+ var DefaultDownloaderOpts = &DownloaderOptions

+ var DefaultReaderOptions = &ReaderOptions

+ func HasKubernetesBoilerPlate(filePath string) (bool, error)

+ type Catalog struct

+ Downloader *Downloader

+ List *List

+ func NewCatalogWithOptions(opts *CatalogOptions) (catalog *Catalog, err error)

+ func (catalog *Catalog) GetLicense(label string) *License

+ func (catalog *Catalog) LoadLicenses() error

+ func (catalog *Catalog) Options() *CatalogOptions

+ func (catalog *Catalog) WriteLicensesAsText(targetDir string) error

+ type CatalogOptions struct

+ CacheDir string

+ type ClassifyResult struct

+ File string

+ License *License

+ Text string

+ type DefaultDownloaderImpl struct

+ Options *DownloaderOptions

+ func (ddi *DefaultDownloaderImpl) GetLicenses() (licenses *List, err error)

+ func (ddi *DefaultDownloaderImpl) SetOptions(opts *DownloaderOptions)

+ type Downloader struct

+ func NewDownloader() (*Downloader, error)

+ func NewDownloaderWithOptions(opts *DownloaderOptions) (*Downloader, error)

+ func (d *Downloader) GetLicenses() (*List, error)

+ func (d *Downloader) SetImplementation(di DownloaderImplementation)

+ type DownloaderImplementation interface

+ GetLicenses func() (*List, error)

+ SetOptions func(*DownloaderOptions)

+ type DownloaderOptions struct

+ CacheDir string

+ EnableCache bool

+ func (do *DownloaderOptions) Validate() error

+ type License struct

+ IsDeprecatedLicenseID bool

+ IsFsfLibre bool

+ IsOsiApproved bool

+ LicenseID string

+ LicenseText string

+ Name string

+ SeeAlso []string

+ StandardLicenseHeader string

+ StandardLicenseHeaderTemplate string

+ StandardLicenseTemplate string

+ func ParseLicense(licenseJSON []byte) (license *License, err error)

+ func (license *License) WriteText(filePath string) error

+ type List struct

+ LicenseData []ListEntry

+ Licenses map[string]*License

+ ReleaseDateString string

+ Version string

+ func (list *List) Add(license *License)

+ type ListEntry struct

+ DetailsURL string

+ IsDeprectaed bool

+ IsOsiApproved bool

+ LicenseID string

+ Name string

+ Reference string

+ ReferenceNumber int

+ SeeAlso []string

+ type Reader struct

+ Options *ReaderOptions

+ func NewReader() (*Reader, error)

+ func NewReaderWithOptions(opts *ReaderOptions) (r *Reader, err error)

+ func (r *Reader) LicenseFromFile(filePath string) (license *License, err error)

+ func (r *Reader) LicenseFromLabel(label string) (license *License)

+ func (r *Reader) ReadLicenses(path string) (licenseList []*ClassifyResult, unknownPaths []string, err error)

+ func (r *Reader) ReadTopLicense(path string) (*ClassifyResult, error)

+ func (r *Reader) SetImplementation(i ReaderImplementation) error

+ type ReaderDefaultImpl struct

+ func (d *ReaderDefaultImpl) Catalog() *Catalog

+ func (d *ReaderDefaultImpl) Classifier() *licenseclassifier.Classifier

+ func (d *ReaderDefaultImpl) ClassifyFile(path string) (licenseTag string, moreTags []string, err error)

+ func (d *ReaderDefaultImpl) ClassifyLicenseFiles(paths []string) (licenseList []*ClassifyResult, unrecognizedPaths []string, err error)

+ func (d *ReaderDefaultImpl) FindLicenseFiles(path string) ([]string, error)

+ func (d *ReaderDefaultImpl) Initialize(opts *ReaderOptions) error

+ func (d *ReaderDefaultImpl) LicenseFromFile(path string) (license *License, err error)

+ func (d *ReaderDefaultImpl) LicenseFromLabel(label string) (license *License)

+ type ReaderImplementation interface

+ ClassifyFile func(string) (string, []string, error)

+ ClassifyLicenseFiles func([]string) ([]*ClassifyResult, []string, error)

+ FindLicenseFiles func(string) ([]string, error)

+ Initialize func(*ReaderOptions) error

+ LicenseFromFile func(string) (*License, error)

+ LicenseFromLabel func(string) *License

+ type ReaderOptions struct

+ CacheDir string

+ ConfidenceThreshold float64

+ LicenseDir string

+ WorkDir string

+ func (ro *ReaderOptions) CachePath() string

+ func (ro *ReaderOptions) LicensesPath() string

+ func (ro *ReaderOptions) Validate() error