Documentation
¶
Overview ¶
This package represents information we need to know about libraries stored somewhere (e.g., GitHub). This is information we need to build the index.
HOWEVER, this information is not required to be provided. We will use a collection of heuristics to construct this information for any given directory. BUT, in complex cases where heuristics are not possible or library developers wish to follow a different set of conventions, they have the option of explicitly creating an 'impact.json' file to provide this information.
Note: Where information is missing (empty strings, empty arrays), an attempt should be made to infer the information. Only when it is explicitly provided should we avoid the use of heuristics to fill in the information
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Dependency ¶
type DirectoryInfo ¶
type DirectoryInfo struct {
OwnerURI string `json:"owner_uri"` // Owner of this content
Email string `json:"email"` // Email address for contact
Libraries []*LocalLibrary `json:"libraries"` // Libraries defined here
Alias map[string]string `json:"alias"` // key: library name, value: URI of library
}
func MakeDirectoryInfo ¶
func MakeDirectoryInfo() DirectoryInfo
func Parse ¶
func Parse(str string) (DirectoryInfo, error)
func (DirectoryInfo) JSON ¶
func (di DirectoryInfo) JSON() string
type LocalLibrary ¶
type LocalLibrary struct {
Name string `json:"name"` // Name of library
Path string `json:"path"` // Path to library (relative to impact.json)
IsFile bool `json:"isFile"` // If the library is stored as a single file
IssuesURL string `json:"issues_url"` // URL to issue tracker
Dependencies []Dependency `json:"dependencies"` // Dependencies of this library
}
func MakeLocalLibrary ¶
func MakeLocalLibrary() LocalLibrary
Source Files