copyright

type Action func(path string, info os.FileInfo, file, notice []byte) error

type Config struct {
	// NoticeBodyTemplate is the notice body template that will be processed and
	// injected to the relevant extension specific notice template.
	NoticeBodyTemplate string `yaml:"noticeBodyTemplate"`
	// Year is the year to insert into the templates as `{{ .Year }}`
	Year int `yaml:"year"`
	// Company is the company name to insert into the templates as `{{ .Company }}`
	Company string `yaml:"company"`
	// License is the open source license to insert into in templates as `{{ .License }}`
	License string `yaml:"openSourceLicense"`

	// Restrictions an optional template to clarify copyright restrictions or
	// visibility modifiers, which is available in the `NoticeBodyTemplate` as `{{ .Restrictions }}`
	Restrictions string `yaml:"restrictionTemplate"`

	// Excludes are a list of globs to exclude, they can
	// match both files and directories.
	// This can be populated with `.gitignore` and the like.
	Excludes []string `yaml:"excludes"`
	// IncludeFiles are a list of globs to match files to include.
	IncludeFiles []string `yaml:"includeFiles"`

	// ExtensionNoticeTemplates is a map between file extension (including dot prefix)
	// to the relevant full notice template for the file. It can include a template variable
	// {{ .Notice }} that will insert the compiled `NoticyBodyTemplate`.
	ExtensionNoticeTemplates map[string]string

	// FallbackNoticeTemplate is a full notice template that will be used if there is no extension
	// specific notice template.
	// It can include the template variable {{ .Notice }} that will instert the compiled `NoticeBodyTemplate`.
	FallbackNoticeTemplate string

	// ExitFirst indicates if we should return after the first failure.
	ExitFirst *bool `yaml:"exitFirst"`
	// Quiet controls whether output is suppressed.
	Quiet *bool `yaml:"quiet"`
	// Verbose controls whether verbose output is shown.
	Verbose *bool `yaml:"verbose"`
	// Debug controls whether debug output is shown.
	Debug *bool `yaml:"debug"`

	// ShowDiff shows shows the diffs on verification failues.
	ShowDiff *bool `yaml:"verifyDiff"`
}

type Copyright struct {
	Config // Config holds the configuration opitons.

	// Stdout is the writer for Verbose and Debug output.
	// If it is unset, `os.Stdout` will be used.
	Stdout io.Writer
	// Stderr is the writer for Error output.
	// If it is unset, `os.Stderr` will be used.
	Stderr io.Writer
}

type Option func(*Copyright)