Idris2Doc : Pack.Config.Environment

Pack.Config.Environment

(source)
Reexports
import public Pack.Config.Environment.Variable
Definitions
packToml : Body
  File body of all `pack.toml` files.

  Totality: total
  Visibility: export
dbDir : PackDirs => Path Abs
  Directory where databases are stored.

  Totality: total
  Visibility: export
cacheDir : PackDirs => Path Abs
  Directory where cached data is stored

  Totality: total
  Visibility: export
ipkgCachePath : PackDirs => PkgName -> Commit -> File Rel -> File Abs
  Path to cached `.ipkg` file.

  Totality: total
  Visibility: export
versionCachePath : PackDirs => DB => File Abs
  Path where the cached compiler version is stored.

  Totality: total
  Visibility: export
coreCachePath : PackDirs => DB => CorePkg -> File Abs
  Path to cached core library `.ipkg` file

  Totality: total
  Visibility: export
userDir : PackDirs => Path Abs
  Directory where user settings are stored.

  Totality: total
  Visibility: export
globalPackToml : PackDirs => File Abs
  Path to global `pack.toml` file.

  Totality: total
  Visibility: export
collectionToml : PackDirs => File Abs
  Path to global `pack.toml` file containing the global pack collection.

  Totality: total
  Visibility: export
dbFile : PackDirs => MetaConfig => File Abs
  File where package DB is located

  Totality: total
  Visibility: export
packBinDir : PackDirs => Path Abs
  Directory where wrapper scripts to binaries
  managed by pack are being stored. The only exception
  is pack itself, which is stored as a symbolic link.

  Totality: total
  Visibility: export
installDir : PackDirs => Path Abs
  Where packages and built applications will be installed

  Totality: total
  Visibility: export
packParentDir : PackDirs => Path Abs
  Where all pack versions are installed

  Totality: total
  Visibility: export
packInstallDir : PackDirs => Commit -> Path Abs
  Where the actual pack application is installed.

  Totality: total
  Visibility: export
pathExec : PackDirs => Body -> File Abs
  Executable for an application

  Totality: total
  Visibility: export
packExec : PackDirs => File Abs
  Symbolic link to the current pack executable.

  Totality: total
  Visibility: export
patchesDir : PackDirs => Path Abs
  Directory where `.ipkg` patches are stored.

  Totality: total
  Visibility: export
commitsDir : PackDirs => Path Abs
  Totality: total
  Visibility: export
commitFile : PackDirs => URL -> Branch -> File Abs
  Path to file storing the last fetched commit of a Git
  repo given as a URL and branch name.

  Totality: total
  Visibility: export
patchFile : PackDirs => Config => PkgName -> File Rel -> File Abs
  File where the patch (if any) for an `.ipkg` file is stored.

  Totality: total
  Visibility: export
commitDir : PackDirs => DB => Path Abs
  Directory where all packages (and Idris2) built with the
  current Idris2 commit will be installed.

  Totality: total
  Visibility: export
idrisPrefixDir : PackDirs => DB => Path Abs
  The directory where Idris2 and core libraries will be installed.

  Totality: total
  Visibility: export
idrisBinDir : PackDirs => DB => Path Abs
  The directory where the Idris2 binary will be installed.

  Totality: total
  Visibility: export
idrisExec : PackDirs => DB => File Abs
  Location of the Idris2 executable used to build packages.
  
  Notice that if you need an Idris command, you may need `idrisCmd` function
  instead because it takes extra arguments into account.

  Totality: total
  Visibility: export
idrisDir : DB => Body
  Totality: total
  Visibility: export
idrisInstallDir : PackDirs => DB => Path Abs
  The directory where Idris2 packages will be installed.

  Totality: total
  Visibility: export
idrisLibDir : PackDirs => DB => Path Abs
  The `lib` directory in the Idris2 installation folder

  Totality: total
  Visibility: export
idrisDataDir : PackDirs => DB => Path Abs
  The `support` directory in the Idris2 installation folder

  Totality: total
  Visibility: export
pkgPrefixDir : PackDirs => DB => PkgName -> Hash -> Package -> Path Abs
  Directory where an installed library or app goes

  Totality: total
  Visibility: export
pkgPathDir : PackDirs => DB => PkgName -> Hash -> Package -> Path Abs
  Directory to be used with the `IDRIS2_PACKAGE_PATH` variable, so that
  Idris finds a library even though it is being installed in a
  custom location.

  Totality: total
  Visibility: export
pkgBinDir : PackDirs => DB => PkgName -> Hash -> Package -> Path Abs
  Directory where the binary of an Idris application is installed.

  Totality: total
  Visibility: export
pkgLibDir : PackDirs => DB => PkgName -> Hash -> Package -> Path Abs
  Directory to be used with the `IDRIS2_LIBS` variable, so that
  Idris finds a libraries `.so` files even though they have been
  installed in a custom location.

  Totality: total
  Visibility: export
pkgDataDir : PackDirs => DB => PkgName -> Hash -> Package -> Path Abs
  Directory to be used with the `IDRIS2_DATA` variable, so that
  Idris finds a libraries support files even though they have been
  installed in a custom location.

  Totality: total
  Visibility: export
libTimestamp : PackDirs => DB => PkgName -> File Abs
  Timestamp used to monitor if a local library has been
  modified and requires reinstalling.

  Totality: total
  Visibility: export
localSrcDir : Desc t -> Path Abs
  Directory where the sources of a local package are
  stored.

  Totality: total
  Visibility: export
pkgInstallDir : PackDirs => DB => PkgName -> Hash -> Package -> Desc t -> Path Abs
  Returns the directory where a package for the current
  package collection is installed.

  Totality: total
  Visibility: export
pkgDocs : PackDirs => DB => PkgName -> Hash -> Package -> Desc t -> Path Abs
  Directory where the API docs of the package will be installed.

  Totality: total
  Visibility: export
pkgExec : PackDirs => DB => PkgName -> Hash -> Package -> Body -> File Abs
  Location of an executable of the given name.

  Totality: total
  Visibility: export
resolvedExec : PackDirs => DB => ResolvedApp t -> File Abs
  Path to the executable of an Idris application

  Totality: total
  Visibility: export
packRepo : Config => URL
  URL of the pack repository to use

  Totality: total
  Visibility: export
packCommit : Config => Maybe Commit
  Commit of pack to use

  Totality: total
  Visibility: export
useRacket : Config => Bool
  True if the path to the scheme executable actually points
  to `racket`.

  Totality: total
  Visibility: export
bootstrapCmd : Config => String
  Bootstrap command to use

  Totality: total
  Visibility: export
prefixVar : PackDirs => DB => EnvVar
  `$PREFIX` variable during Idris2 installation, unquoted

  Totality: total
  Visibility: export
idrisBootVar : PackDirs => DB => EnvVar
  `$IDRIS2_BOOT` variable during Idris2 installation, unquoted

  Totality: total
  Visibility: export
schemeVar : Config => EnvVar
  `$SCHEME` variable during Idris2 installation, unquoted

  Totality: total
  Visibility: export
libInstallPrefix : PackDirs => DB => ResolvedLib t -> List EnvVar
  `IDRIS2_PREFIX` to be used with Idris when installing a library
  to a custom location.

  Totality: total
  Visibility: export
idrisCmd : Env => CmdArgList
  Idris executable with extra arguments, if they are present in the config.

  Totality: total
  Visibility: export
idrisWithCG : Env => CmdArgList
  Idris executable to use together with the
  `--cg` (codegen) command line option.

  Totality: total
  Visibility: export
getPackDirs : HasIO io => EitherT PackErr io PackDirs
  Return the path of the pack root directory,
  either from environment variable `$PACK_DIR`, or
  as `$HOME/.pack`.

  Totality: total
  Visibility: export
updateDB : HasIO io => TmpDir => PackDirs => EitherT PackErr io ()
  Update the package database.

  Totality: total
  Visibility: export
latestCollection : HasIO io => Path Abs -> EitherT PackErr io DBName
  Extract the name of the latest collection from a directory

  Totality: total
  Visibility: export
copyLatest : HasIO io => TmpDir => PackDirs => EitherT PackErr io DBName
  Update the package database.

  Totality: total
  Visibility: export
defaultColl : HasIO io => TmpDir => PackDirs => EitherT PackErr io DBName
  Loads the name of the default collection (currently the latest
  nightly)

  Totality: total
  Visibility: export
resolveMeta : HasIO io => PackDirs => Bool -> URL -> MetaCommit -> EitherT PackErr io Commit
  Resolve a meta commit by fetching the hash of the latest commit
  from a Git repo in case of an `Fetch x` commit. In case of a `Latest x`
  meta commit, the hash is only fetched, if the corresponding commit
  file is missing or `fetch` is set to `True`.

  Totality: total
  Visibility: export
collectionTomlContent : DBName -> String
  Content of pack-generated `pack.toml` containing the globally
  set pack collection.

  Totality: total
  Visibility: export
getConfig : (0 c : Type) -> {auto {conArg:7587} : Command c} -> ParsedArgs c -> HasIO io => PackDirs => TmpDir => EitherT PackErr io MetaConfig
  Read application config from command line arguments.

  Visibility: export
getLineBufferingCmd : HasIO io => io LineBufferingCmd
  Totality: total
  Visibility: export
loadDB : HasIO io => TmpDir => PackDirs => MetaConfig -> EitherT PackErr io MetaDB
  Load the package collection as given in the (auto-implicit) user config.

  Visibility: export
withCoreGit : HasIO io => Env => (Path Abs -> EitherT PackErr io a) -> EitherT PackErr io a
  Run a pack action in the directory of the cloned Idris repository.

  Totality: total
  Visibility: export
cacheCoreIpkgFiles : HasIO io => Env => Path Abs -> EitherT PackErr io ()
  Caches the `.ipkg` files of the core libraries to make them
  quickly available when running queries.

  Totality: total
  Visibility: export
notCached : HasIO io => Env => PkgName -> Package -> io Bool
  Totality: total
  Visibility: export
cachePkg : HasIO io => Env => PkgName -> Package -> EitherT PackErr io ()
  Totality: total
  Visibility: export
cachePkgs : HasIO io => Env => EitherT PackErr io PkgVersion
  Totality: total
  Visibility: export
env : HasIO io => PackDirs => TmpDir => LibCache => LineBufferingCmd => MetaConfig -> FetchMethod -> EitherT PackErr io Env
  Load the package collection as given in the (auto-implicit) user config
  and convert the result to a pack environment.

  Visibility: export
writeCollection : HasIO io => PackDirs => Config => EitherT PackErr io ()
  Update the `collection` field in file `PACK_DIR/user/pack.toml`
  with the name of the package collection given in config `c`.

  Visibility: export