handler

package

v0.0.0-...-b258b5d Latest Latest Go to latest Published: Jul 14, 2021 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	ErrReadConfigFile  = fmt.Errorf("failed to read rules config file")
	ErrParseConfigFile = fmt.Errorf("failed to parse rules config file")
)

custom errors.

This section is empty.

type Handler struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Handler struct.

func New(opt ...Option) *Handler

New handler struct.

func (h *Handler) GetImportRules() error

GetImportRules loads config file (import path mapping rules)

func (h *Handler) ReloadRules(w http.ResponseWriter, r *http.Request)

ReloadRules is the handler that reloads mapping rules from config.

func (h *Handler) VanityServer(w http.ResponseWriter, r *http.Request)

VanityServer redirects browsers to godoc or go tool to VCS repository.

type Option func(*Options)

Option type

func WithConfigFile(configFile string) Option

WithConfigFile sets the config file path.

func WithGodocURL(godocURL string) Option

WithGodocURL sets the redirect URL for godoc.

type Options struct {
	ConfigFile   string
	GodocURL     string
	MappingRules []Rules
}

Options struct

func NewOptions(options ...Option) Options

NewOptions returns a new set of options for the http handler.

type Rules struct {
	ImportRoot string `json:"importroot"`
	VCS        string `json:"vcs"`
	RepoRoot   string `json:"reporoot"`
}

Rules for mapping go-import.