config

Documentation

Overview

The config package offers methods for consistently loading settings from files and command line flags.

Index

• func ParseFlags(flagSet *flag.FlagSet, args []string, raw *Raw) error
• func ParseYAML(r io.Reader, raw *Raw) error
• type Raw
  • func (d Raw) Resolve() (*Resolved, error)
• type RawLink
• type RawLinkList
  • func (dll RawLinkList) AsLinkList() importshttp.LinkList
• type RawPackage
• type RawPackageList
  • func (dpl RawPackageList) AsPackageList(factory importshttp.RepositoryFactory) (importshttp.PackageList, error)
• type RawPackageRepository
  • func (s *RawPackageRepository) UnmarshalYAML(unmarshal func(interface{}) error) error
• type RawServer
• type RawSite
  • func (ds RawSite) AsSite() importshttp.Site
• type RawTheme
  • func (s *RawTheme) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Resolved
  • func (rd *Resolved) Handler() http.Handler
  • func (rd *Resolved) PackageList() importshttp.PackageList
  • func (rd *Resolved) Site() importshttp.Site
  • func (rd *Resolved) Theme() importshttp.Theme

Functions

func ParseFlags

func ParseFlags(flagSet *flag.FlagSet, args []string, raw *Raw) error

ParseFlags supports extracting basic configuration from command line options. For full configuration use a YAML file.

func ParseYAML

func ParseYAML(r io.Reader, raw *Raw) error

ParseYAML supports extracting configuration from YAML using the following schema. All fields are optional unless noted.

# configuration when running a server
server:

	# bind specification for the server (format: {address}:{port})
	bind:

# settings which apply to all pages on the site
site:

	# base url for building absolute urls
	url:

	# title to show on the index page
	title:

	# value to embed in html meta tags
	generator:

	# value to embed in html for the language of apges
	content_language:

	# list of informational links (default theme renders these in a footer)
	links:
	-
		# used to reprioritize links (type: integer)
		ordering:

		# text used when showing the link
		label:

		# web address used for the link
		url:

	# arbitrary data
	metadata: {}

# use the default theme
theme: true

# or: use the minimal theme
theme: false

# or: use a custom theme from local files
theme:

	# path to the template used for error pages (required)
	error_template:

	# path to the template used for a single package (required)
	package_template:

	# path to the template used for listing packages (required)
	package_list_template:

	# path to a directory with static assets
	files_dir:

	# theme version tag to include in file URL query strings for cache-busting
	version:

# list of packages to publish
packages:
-
	# the Go package import path (required)
	import:

	# a subdirectory within the import for the full package path, if needed; typically empty
	import_subpackage:

	# URL to a common repository root for the package source
	repository:

	# indicate the package is deprecated (type: boolean)
	deprecated:

	# hide the package in listings (type: boolean)
	unlisted:

	# or: object with config describing a supported repository root for the package
	repository:

		# supported service name (values: bitbucket, bzr, fossil, git, github, gitlab, hg, mod, svn; required)
		vcs:

		# service-specific keys for configuring the repository (required)
		*:

	# list of potential action links for the package
	links:
	-
		# used to reprioritize links (type: integer)
		ordering:

		# text used when showing the link
		label:

		# web address used for the link
		url:

	# arbitrary data (default theme shows a plan text `description`, if present)
	metadata: {}

# customization of built-in link generators
package_links:

	# customize godoc links
	godoc:

		# base url for the godoc server
		base_url:

		# ordering for links (type: integer)
		ordering:

	# or: disable godoc links
	godoc: false

	# customize source links
	source:

		# ordering for links (type: integer)
		ordering:

	# or: disable source links
	source: false

Types

type Raw

type Raw struct {
	RepositoryFactory importshttp.RepositoryFactory `yaml:"-"`
	Linkers           importshttp.LinkerList        `yaml:"-"` // TODO customizable

	Server   RawServer      `yaml:"server"`
	Site     RawSite        `yaml:"site"`
	Theme    RawTheme       `yaml:"theme"`
	Packages RawPackageList `yaml:"packages"`
}

func (Raw) Resolve

func (d Raw) Resolve() (*Resolved, error)

type RawLink

type RawLink struct {
	Ordering int    `yaml:"ordering"`
	Label    string `yaml:"label"`
	URL      string `yaml:"url"`
}

type RawLinkList

type RawLinkList []RawLink

func (RawLinkList) AsLinkList

func (dll RawLinkList) AsLinkList() importshttp.LinkList

type RawPackage

type RawPackage struct {
	Import           string                 `yaml:"import"`
	ImportSubpackage string                 `yaml:"import_subpackage"`
	Repository       RawPackageRepository   `yaml:"repository"`
	Deprecated       bool                   `yaml:"deprecated"`
	Unlisted         bool                   `yaml:"unlisted"`
	Metadata         map[string]interface{} `yaml:"metadata"`
	Links            RawLinkList            `yaml:"links"`
}

type RawPackageList

type RawPackageList []RawPackage

func (RawPackageList) AsPackageList

func (dpl RawPackageList) AsPackageList(factory importshttp.RepositoryFactory) (importshttp.PackageList, error)

type RawPackageRepository

type RawPackageRepository struct {
	importshttp.RepositoryConfig
}

func (*RawPackageRepository) UnmarshalYAML

func (s *RawPackageRepository) UnmarshalYAML(unmarshal func(interface{}) error) error

type RawServer

type RawServer struct {
	Bind string `yaml:"bind"`
}

type RawSite

type RawSite struct {
	URL             string                 `yaml:"url"`
	Title           string                 `yaml:"title"`
	Generator       string                 `yaml:"generator"`
	ContentLanguage string                 `yaml:"content_language"`
	Links           RawLinkList            `yaml:"links"`
	Metadata        map[string]interface{} `yaml:"metadata"`
}

func (RawSite) AsSite

func (ds RawSite) AsSite() importshttp.Site

type RawTheme

type RawTheme struct {
	importshttp.Theme
}

func (*RawTheme) UnmarshalYAML

func (s *RawTheme) UnmarshalYAML(unmarshal func(interface{}) error) error

type Resolved

type Resolved struct {
	// contains filtered or unexported fields
}

func (*Resolved) Handler

func (rd *Resolved) Handler() http.Handler

func (*Resolved) PackageList

func (rd *Resolved) PackageList() importshttp.PackageList

func (*Resolved) Site

func (rd *Resolved) Site() importshttp.Site

func (*Resolved) Theme

func (rd *Resolved) Theme() importshttp.Theme