autodiscovery

package

v0.0.0-...-55358d4 Latest Latest Go to latest Published: Jan 24, 2024 License: BSD-3-Clause Imports: 6 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

Package autodiscovery implements the VCS Autodiscovery RFC.

This section is empty.

This section is empty.

This section is empty.

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

Project facilitates linking to project source code.

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 (p *Project) DirURL(ref, dir string) string

DirURL returns a URL for the given directory.

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

FileURL returns a URL for the given file.

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

LineURL returns a link to the provided line.

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

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