notice

Documentation

Overview

Package notice provides functionality to detect license and copyright information of go modules.

Index

• Constants
• Variables
• func GetLicenseText(modpath, modversion string) (string, error)
• func WriteHtml(w io.Writer, tmpl string, n []Notice) error
• func WriteOptions(w io.Writer, o *Options) error
• func WriteText(w io.Writer, tmpl string, n []Notice) error
• type Notice
  • func New() *Notice
• type Options
  • func NewOptions() *Options
  • func ReadOptions(r io.Reader) (*Options, error)
• type Rendering
  • func ParseRendering(s string) (Rendering, error)
  • func (r Rendering) MarshalJSON() ([]byte, error)
  • func (r Rendering) String() string
  • func (r *Rendering) UnmarshalJSON(data []byte) error

Constants

const OptionsFileName string = ".gotice.json" // the default filename of the notice options file

Variables

var (
	ErrNoPath      = errors.New("environment variable GOPATH not found")
	ErrPathEmpty   = errors.New("environment variable GOPATH is empty")
	ErrModNotFound = errors.New("module not found in GOPATH")
)

var (
	RenderingName = map[uint]string{
		1: "text",
		2: "html",
	}

	RenderingValue = map[string]uint{
		"text": 1,
		"html": 2,
	}
)

var HtmlTemplate string // the built-in html template

var LicenseFiles = [...]string{
	"LICENSE",
	"LICENSE.txt",
	"LICENSE.md",
}

The possible file names of license files used to detect the license texts of go modules.

var MarkdownTemplate string // the built-in markdown template

var TextTemplate string // the built-in text template

Functions

func GetLicenseText

func GetLicenseText(modpath, modversion string) (string, error)

GetLicenseText reads the license text of the go module defined by the given module path and module version.

func WriteHtml

func WriteHtml(w io.Writer, tmpl string, n []Notice) error

WriteText generates the notice file and writes it to w using the html template tmpl.

func WriteOptions

func WriteOptions(w io.Writer, o *Options) error

WriteOptions writes the given options to the given writer w using the json format.

func WriteText

func WriteText(w io.Writer, tmpl string, n []Notice) error

WriteText generates the notice file and writes it to w using the text template tmpl.

Types

type Notice

type Notice struct {
	Path        string // The path of the module
	Version     string // The version of the module
	LicenseText string // The license text of the module
}

Notice encapsulates license and copyright information of a single go module.

func New

func New() *Notice

New returns an empty Notice.

type Options

type Options struct {
	Template  string    `json:"template"`  // the template that shall be used
	Rendering Rendering `json:"rendering"` // the rendering that shall be used`
}

Options represents options for generating a notice file.

func NewOptions

func NewOptions() *Options

NewOptions returns a new Options struct with default values.

func ReadOptions

func ReadOptions(r io.Reader) (*Options, error)

ReadOptions reads options from the reader r in the json format.

type Rendering

type Rendering int

Rendering represents the type of output rendering.

const (
	Text Rendering = iota + 1 // Rendering via text/template
	Html                      // Rendering via html/template
)

func ParseRendering

func ParseRendering(s string) (Rendering, error)

ParseRendering returns a Rendering based on the string s.

func (Rendering) MarshalJSON

func (r Rendering) MarshalJSON() ([]byte, error)

MarshalJSON returns r as the JSON encoding of r.

func (Rendering) String

func (r Rendering) String() string

String returns the string-representation.

func (*Rendering) UnmarshalJSON

func (r *Rendering) UnmarshalJSON(data []byte) error

UnmarshalJSON sets *r to a copy of data.