Documentation ¶
Index ¶
Constants ¶
const Filename = "manifest.toml"
Variables ¶
This section is empty.
Functions ¶
func CurrentSDKMajor ¶ added in v2.4.0
func CurrentSDKMajor() int
CurrentSDKMajor returns a major version of this SDK package.
func SDKVersion ¶ added in v2.4.0
SDKVersion detects a Babelfish SDK version of a driver. Returned format is "x[.y[.z]]".
Types ¶
type DevelopmentStatus ¶
type DevelopmentStatus string
const ( Planning DevelopmentStatus = "planning" PreAlpha DevelopmentStatus = "pre-alpha" Alpha DevelopmentStatus = "alpha" Beta DevelopmentStatus = "beta" Stable DevelopmentStatus = "stable" Mature DevelopmentStatus = "mature" Inactive DevelopmentStatus = "inactive" )
func (DevelopmentStatus) Rank ¶
func (s DevelopmentStatus) Rank() int
Rank is an integer indicating driver stability. Higher is better.
type Documentation ¶ added in v2.4.0
type Feature ¶
type Feature string
Feature describes which level of information driver can produce.
const ( // AST is a basic feature required for the driver. Driver can parse files and return native language AST. AST Feature = "ast" // UAST feature indicates that driver properly converts AST to UAST without further annotating it. UAST Feature = "uast" // Roles feature indicates that driver annotates UAST with roles. All node types are annotated. Roles Feature = "roles" )
type InformationLoss ¶
type InformationLoss string
InformationLoss in terms of which kind of code generation would they allow.
const ( // Lossless no information loss converting code to AST and then back to code // would. code == codegen(AST(code)). Lossless InformationLoss = "lossless" // FormatingLoss only superfluous formatting information is lost (e.g. // whitespace, indentation). Code generated from the AST could be the same // as the original code after passing a code formatter. // fmt(code) == codegen(AST(code)). FormatingLoss InformationLoss = "formating-loss" // SyntacticSugarLoss there is information loss about syntactic sugar. Code // generated from the AST could be the same as the original code after // desugaring it. desugar(code) == codegen(AST(code)). SyntacticSugarLoss InformationLoss = "syntactic-sugar-loss" // CommentLoss comments are not present in the AST. CommentLoss InformationLoss = "formating-loss" )
type Maintainer ¶ added in v2.4.0
type Maintainer struct { Name string `json:",omitempty"` Email string `json:",omitempty"` Github string `json:",omitempty"` // github handle }
Maintainer is an information about project maintainer.
func Maintainers ¶ added in v2.4.0
func Maintainers(open OpenFunc) ([]Maintainer, error)
Maintainers reads and parses the MAINTAINERS file using the provided function.
func (Maintainer) GithubURL ¶ added in v2.4.0
func (m Maintainer) GithubURL() string
GithubURL returns github profile URL.
func (Maintainer) URL ¶ added in v2.4.0
func (m Maintainer) URL() string
URL returns a contact of the maintainer (either Github profile or email link).
type Manifest ¶
type Manifest struct { Name string `toml:"name"` // human-readable name Language string `toml:"language"` Version string `toml:"version,omitempty" json:",omitempty"` Build *time.Time `toml:"build,omitempty" json:",omitempty"` Status DevelopmentStatus `toml:"status"` InformationLoss []InformationLoss `toml:"loss" json:",omitempty"` SDKVersion string `toml:"-"` // do not read it from manifest.toml Documentation *Documentation `toml:"documentation,omitempty" json:",omitempty"` Runtime struct { OS OS `toml:"os" json:",omitempty"` NativeVersion Versions `toml:"native_version" json:",omitempty"` NativeEncoding string `toml:"native_encoding" json:",omitempty"` GoVersion string `toml:"go_version" json:",omitempty"` } `toml:"runtime"` Features []Feature `toml:"features" json:",omitempty"` Maintainers []Maintainer `toml:"-" json:",omitempty"` }
func (Manifest) ForCurrentSDK ¶ added in v2.4.0
ForCurrentSDK indicates that driver is built for the same major version of SDK.
func (Manifest) InDevelopment ¶ added in v2.4.0
InDevelopment indicates that driver is incomplete and should only be used for development purposes.
func (Manifest) IsRecommended ¶ added in v2.4.0
IsRecommended indicates that driver is stable enough to be used in production.