Documentation
¶
Overview ¶
Package zig resolves Zig toolchain versions from the official ziglang.org download index. The index is a single, anonymous JSON object keyed by version, each entry carrying its per-platform archive checksums and publication date for free, so the provider fetches it once and lets the framework own selection.
The index key is the authoritative version: recent entries also carry a redundant "version" field, but older releases omit it, so the provider always reads the key. The "master" key is a moving nightly pointer, not a release, and is skipped.
Index ¶
- type Option
- type Provider
- func (p *Provider) BareMajor()
- func (p *Provider) Color(dark bool) color.Color
- func (p *Provider) Dated()
- func (p *Provider) Describe(r provider.Resource) string
- func (p *Provider) Discover(ctx context.Context, r provider.Resource) ([]model.Candidate, error)
- func (p *Provider) Identify(r provider.Resource) (string, string)
- func (p *Provider) Keys() []provider.Key
- func (p *Provider) Name() string
- func (p *Provider) Resource(_ directive.Directive) (provider.Resource, error)
- func (p *Provider) URL(r provider.Resource, c model.Candidate) string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Option ¶
type Option func(*Provider)
Option configures a Provider.
func WithTransport ¶
func WithTransport(rt http.RoundTripper) Option
WithTransport overrides the HTTP transport, for tests.
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider resolves Zig toolchain versions from ziglang.org's public, unauthenticated download index. The index is a single JSON object listing every release, so the provider fetches it once and lets the framework own selection; it lists candidates and tags each with the archive checksums and publication date the index returns for free, which followers and cooldown consume.
func New ¶
New returns the Zig provider. The download index is public and publishes no rate-limit headers, so the client is a plain cached one with no ratelimit wrapper or credentials.
func (*Provider) BareMajor ¶ added in v0.4.0
func (p *Provider) BareMajor()
BareMajor marks a bare single-number pin as major-precision rather than a calendar tag: ziglang.org publishes X.Y.Z releases, never a calendar stamp, so a dotted candidate may replace one.
func (*Provider) Color ¶ added in v0.3.10
Color is the provider's brand color. See provider.Provider.Color.
func (*Provider) Dated ¶
func (p *Provider) Dated()
Dated marks the listing as date-bearing: a tagged release carries a publication date. An entry without one falls to the post-discovery date check.
func (*Provider) Discover ¶
Discover lists candidate Zig versions, reading the download index in one fetch. The index holds the whole release history in a single object keyed by version, so there is no pagination and nothing is ever left unread - --deep has no work to do here. The map iteration order is nondeterministic, so candidates are returned unordered; selection sorts regardless.
func (*Provider) Keys ¶
Keys reports the directive keys the provider accepts. ziglang.org needs none of its own: the whole index arrives in one fetch, and per-platform checksum selection is a follower's job via its pattern, not a provider option.
func (*Provider) Resource ¶
Resource validates a directive into a Zig resource. ziglang.org takes no provider-specific keys, so every directive resolves to the same descriptor.
func (*Provider) URL ¶
URL builds the web page for a resolved candidate: the release's file directory on ziglang.org (e.g. .../download/0.16.0/). The version is clean semver and is also the upstream ref, so the current-version candidate - whose Version is the bare on-line value - links correctly with no Meta. Empty when the version is unknown.
Source Files