Documentation ¶
Overview ¶
Package classifier provides the implementation of the v2 Google license classifier.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func LicenseName ¶
LicenseName produces the output name for a license, removing the internal structure of the filename in use.
Types ¶
type Classifier ¶
type Classifier struct {
// contains filtered or unexported fields
}
Classifier provides methods for identifying open source licenses in text content.
func NewClassifier ¶
func NewClassifier(threshold float64) *Classifier
NewClassifier creates a classifier with an empty corpus.
func (*Classifier) AddContent ¶
func (c *Classifier) AddContent(name, content string)
AddContent incorporates the provided textual content into the classifier for matching.
func (*Classifier) LoadLicenses ¶
func (c *Classifier) LoadLicenses(dir string) error
LoadLicenses adds the contents of the supplied directory to the corpus of the classifier.
func (*Classifier) Match ¶
func (c *Classifier) Match(in string) Matches
Match finds matches within an unknown text.
func (*Classifier) SetTraceConfiguration ¶
func (c *Classifier) SetTraceConfiguration(in *TraceConfiguration)
SetTraceConfiguration installs a tracing configuration for the classifier.
type Match ¶
type Match struct { Name string Confidence float64 MatchType string StartLine int EndLine int StartTokenIndex int EndTokenIndex int }
Match is the information about a single instance of a detected match.
type TraceConfiguration ¶
type TraceConfiguration struct { // Comma-separated list of phases to be traced. Can use * for all phases. TracePhases string // Comma-separated list of licenses to be traced. Can use * as a suffix to // match prefixes, or by itself to match all licenses. TraceLicenses string // Tracer specifies a TraceFunc used to capture tracing information. // If not supplied, emits using fmt.Printf Tracer TraceFunc // contains filtered or unexported fields }
TraceConfiguration specifies the configuration for tracing execution of the license classifier.