source

@[inline]

def Lake.defaultBuildArchive (name : Lake.Name) :

String

The default buildArchive configuration for a package with name.

Equations

Lake.defaultBuildArchive name = toString "" ++ toString (name.toString false) ++ toString "-" ++ toString System.Platform.target ++ toString ".tar.gz"

source

inductive Lake.StrPat :

Type

A String pattern. Matches some subset of strings.

satisfies: (String → Bool) → optParam Lake.Name Lean.Name.anonymous → Lake.StrPat
Matches a string that satisfies an arbitrary predicate (optionally identified by a Name).
mem: Array String → Lake.StrPat
Matches a string that is a member of the array
startsWith: String → Lake.StrPat
Matches a string that starts with this prefix.

Instances For

source

instance Lake.instInhabitedStrPat :

Inhabited Lake.StrPat

Equations

Lake.instInhabitedStrPat = { default := Lake.StrPat.satisfies default default }

source

instance Lake.instCoeArrayStringStrPat :

Coe (Array String) Lake.StrPat

Equations

Lake.instCoeArrayStringStrPat = { coe := Lake.StrPat.mem }

source

instance Lake.instCoeForallStringBoolStrPat :

Coe (String → Bool) Lake.StrPat

Equations

Lake.instCoeForallStringBoolStrPat = { coe := fun (f : String → Bool) => Lake.StrPat.satisfies f }

source

def Lake.StrPat.none :

Lake.StrPat

Matches nothing.

Equations

Lake.StrPat.none = Lake.StrPat.mem #[]

source

instance Lake.instEmptyCollectionStrPat :

EmptyCollection Lake.StrPat

Equations

Lake.instEmptyCollectionStrPat = { emptyCollection := Lake.StrPat.none }

source

def Lake.isVerLike (s : String) :

Bool

Whether a string is "version-like". That is, a v followed by a digit.

Equations

Lake.isVerLike s = if h : s.utf8ByteSize ≥ 2 then s.get' 0 ⋯ == 'v' && (s.get' { byteIdx := 1 } ⋯).isDigit else false

source

def Lake.StrPat.verLike :

Lake.StrPat

Matches a "version-like" string: a v followed by a digit.

Equations

Lake.StrPat.verLike = Lake.StrPat.satisfies Lake.isVerLike `verLike

source

def Lake.defaultVersionTags :

Lake.StrPat

Default string pattern for a Package's versionTags.

Equations

Lake.defaultVersionTags = Lake.StrPat.satisfies Lake.isVerLike `default

source

def Lake.versionTagPresets :

Lean.RBMap Lake.Name Lake.StrPat Lean.Name.quickCmp

Builtin StrPat presets available to TOML for versionTags.

Equations

Lake.versionTagPresets = (Lake.NameMap.empty.insert `verLike Lake.StrPat.verLike).insert `default Lake.defaultVersionTags

source

def Lake.StrPat.matches (s : String) (self : Lake.StrPat) :

Bool

Returns whether the string s matches the pattern.

Equations

Lake.StrPat.matches s (Lake.StrPat.satisfies f name) = f s
Lake.StrPat.matches s (Lake.StrPat.mem xs) = xs.contains s
Lake.StrPat.matches s (Lake.StrPat.startsWith p) = p.isPrefixOf s

PackageConfig #

source

structure Lake.PackageConfigextends Lake.WorkspaceConfig , Lake.LeanConfig :

Type

A Package's declarative configuration.

packagesDir : Lake.FilePath
buildType : Lake.BuildType
leanOptions : Array Lake.LeanOption
moreLeanArgs : Array String
weakLeanArgs : Array String
moreLeancArgs : Array String
moreServerOptions : Array Lake.LeanOption
weakLeancArgs : Array String
moreLinkArgs : Array String
weakLinkArgs : Array String
backend : Lake.Backend
platformIndependent : Option Bool
name : Lake.Name
The Name of the package.
manifestFile : Option Lake.FilePath
This field is deprecated.
The path of a package's manifest file, which stores the exact versions of its resolved dependencies.
Defaults to defaultManifestFile (i.e., lake-manifest.json).
extraDepTargets : Array Lake.Name
An Array of target names to build whenever the package is used.
precompileModules : Bool
Whether to compile each of the package's module into a native shared library that is loaded whenever the module is imported. This speeds up evaluation of metaprograms and enables the interpreter to run functions marked @[extern].
Defaults to false.
moreServerArgs : Array String
Deprecated in favor of moreGlobalServerArgs. Additional arguments to pass to the Lean language server (i.e., lean --server) launched by lake serve, both for this package and also for any packages browsed from this one in the same session.
moreGlobalServerArgs : Array String
Additional arguments to pass to the Lean language server (i.e., lean --server) launched by lake serve, both for this package and also for any packages browsed from this one in the same session.
srcDir : Lake.FilePath
The directory containing the package's Lean source files. Defaults to the package's directory.
(This will be passed to lean as the -R option.)
buildDir : Lake.FilePath
The directory to which Lake should output the package's build results. Defaults to defaultBuildDir (i.e., .lake/build).
leanLibDir : Lake.FilePath
The build subdirectory to which Lake should output the package's binary Lean libraries (e.g., .olean, .ilean files). Defaults to defaultLeanLibDir (i.e., lib).
nativeLibDir : Lake.FilePath
The build subdirectory to which Lake should output the package's native libraries (e.g., .a, .so, .dll files). Defaults to defaultNativeLibDir (i.e., lib).
binDir : Lake.FilePath
The build subdirectory to which Lake should output the package's binary executable. Defaults to defaultBinDir (i.e., bin).
irDir : Lake.FilePath
The build subdirectory to which Lake should output the package's intermediary results (e.g., .c and .o files). Defaults to defaultIrDir (i.e., ir).
releaseRepo? : Option String
The URL of the GitHub repository to upload and download releases of this package. If none (the default), for downloads, Lake uses the URL the package was download from (if it is a dependency) and for uploads, uses gh's default.
releaseRepo : Option String
The URL of the GitHub repository to upload and download releases of this package. If none (the default), for downloads, Lake uses the URL the package was download from (if it is a dependency) and for uploads, uses gh's default.
buildArchive? : Option String
A custom name for the build archive for the GitHub cloud release. If none (the default), Lake uses buildArchive, which defaults to {(pkg-)name}-{System.Platform.target}.tar.gz.
buildArchive : String
A custom name for the build archive for the GitHub cloud release. Defaults to {(pkg-)name}-{System.Platform.target}.tar.gz.
preferReleaseBuild : Bool
Whether to prefer downloading a prebuilt release (from GitHub) rather than building this package from the source when this package is used as a dependency.
testDriver : String
The name of the script, executable, or library by lake test when this package is the workspace root. To point to a definition in another package, use the syntax <pkg>/<def>.
A script driver will be run by lake test with the arguments configured in testDriverArgs followed by any specified on the CLI (e.g., via lake lint -- <args>...). An executable driver will be built and then run like a script. A library will just be built.
testDriverArgs : Array String
Arguments to pass to the package's test driver. These arguments will come before those passed on the command line via lake test -- <args>....
lintDriver : String
The name of the script or executable used by lake lint when this package is the workspace root. To point to a definition in another package, use the syntax <pkg>/<def>.
A script driver will be run by lake lint with the arguments configured in lintDriverArgs followed by any specified on the CLI (e.g., via lake lint -- <args>...). An executable driver will be built and then run like a script.
lintDriverArgs : Array String
Arguments to pass to the package's linter. These arguments will come before those passed on the command line via lake lint -- <args>....
version : Lake.StdVer
The package version. Versions have the form:
```
v!"<major>.<minor>.<patch>[-<specialDescr>]"
```
A version with a - suffix is considered a "prerelease".
Lake suggest the following guidelines for incrementing versions:
- Major version increment (e.g., v1.3.0 → v2.0.0) Indicates significant breaking changes in the package. Package users are not expected to update to the new version without manual intervention.
- Minor version increment (e.g., v1.3.0 → v1.4.0) Denotes notable changes that are expected to be generally backwards compatible. Package users are expected to update to this version automatically and should be able to fix any breakages and/or warnings easily.
- Patch version increment (e.g., v1.3.0 → v1.3.1) Reserved for bug fixes and small touchups. Package users are expected to update automatically and should not expect significant breakage, except in the edge case of users relying on the behavior of patched bugs.
Note that backwards-incompatible changes may occur at any version increment. The is because the current nature of Lean (e.g., transitive imports, rich metaprogramming, reducibility in proofs), makes it infeasible to define a completely stable interface for a package. Instead, the different version levels indicate a change's intended significance and how difficult migration is expected to be.
Versions of form the 0.x.x are considered development versions prior to first official release. Like prerelease, they are not expected to closely follow the above guidelines.
Packages without a defined version default to 0.0.0.
versionTags : Lake.StrPat
Git tags of this package's repository that should be treated as versions. Package indices (e.g., Reservoir) can make use of this information to determine the Git revisions corresponding to released versions.
Defaults to tags that are "version-like". That is, start with a v followed by a digit.
description : String
A short description for the package (e.g., for Reservoir).
keywords : Array String
Custom keywords associated with the package. Reservoir can make use of a package's keywords to group related packages together and make it easier for users to discover them.
Good keywords include the domain (e.g., math, software-verification, devtool), specific subtopics (e.g., topology, cryptology), and significant implementation details (e.g., dsl, ffi, cli). For instance, Lake's keywords could be devtool, cli, dsl, package-manager, and build-system.
homepage : String
A URL to information about the package.
Reservoir will already include a link to the package's GitHub repository (if the package is sourced from there). Thus, users are advised to specify something else for this (if anything).
license : String
The package's license (if one). Should be a valid SPDX License Expression.
Reservoir requires that packages uses an OSI-approved license to be included in its index, and currently only supports single identifier SPDX expressions. For, a list of OSI-approved SPDX license identifiers, see the SPDX LIcense List.
licenseFiles : Array Lake.FilePath
Files containing licensing information for the package.
These should be the license files that users are expected to include when distributing package sources, which may be more then one file for some licenses. For example, the Apache 2.0 license requires the reproduction of a NOTICE file along with the license (if such a file exists).
Defaults to #["LICENSE"].
readmeFile : Lake.FilePath
The path to the package's README.
A README should be a Markdown file containing an overview of the package. Reservoir displays the rendered HTML of this file on a package's page. A nonstandard location can be used to provide a different README for Reservoir and GitHub.
Defaults to README.md.
reservoir : Bool
Whether Reservoir should include the package in its index. When set to false, Reservoir will not add the package to its index and will remove it if it was already there (when Reservoir is next updated).

Instances For

Lake.instInhabitedPackageConfig

source

instance Lake.instInhabitedPackageConfig :

Inhabited Lake.PackageConfig

Equations

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

Package #

source

def Lake.OpaquePostUpdateHook (pkg : Lake.Name) :

Type

Equations

Lake.OpaquePostUpdateHook pkg = (Lake.OpaquePostUpdateHook.nonemptyType pkg).type

Instances For

source

opaque Lake.OpaquePostUpdateHook.nonemptyType (pkg : Lake.Name) :

NonemptyType

source

instance Lake.instNonemptyOpaquePostUpdateHook {pkg : Lake.Name} :

Nonempty (Lake.OpaquePostUpdateHook pkg)

Equations

⋯ = ⋯

source

structure Lake.Package :

Type

A Lake package -- its location plus its configuration.

dir : Lake.FilePath
The path to the package's directory.
relDir : Lake.FilePath
The path to the package's directory relative to the workspace.
config : Lake.PackageConfig
The package's user-defined configuration.
relConfigFile : Lake.FilePath
The path to the package's configuration file (relative to dir).
relManifestFile : Lake.FilePath
The path to the package's JSON manifest of remote dependencies (relative to dir).
scope : String
The package's scope (e.g., in Reservoir).
remoteUrl : String
The URL to this package's Git remote.
opaqueDeps : Array Lake.OpaquePackage
(Opaque references to) the package's direct dependencies.
depConfigs : Array Lake.Dependency
Dependency configurations for the package.
leanLibConfigs : Lake.OrdNameMap Lake.LeanLibConfig
Lean library configurations for the package.
leanExeConfigs : Lake.OrdNameMap Lake.LeanExeConfig
Lean binary executable configurations for the package.
externLibConfigs : Lake.DNameMap (Lake.ExternLibConfig self.config.name)
External library targets for the package.
opaqueTargetConfigs : Lake.DNameMap (Lake.OpaqueTargetConfig self.config.name)
(Opaque references to) targets defined in the package.
defaultTargets : Array Lake.Name
The names of the package's targets to build by default (i.e., on a bare lake build of the package).
scripts : Lake.NameMap Lake.Script
Scripts for the package.
defaultScripts : Array Lake.Script
The names of the package's scripts run by default (i.e., on a bare lake run of the package).
postUpdateHooks : Array (Lake.OpaquePostUpdateHook self.config.name)
Post-lake update hooks for the package.
testDriver : String
The driver used for lake test when this package is the workspace root.
lintDriver : String
The driver used for lake lint when this package is the workspace root.