api

Documentation

Index

• Variables
• func GetLanguageAliases() map[string]source.Type
• type ErrorCode
• type InitialQuery
  • func NewInitialQuery(input UserInput) (InitialQuery, error)
• type Investigation
  • func NewInvestigation(query InitialQuery) *Investigation
  • func (i *Investigation) Do() error
  • func (i Investigation) IsSufficient() bool
• type Link
• type Result
  • func CreateResult(inv *Investigation) Result
  • func (r Result) GetDocumentation() *url.URL
  • func (r Result) GetDocumentationLink() *Link
  • func (r Result) GetHomepage() *url.URL
  • func (r Result) GetHomepageLink() *Link
  • func (r Result) GetRegistry() *url.URL
  • func (r Result) GetRegistryLink() *Link
  • func (r Result) GetRepository() *url.URL
  • func (r Result) GetRepositoryLink() *Link
• type UserInput

Variables

var (
	Version       = "0.0.21"
	VersionCommit = ""
)

Version and VersionCommit hold the version information

Functions

func GetLanguageAliases

func GetLanguageAliases() map[string]source.Type

GetLanguageAliases returns a map of language aliases to their documentation source types

Types

type ErrorCode

type ErrorCode string

const (
	ErrInvalidPackagePath ErrorCode = "InvalidPackagePath"
)

type InitialQuery

type InitialQuery struct {
	SourceRef source.Reference

	// ForceUpdate determines whether to forcibly update by ignoring the cache
	ForceUpdate bool
}

InitialQuery is a structure that represents the initial query created from user input

func NewInitialQuery

func NewInitialQuery(input UserInput) (InitialQuery, error)

NewInitialQuery creates an initial query from user input

type Investigation

type Investigation struct {
	// Query is the initial query
	Query InitialQuery

	// CollectedData is data collected from each source
	CollectedData map[source.Type]source.Data
}

Investigation is a structure that represents data under investigation

func NewInvestigation

func NewInvestigation(query InitialQuery) *Investigation

NewInvestigation creates a new investigation

func (*Investigation) Do

func (i *Investigation) Do() error

func (Investigation) IsSufficient

func (i Investigation) IsSufficient() bool

type Link

type Link struct {
	Type source.Type
	URL  *url.URL
}

type Result

type Result struct {
	README string

	InitialQueryURL  *url.URL
	InitialQueryType source.Type
	Links            []Link
}

Result is a structure that represents the investigation result

func CreateResult

func CreateResult(inv *Investigation) Result

CreateResult generates a result from investigation data

func (Result) GetDocumentation

func (r Result) GetDocumentation() *url.URL

func (Result) GetDocumentationLink

func (r Result) GetDocumentationLink() *Link

func (Result) GetHomepage

func (r Result) GetHomepage() *url.URL

func (Result) GetHomepageLink

func (r Result) GetHomepageLink() *Link

func (Result) GetRegistry

func (r Result) GetRegistry() *url.URL

func (Result) GetRegistryLink

func (r Result) GetRegistryLink() *Link

func (Result) GetRepository

func (r Result) GetRepository() *url.URL

func (Result) GetRepositoryLink

func (r Result) GetRepositoryLink() *Link

type UserInput

type UserInput struct {
	// PackagePath is the path of the package
	PackagePath string
	// Language is the explicitly specified language
	Language string
	// ForceUpdate determines whether to forcibly update by ignoring the cache
	ForceUpdate bool
}

UserInput is a structure that represents input from the user