-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.go
75 lines (61 loc) · 2.44 KB
/
package.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
package importshttp
import "fmt"
// Package represents a Go package which can be imported and includes details about its repository, deprecation status,
// and useful metadata for rendering information to users.
//
// These values require more explicit configuration since this package does not perform any of the dynamic resolution
// steps of, for example, the package argument given to "go get".
type Package struct {
// Import should be a module path - the canonical name for a module. For older, non-module repos this is typically the
// repository root path. There must not be a leading or trailing slash.
Import string
// ImportSubpackage is an optional subpackage within the import. There must not be a leading or trailing slash.
//
// Typically this should be empty when configuring Package - this is mostly used when subpackage routing is enabled to
// support dynamic subpackage information.
ImportSubpackage string
// Repository provides repository details for the Import.
//
// Note that ImportSubpackage would be considered a value for the "{/dir}" attribute and Repository should not already
// be including it.
Repository Repository
// Deprecated indicates the go.mod file has the deprecated directive.
Deprecated bool
// Unlisted indicates this package should not be shown in any lists when rendering. Direct routes to this package or
// its subpackages continue to work.
Unlisted bool
// Links are a list of relevant resources for this package. The lowest-order link is considered primary and may be
// featured more prominently.
Links LinkList
// Metadata is arbitrary data intended for themes.
Metadata map[string]interface{}
}
// Path is the package path - the combination of Import and ImportSubpackage.
func (i Package) Path() string {
result := i.Import
if len(i.ImportSubpackage) > 0 {
result = fmt.Sprintf("%s/%s", result, i.ImportSubpackage)
}
return result
}
// GoImport builds the go-import spec.
func (i Package) GoImport() *GoImportSpec {
return &GoImportSpec{
Prefix: i.Import,
VCS: i.Repository.RepositoryVCS(),
RepoRoot: i.Repository.RepositoryRoot(),
}
}
// GoSource builds the go-source spec (if possible).
func (i Package) GoSource() *GoSourceSpec {
sr, ok := i.Repository.(SourceRepository)
if !ok {
return nil
}
return &GoSourceSpec{
RepoRootPrefix: i.Import,
RepoURL: sr.SourceURL(),
DirTemplate: sr.SourceDirTemplateURL(),
FileTemplate: sr.SourceFileTemplateURL(),
}
}