package
0.3.2
Repository: https://github.com/serulian/compiler.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# Functions

DetectHandler attempts to detect which VCS handler is applicable to the given checkout directory.
DiscoverVCSInformation attempts to download the given URL, find the discovery <meta> tag, and return the VCSUrlInformation found.
GetHandlerByKind returns the VCS handler for the given VCS kind, if any.
GetVCSCheckoutDirectory returns the path of the directory into which the given VCS path will checked out, if PerformVCSCheckout is called.
IsVCSRootDirectory returns true if the given local file system path is a VCS root directory.
ParseVCSPath parses a path/url to a VCS package into its components.
PerformVCSCheckout performs the checkout and updating of the given VCS path and returns the local system directory at which the package was checked out.
PerformVCSCheckoutAndInspect performs the checkout and updating of the given VCS path and returns the commit SHA of the package, as well as its tags.

# Constants

BranchOrHEADPackage indicates that the package is a branch or head package, and will therefore be updated on every call.
CachedPackage indicates that the package was returned from cache without further operation.
DetachedPackage indicates that the package is detatched from a branch and therefore is static.
DevelopmentPackage indicates that the package was found in the VCS development directory and was therefore loaded from that location.
LocallyModifiedPackage indicates that the package was modified on the local file system, and therefore cannot be updated.
VCSAlwaysUseCache indicates that VCS checkouts will always use the cache if available.
VCSFollowNormalCacheRules indicates that VCS checkouts will be pulled from cache unless a HEAD reference.

# Structs

InspectInfo holds all the data returned from a call to PerformVCSCheckoutAndInspect.
VCSCheckoutResult is the result of a VCS checkout, if it succeeds.
VCSUrlInformation holds information about a VCS source URL.

# Interfaces

VCSHandler defines a handler for working with a VCS package.

# Type aliases

VCSCacheOption defines the caching options for VCS checkout.
VCSPackageStatus is the status of the VCS package checked out.