license

Documentation

Overview

Using the GitHub API to get the license information and license text.

Reference: https://choosealicense.com/licenses

Index

• Constants
• Variables
• func GetLicenseFetchUrl() string
• func GetLicenses() (*[]License, error)
• type License
  • func (license *License) GetLicenseText() (string, error)
• type LicenseWants
  • func (l *LicenseWants) UnmarshalJSON(data []byte) error

Constants

const (
	LICENSE_LIST = "license.json"
	BASE_URL     = "https://raw.githubusercontent.com/caffeine-addictt/waku/%s/licenses/"
)

Variables

var Licenses *[]License

The global "cache" per say so we only need to hit the endpoint once per session.

Functions

func GetLicenseFetchUrl

func GetLicenseFetchUrl() string

func GetLicenses

func GetLicenses() (*[]License, error)

GetLicenses returns the list of licenses from the GitHub API or returns the cached list if it exists.

Types

type License

type License struct {
	// This is the full name of the License.
	// Example: "MIT License"
	Name string `json:"name"`

	// This is the SPDX ID of the License.
	// Example: "MIT"
	Spdx string `json:"spdx"`

	// The filename in 'licenses/'
	Filename string `json:"filename"`

	// That values the license wants
	Wants LicenseWants `json:"wants"`
}

Returned from the licenses/ directory.

func (*License) GetLicenseText

func (license *License) GetLicenseText() (string, error)

type LicenseWants

type LicenseWants []string

func (*LicenseWants) UnmarshalJSON

func (l *LicenseWants) UnmarshalJSON(data []byte) error

Will clean up license wants