Documentation

Lake.Config.Package

source
@[inline]
def Lake.defaultBuildArchive (name : Lean.Name) :
String

The default buildArchive configuration for a package with name.

Equations

PackageConfig #

source
structure Lake.PackageConfig (name : Lean.Name) extends Lake.WorkspaceConfig, Lake.LeanConfig :
Type

A Package's declarative configuration.

  • packagesDir : System.FilePath
  • buildType : BuildType
  • leanOptions : Array LeanOption
  • moreLeanArgs : Array String
  • weakLeanArgs : Array String
  • moreLeancArgs : Array String
  • moreServerOptions : Array LeanOption
  • weakLeancArgs : Array String
  • moreLinkObjs : TargetArray System.FilePath
  • moreLinkLibs : TargetArray Dynlib
  • moreLinkArgs : Array String
  • weakLinkArgs : Array String
  • backend : Backend
  • platformIndependent : Option Bool
  • dynlibs : TargetArray Dynlib
  • plugins : TargetArray Dynlib
  • manifestFile : Option System.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 Lean.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.

  • 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 : System.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 : System.FilePath

    The directory to which Lake should output the package's build results. Defaults to defaultBuildDir (i.e., .lake/build).

  • leanLibDir : System.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 : System.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 : System.FilePath

    The build subdirectory to which Lake should output the package's binary executable. Defaults to defaultBinDir (i.e., bin).

  • irDir : System.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.

  • buildArchive : Option String

    A custom name for the build archive for the GitHub cloud release. If none (the default), Lake 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 : 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 : 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 System.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 : System.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
source
instance Lake.PackageConfig.lintDriver.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `lintDriver String
Equations
source
instance Lake.PackageConfig.buildDir.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `buildDir System.FilePath
Equations
source
instance Lake.PackageConfig.keywords.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `keywords (Array String)
Equations
source
instance Lake.PackageConfig.nativeLibDir.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `nativeLibDir System.FilePath
Equations
source
instance Lake.PackageConfig.buildArchive.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `buildArchive (Option String)
Equations
source
instance Lake.PackageConfig.versionTags.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `versionTags StrPat
Equations
source
instance Lake.PackageConfig.testDriverArgs.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `testDriverArgs (Array String)
Equations
source
instance Lake.PackageConfig.toLeanConfig.instConfigParent {name : Lean.Name} :
ConfigParent (PackageConfig name) LeanConfig
Equations
source
instance Lake.PackageConfig.preferReleaseBuild.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `preferReleaseBuild Bool
Equations
source
instance Lake.PackageConfig.releaseRepo?.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `releaseRepo? (Option String)
Equations
source
instance Lake.PackageConfig.releaseRepo.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `releaseRepo (Option String)
Equations
source
instance Lake.PackageConfig.readmeFile.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `readmeFile System.FilePath
Equations
source
instance Lake.PackageConfig.homepage.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `homepage String
Equations
source
instance Lake.PackageConfig.licenseFiles.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `licenseFiles (Array System.FilePath)
Equations
source
instance Lake.PackageConfig.description.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `description String
Equations
source
instance Lake.PackageConfig.buildArchive?.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `buildArchive? (Option String)
Equations
source
instance Lake.PackageConfig.reservoir.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `reservoir Bool
Equations
source
instance Lake.PackageConfig.testDriver.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `testDriver String
Equations
source
instance Lake.PackageConfig.testRunner.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `testRunner String
Equations
source
instance Lake.PackageConfig.lintDriverArgs.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `lintDriverArgs (Array String)
Equations
source
instance Lake.PackageConfig.leanLibDir.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `leanLibDir System.FilePath
Equations
source
instance Lake.PackageConfig.license.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `license String
Equations
source
instance Lake.PackageConfig.instConfigFields {name : Lean.Name} :
ConfigFields (PackageConfig name)
Equations
source
instance Lake.PackageConfig.version.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `version StdVer
Equations
source
instance Lake.PackageConfig.extraDepTargets.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `extraDepTargets (Array Lean.Name)
Equations
source
instance Lake.PackageConfig.srcDir.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `srcDir System.FilePath
Equations
source
instance Lake.PackageConfig.instConfigMeta :
ConfigInfo `Lake.PackageConfig
Equations
source
instance Lake.PackageConfig.irDir.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `irDir System.FilePath
Equations
source
instance Lake.PackageConfig.binDir.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `binDir System.FilePath
Equations
source
instance Lake.PackageConfig.moreGlobalServerArgs.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `moreGlobalServerArgs (Array String)
Equations
source
instance Lake.PackageConfig.moreServerArgs.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `moreServerArgs (Array String)
Equations
source
instance Lake.PackageConfig.manifestFile.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `manifestFile (Option System.FilePath)
Equations
source
instance Lake.PackageConfig.precompileModules.instConfigField {name : Lean.Name} :
ConfigField (PackageConfig name) `precompileModules Bool
Equations
source
instance Lake.PackageConfig.toWorkspaceConfig.instConfigParent {name : Lean.Name} :
ConfigParent (PackageConfig name) WorkspaceConfig
Equations
source
instance Lake.instInhabitedPackageConfig {a✝ : Lean.Name} :
Inhabited (PackageConfig a✝)
Equations
  • One or more equations did not get rendered due to their size.
source
instance Lake.instEmptyCollectionPackageConfig {n : Lean.Name} :
EmptyCollection (PackageConfig n)
Equations
source
@[reducible, inline]
abbrev Lake.PackageConfig.name {n : Lean.Name} :
PackageConfig n → Lean.Name

The package's name.

Equations
source
structure Lake.PackageDecl :
Type

A package declaration from a configuration written in Lean.

Instances For
source
instance Lake.instTypeNamePackageDecl :
TypeName PackageDecl
Equations

Package #

source
opaque Lake.OpaquePostUpdateHook.nonemptyType (pkg : Lean.Name) :
NonemptyType
source
def Lake.OpaquePostUpdateHook (pkg : Lean.Name) :
Type
Equations
Instances For
source
instance Lake.instNonemptyOpaquePostUpdateHook {pkg : Lean.Name} :
Nonempty (OpaquePostUpdateHook pkg)
source
structure Lake.Package :
Type

A Lake package -- its location plus its configuration.

  • name : Lean.Name

    The name of the package.

  • dir : System.FilePath

    The path to the package's directory.

  • relDir : System.FilePath

    The path to the package's directory relative to the workspace.

  • config : PackageConfig self.name

    The package's user-defined configuration.

  • relConfigFile : System.FilePath

    The path to the package's configuration file (relative to dir).

  • relManifestFile : System.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.

  • depConfigs : Array Dependency

    Dependency configurations for the package.

  • targetDecls : Array (PConfigDecl self.name)

    Target configurations in the order declared by the package.

  • targetDeclMap : DNameMap (NConfigDecl self.name)

    Name-declaration map of target configurations in the package.

  • defaultTargets : Array Lean.Name

    The names of the package's targets to build by default (i.e., on a bare lake build of the package).

  • scripts : Lean.NameMap Script

    Scripts for the package.

  • defaultScripts : Array Script

    The names of the package's scripts run by default (i.e., on a bare lake run of the package).

  • postUpdateHooks : Array (OpaquePostUpdateHook self.name)

    Post-lake update hooks for the package.

  • buildArchive : String

    The package's buildArchive/buildArchive? configuration.

  • 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.

Instances For
source
instance Lake.instNonemptyPackage :
Nonempty Package
source
instance Lake.instHashablePackage :
Hashable Package
Equations
source
instance Lake.instBEqPackage :
BEq Package
Equations
source
@[reducible, inline]
abbrev Lake.PackageSet :
Type
Equations
source
@[inline]
def Lake.PackageSet.empty :
PackageSet
Equations
source
@[reducible, inline]
abbrev Lake.OrdPackageSet :
Type
Equations
source
@[inline]
def Lake.OrdPackageSet.empty :
OrdPackageSet
Equations
source
instance Lake.instToTextPackage :
ToText Package
Equations
source
instance Lake.instToJsonPackage :
Lean.ToJson Package
Equations
source
structure Lake.NPackage (n : Lean.Name) extends Lake.Package :
Type

A package with a name known at type-level.

Instances For
source
instance Lake.instCoeOutNPackagePackage {n : Lean.Name} :
CoeOut (NPackage n) Package
Equations
source
instance Lake.instCoeDepPackageNPackageName {pkg : Package} :
CoeDep Package pkg (NPackage pkg.name)
Equations
source
@[reducible, inline]
abbrev Lake.PostUpdateFn (pkgName : Lean.Name) :
Type

The type of a post-update hooks monad. IO equipped with logging ability and information about the Lake configuration.

Equations
source
structure Lake.PostUpdateHook (pkgName : Lean.Name) :
Type
Instances For
source
instance Lake.instInhabitedPostUpdateHook {a✝ : Lean.Name} :
Inhabited (PostUpdateHook a✝)
Equations
source
@[implemented_by Lake.OpaquePostUpdateHook.unsafeGet]
opaque Lake.OpaquePostUpdateHook.get {name : Lean.Name} :
OpaquePostUpdateHook name → PostUpdateHook name
source
@[implemented_by Lake.OpaquePostUpdateHook.unsafeMk]
opaque Lake.OpaquePostUpdateHook.mk {name : Lean.Name} :
PostUpdateHook name → OpaquePostUpdateHook name
source
unsafe def Lake.OpaquePostUpdateHook.unsafeGet {name : Lean.Name} :
OpaquePostUpdateHook name → PostUpdateHook name
Equations
source
instance Lake.OpaquePostUpdateHook.instCoePostUpdateHook_1 {name : Lean.Name} :
Coe (OpaquePostUpdateHook name) (PostUpdateHook name)
Equations
source
instance Lake.OpaquePostUpdateHook.instCoePostUpdateHook {name : Lean.Name} :
Coe (PostUpdateHook name) (OpaquePostUpdateHook name)
Equations
source
unsafe def Lake.OpaquePostUpdateHook.unsafeMk {name : Lean.Name} :
PostUpdateHook name → OpaquePostUpdateHook name
Equations
source
instance Lake.OpaquePostUpdateHook.instInhabitedOfPostUpdateHook {name : Lean.Name} [Inhabited (PostUpdateHook name)] :
Inhabited (OpaquePostUpdateHook name)
Equations
source
structure Lake.PostUpdateHookDecl :
Type
Instances For
source
instance Lake.instTypeNamePostUpdateHookDecl :
TypeName PostUpdateHookDecl
Equations
source
@[inline]
def Lake.Package.version (self : Package) :
LeanVer

The package version.

Equations
source
@[inline]
def Lake.Package.versionTags (self : Package) :
StrPat

The package's versionTags configuration.

Equations
source
@[inline]
def Lake.Package.description (self : Package) :
String

The package's description configuration.

Equations
source
@[inline]
def Lake.Package.keywords (self : Package) :
Array String

The package's keywords configuration.

Equations
source
@[inline]
def Lake.Package.homepage (self : Package) :
String

The package's homepage configuration.

Equations
source
@[inline]
def Lake.Package.reservoir (self : Package) :
Bool

The package's reservoir configuration.

Equations
source
@[inline]
def Lake.Package.license (self : Package) :
String

The package's license configuration.

Equations
source
@[inline]
def Lake.Package.relLicenseFiles (self : Package) :
Array System.FilePath

The package's licenseFiles configuration.

Equations
source
@[inline]
def Lake.Package.licenseFiles (self : Package) :
Array System.FilePath

The package's dir joined with each of its relLicenseFiles.

Equations
source
@[inline]
def Lake.Package.relReadmeFile (self : Package) :
System.FilePath

The package's readmeFile configuration.

Equations
source
@[inline]
def Lake.Package.readmeFile (self : Package) :
System.FilePath

The package's dir joined with its relReadmeFile.

Equations
source
@[inline]
def Lake.Package.relLakeDir :
Package → System.FilePath

The path to the package's Lake directory relative to dir (e.g., .lake).

Equations
source
@[inline]
def Lake.Package.lakeDir (self : Package) :
System.FilePath

The full path to the package's Lake directory (i.e, dir joined with relLakeDir).

Equations
source
@[inline]
def Lake.Package.relPkgsDir (self : Package) :
System.FilePath

The path for storing the package's remote dependencies relative to dir (i.e., packagesDir).

Equations
source
@[inline]
def Lake.Package.pkgsDir (self : Package) :
System.FilePath

The package's dir joined with its relPkgsDir.

Equations
source
@[inline]
def Lake.Package.configFile (self : Package) :
System.FilePath

The full path to the package's configuration file.

Equations
source
@[inline]
def Lake.Package.manifestFile (self : Package) :
System.FilePath

The path to the package's JSON manifest of remote dependencies.

Equations
source
@[inline]
def Lake.Package.buildDir (self : Package) :
System.FilePath

The package's dir joined with its buildDir configuration.

Equations
source
@[inline]
def Lake.Package.testDriverArgs (self : Package) :
Array String

The package's testDriverArgs configuration.

Equations
source
@[inline]
def Lake.Package.lintDriverArgs (self : Package) :
Array String

The package's lintDriverArgs configuration.

Equations
source
@[inline]
def Lake.Package.extraDepTargets (self : Package) :
Array Lean.Name

The package's extraDepTargets configuration.

Equations
source
@[inline]
def Lake.Package.platformIndependent (self : Package) :
Option Bool

The package's platformIndependent configuration.

Equations
source
@[inline]
def Lake.Package.releaseRepo? (self : Package) :
Option String

The package's releaseRepo/releaseRepo? configuration.

Equations
source
@[inline]
def Lake.Package.remoteUrl? (self : Package) :
Option String

The packages remoteUrl as an Option (none if empty).

Equations
source
@[inline]
def Lake.Package.buildArchiveFile (self : Package) :
System.FilePath

The package's lakeDir joined with its buildArchive.

Equations
source
@[inline]
def Lake.Package.barrelFile (self : Package) :
System.FilePath

The path where Lake stores the package's barrel (downloaded from Reservoir).

Equations
source
@[inline]
def Lake.Package.preferReleaseBuild (self : Package) :
Bool

The package's preferReleaseBuild configuration.

Equations
source
@[inline]
def Lake.Package.precompileModules (self : Package) :
Bool

The package's precompileModules configuration.

Equations
source
@[inline]
def Lake.Package.moreGlobalServerArgs (self : Package) :
Array String

The package's moreGlobalServerArgs configuration.

Equations
source
@[inline]
def Lake.Package.moreServerOptions (self : Package) :
Array LeanOption

The package's moreServerOptions configuration appended to its leanOptions configuration.

Equations
source
@[inline]
def Lake.Package.buildType (self : Package) :
BuildType

The package's buildType configuration.

Equations
source
@[inline]
def Lake.Package.backend (self : Package) :
Backend

The package's backend configuration.

Equations
source
@[inline]
def Lake.Package.dynlibs (self : Package) :
TargetArray Dynlib

The package's dynlibs configuration.

Equations
source
@[inline]
def Lake.Package.plugins (self : Package) :
TargetArray Dynlib

The package's plugins configuration.

Equations
source
@[inline]
def Lake.Package.leanOptions (self : Package) :
Array LeanOption

The package's leanOptions configuration.

Equations
source
@[inline]
def Lake.Package.moreLeanArgs (self : Package) :
Array String

The package's moreLeanArgs configuration appended to its leanOptions configuration.

Equations
source
@[inline]
def Lake.Package.weakLeanArgs (self : Package) :
Array String

The package's weakLeanArgs configuration.

Equations
source
@[inline]
def Lake.Package.moreLeancArgs (self : Package) :
Array String

The package's moreLeancArgs configuration.

Equations
source
@[inline]
def Lake.Package.weakLeancArgs (self : Package) :
Array String

The package's weakLeancArgs configuration.

Equations
source
@[inline]
def Lake.Package.moreLinkObjs (self : Package) :
TargetArray System.FilePath

The package's moreLinkObjs configuration.

Equations
source
@[inline]
def Lake.Package.moreLinkLibs (self : Package) :
TargetArray Dynlib

The package's moreLinkLibs configuration.

Equations
source
@[inline]
def Lake.Package.moreLinkArgs (self : Package) :
Array String

The package's moreLinkArgs configuration.

Equations
source
@[inline]
def Lake.Package.weakLinkArgs (self : Package) :
Array String

The package's weakLinkArgs configuration.

Equations
source
@[inline]
def Lake.Package.srcDir (self : Package) :
System.FilePath

The package's dir joined with its srcDir configuration.

Equations
source
@[inline]
def Lake.Package.rootDir (self : Package) :
System.FilePath

The package's root directory for lean (i.e., srcDir).

Equations
source
@[inline]
def Lake.Package.leanLibDir (self : Package) :
System.FilePath

The package's buildDir joined with its leanLibDir configuration.

Equations
source
@[inline]
def Lake.Package.staticLibDir (self : Package) :
System.FilePath

Where static libraries for the package are located. The package's buildDir joined with its nativeLibDir configuration.

Equations
source
@[inline]
def Lake.Package.sharedLibDir (self : Package) :
System.FilePath

Where shared libraries for the package are located. The package's buildDir joined with its nativeLibDir configuration.

Equations
source
@[deprecated "Use staticLibDir or sharedLibDir instead." (since := "2025-03-29")]
def Lake.Package.nativeLibDir (self : Package) :
System.FilePath

The package's buildDir joined with its nativeLibDir configuration.

Equations
source
@[inline]
def Lake.Package.binDir (self : Package) :
System.FilePath

The package's buildDir joined with its binDir configuration.

Equations
source
@[inline]
def Lake.Package.irDir (self : Package) :
System.FilePath

The package's buildDir joined with its irDir configuration.

Equations
source
def Lake.Package.findTargetDecl? (name : Lean.Name) (self : Package) :
Option (NConfigDecl self.name name)

Try to find a target configuration in the package with the given name.

Equations
source
def Lake.Package.isLocalModule (mod : Lean.Name) (self : Package) :
Bool

Whether the given module is considered local to the package.

Equations
  • One or more equations did not get rendered due to their size.
source
def Lake.Package.isBuildableModule (mod : Lean.Name) (self : Package) :
Bool

Whether the given module is in the package (i.e., can build it).

Equations
  • One or more equations did not get rendered due to their size.
source
def Lake.Package.clean (self : Package) :
IO PUnit

Remove the package's build outputs (i.e., delete its build directory).

Equations