autodiscovery

Documentation

Overview

Package autodiscovery implements the VCS Autodiscovery RFC.

Index

• type Project
  • func Fetch(ctx context.Context, client *http.Client, seriesPath, userAgent string) (*Project, error)
  • func (p *Project) DirURL(ref, dir string) string
  • func (p *Project) FileURL(ref, dir, file string) string
  • func (p *Project) LineURL(ref, dir, file, line string) string
  • func (p *Project) RawFileURL(ref, dir, file string) string

Types

type Project

type Project struct {
	Summary string
	Dir     string
	File    string
	RawFile string
	Line    string
}

Project facilitates linking to project source code.

func Fetch

func Fetch(ctx context.Context, client *http.Client, seriesPath, userAgent string) (*Project, error)

Fetch fetches project information for the provided module series path. It returns nil if no project information was found.

func (*Project) DirURL

func (p *Project) DirURL(ref, dir string) string

DirURL returns a URL for the given directory.

func (*Project) FileURL

func (p *Project) FileURL(ref, dir, file string) string

FileURL returns a URL for the given file.

func (*Project) LineURL

func (p *Project) LineURL(ref, dir, file, line string) string

LineURL returns a link to the provided line.

func (*Project) RawFileURL

func (p *Project) RawFileURL(ref, dir, file string) string

RawFileURL returns a URL for the raw contents of the given file.