Package Registries

This module contains definitions for fetching Lake package information from a online registry (e.g., Reservoir).

inductive Lake.RegistrySrc : Type

Package source information from a Lake registry (e.g., Reservoir). Only contains the subset of fields useful to Lake.

• git (data : JsonObject) (url : String) (githubUrl? defaultBranch? : Option String) (subDir? : Option System.FilePath) : RegistrySrc
• other (data : JsonObject) : RegistrySrc

instance Lake.instInhabitedRegistrySrc : Inhabited RegistrySrc

Equations

• Lake.instInhabitedRegistrySrc = { default := Lake.instInhabitedRegistrySrc.default }

def Lake.instInhabitedRegistrySrc.default : RegistrySrc

Equations

• Lake.instInhabitedRegistrySrc.default = Lake.RegistrySrc.git default default default default default

def Lake.RegistrySrc.isGit (src : RegistrySrc) : Bool

Equations

• (Lake.RegistrySrc.git data url githubUrl? defaultBranch? subDir?).isGit = true
• (Lake.RegistrySrc.other data).isGit = false

def Lake.RegistrySrc.data (src : RegistrySrc) : JsonObject

Equations

• (Lake.RegistrySrc.git data url githubUrl? defaultBranch? subDir?).data = data
• (Lake.RegistrySrc.other data).data = data

def Lake.RegistrySrc.toJson (src : RegistrySrc) : Lean.Json

Equations

• src.toJson = Lean.Json.obj src.data

instance Lake.RegistrySrc.instToJson : Lean.ToJson RegistrySrc

Equations

• Lake.RegistrySrc.instToJson = { toJson := Lake.RegistrySrc.toJson }

def Lake.RegistrySrc.fromJson? (val : Lean.Json) : Except String RegistrySrc

Equations

• One or more equations did not get rendered due to their size.

instance Lake.RegistrySrc.instFromJson : Lean.FromJson RegistrySrc

Equations

• Lake.RegistrySrc.instFromJson = { fromJson? := Lake.RegistrySrc.fromJson? }

structure Lake.RegistryPkg : Type

Package metadata from a Lake registry (e.g., Reservoir). Only contains the subset of fields useful to Lake.

• name : String
• fullName : String
• sources : Array RegistrySrc
• data : Lean.Json

def Lake.instInhabitedRegistryPkg.default : RegistryPkg

Equations

• Lake.instInhabitedRegistryPkg.default = { name := default, fullName := default, sources := default, data := default }

instance Lake.instInhabitedRegistryPkg : Inhabited RegistryPkg

Equations

• Lake.instInhabitedRegistryPkg = { default := Lake.instInhabitedRegistryPkg.default }

def Lake.RegistryPkg.gitSrc? (pkg : RegistryPkg) : Option RegistrySrc

Equations

• pkg.gitSrc? = Array.find? (fun (x : Lake.RegistrySrc) => x.isGit) pkg.sources

def Lake.RegistryPkg.toJson (src : RegistryPkg) : Lean.Json

Equations

• src.toJson = src.data

def Lake.RegistryPkg.fromJson? (val : Lean.Json) : Except String RegistryPkg

Equations

• One or more equations did not get rendered due to their size.

instance Lake.RegistryPkg.instFromJson : Lean.FromJson RegistryPkg

Equations

• Lake.RegistryPkg.instFromJson = { fromJson? := Lake.RegistryPkg.fromJson? }

inductive Lake.ReservoirResp (α : Type u) : Type u

A Reservoir API response object.

• data {α : Type u} (a : α) : ReservoirResp α
• error {α : Type u} (status : Nat) (message : String) : ReservoirResp α

def Lake.ReservoirResp.fromJson? {α : Type} [Lean.FromJson α] (val : Lean.Json) : Except String (ReservoirResp α)

Equations

• One or more equations did not get rendered due to their size.

instance Lake.instFromJsonReservoirResp {α : Type} [Lean.FromJson α] : Lean.FromJson (ReservoirResp α)

Equations

• Lake.instFromJsonReservoirResp = { fromJson? := Lake.ReservoirResp.fromJson? }

def Lake.Reservoir.pkgApiUrl (lakeEnv : Env) (owner pkg : String) : String

Equations

• Lake.Reservoir.pkgApiUrl lakeEnv owner pkg = toString lakeEnv.reservoirApiUrl ++ toString "/packages/" ++ toString (Lake.uriEncode owner) ++ toString "/" ++ toString (Lake.uriEncode pkg)

def Lake.Reservoir.fetchPkg? (lakeEnv : Env) (owner pkg : String) : LogIO (Option RegistryPkg)

Equations

• One or more equations did not get rendered due to their size.

structure Lake.RegistryVer : Type

Version metadata from a Lake registry (e.g., Reservoir). Only contains the subset of fields useful to Lake.

• version : StdVer
• revision : String

def Lake.RegistryVer.fromJson? (val : Lean.Json) : Except String RegistryVer

Equations

• One or more equations did not get rendered due to their size.

instance Lake.instFromJsonRegistryVer : Lean.FromJson RegistryVer

Equations

• Lake.instFromJsonRegistryVer = { fromJson? := Lake.RegistryVer.fromJson? }

def Lake.Reservoir.pkgVersionsApiUrl (lakeEnv : Env) (owner pkg : String) : String

Equations

• One or more equations did not get rendered due to their size.

def Lake.Reservoir.fetchPkgVersions (lakeEnv : Env) (owner pkg : String) : LogIO (Array RegistryVer)

Equations

• One or more equations did not get rendered due to their size.