stack-2.14.0: The Haskell Tool Stack
Safe HaskellSafe-Inferred
LanguageGHC2021

Stack.Constants

Description

Constants used throughout the project.

Synopsis

Documentation

buildPlanDir Source #

Arguments

:: Path Abs Dir

Stack root

-> Path Abs Dir 

Path where build plans are stored.

buildPlanCacheDir Source #

Arguments

:: Path Abs Dir

Stack root

-> Path Abs Dir 

Path where binary caches of the build plans are stored.

haskellFileExts :: [Text] Source #

Extensions used for Haskell modules. Excludes preprocessor ones.

haskellDefaultPreprocessorExts :: [Text] Source #

Extensions for modules that are preprocessed by common preprocessors.

stackProgName :: String Source #

Name of the Stack program.

stackProgName' :: Text Source #

Name of the Stack program.

nixProgName :: String Source #

Name of the Nix package manager command

stackDotYaml :: Path Rel File Source #

The filename used for the Stack project-level configuration file.

stackWorkEnvVar :: String Source #

Environment variable used to override the '.stack-work' relative dir.

stackRootEnvVar :: String Source #

Environment variable used to override the '~/.stack' location.

stackXdgEnvVar :: String Source #

Environment variable used to indicate XDG directories should be used.

stackRootOptionName :: String Source #

Option name for the global Stack root.

stackGlobalConfigOptionName :: String Source #

Option name for the global Stack configuration file.

pantryRootEnvVar :: String Source #

Environment variable used to override the location of the Pantry store

inContainerEnvVar :: String Source #

Environment variable used to indicate Stack is running in container.

inNixShellEnvVar :: String Source #

Environment variable used to indicate Stack is running in container. although we already have STACK_IN_NIX_EXTRA_ARGS that is set in the same conditions, it can happen that STACK_IN_NIX_EXTRA_ARGS is set to empty.

stackProgNameUpper :: String Source #

Name of the stack program, uppercased

wiredInPackages :: Set PackageName Source #

The comment to 'see https://downloads.haskell.org/~ghc/7.10.1/docs/html/libraries/ghc/src/Module.html#integerPackageKey\' appears to be out of date.

See 'Note [About units]' and 'Wired-in units' at https://gitlab.haskell.org/ghc/ghc/-/blob/master/compiler/GHC/Unit.hs.

The 'wired-in packages' appear to have been replaced by those that have (e.g)

ghc-options: -this-unit-id ghc-prim

in their Cabal file because they are 'magic'.

cabalPackageName :: PackageName Source #

Just to avoid repetition and magic strings.

implicitGlobalProjectDirDeprecated Source #

Arguments

:: Path Abs Dir

Stack root.

-> Path Abs Dir 

Deprecated implicit global project directory used when outside of a project.

implicitGlobalProjectDir Source #

Arguments

:: Path Abs Dir

Stack root.

-> Path Abs Dir 

Implicit global project directory used when outside of a project. Normally, getImplicitGlobalProjectDir should be used instead.

defaultUserConfigPathDeprecated :: Path Abs Dir -> Path Abs File Source #

Deprecated default global config path.

defaultUserConfigPath :: Path Abs Dir -> Path Abs File Source #

Default global config path. Normally, getDefaultUserConfigPath should be used instead.

defaultGlobalConfigPathDeprecated :: Maybe (Path Abs File) Source #

Deprecated default global config path. Note that this will be Nothing on Windows, which is by design.

defaultGlobalConfigPath :: Maybe (Path Abs File) Source #

Default global config path. Normally, getDefaultGlobalConfigPath should be used instead. Note that this will be Nothing on Windows, which is by design.

platformVariantEnvVar :: String Source #

Environment variable that stores a variant to append to platform-specific directory names. Used to ensure incompatible binaries aren't shared between Docker builds and host

compilerOptionsCabalFlag :: WhichCompiler -> String Source #

Provides --ghc-options for Ghc

ghcColorForceFlag :: String Source #

The flag to pass to GHC when we want to force its output to be colorized.

minTerminalWidth :: Int Source #

The minimum allowed terminal width. Used for pretty-printing.

maxTerminalWidth :: Int Source #

The maximum allowed terminal width. Used for pretty-printing.

defaultTerminalWidth :: Int Source #

The default terminal width. Used for pretty-printing when we can't automatically detect it and when the user doesn't supply one.

osIsMacOS :: Bool Source #

False if using Windows.

osIsWindows :: Bool Source #

True if using Windows.

bindirSuffix :: Path Rel Dir Source #

Suffix applied to an installation root to get the bin dir

docDirSuffix :: Path Rel Dir Source #

Suffix applied to an installation root to get the doc dir

htmlDirSuffix :: Path Rel Dir Source #

Suffix applied to a path to get the html directory.

ghcBootScript :: Path Rel File Source #

Relative paths inside a GHC repo to the boot script.

ghcConfigureScript :: Path Rel File Source #

Relative paths inside a GHC repo to the configure script.

ghcConfigureWindows :: [String] Source #

Command applicable to GHC's configure script on Windows. See: https://gitlab.haskell.org/ghc/ghc/-/blob/master/hadrian/README.md

ghcConfigureMacOS :: [String] Source #

Command applicable to GHC's configure script on macOS. See: https://gitlab.haskell.org/ghc/ghc/-/blob/master/hadrian/README.md

ghcConfigurePosix :: [String] Source #

Command applicable to GHC's configure script on non-Windows, non-macOS. See: https://gitlab.haskell.org/ghc/ghc/-/blob/master/hadrian/README.md

hadrianScriptsWindows :: [Path Rel File] Source #

Relative paths inside a GHC repo to the Hadrian build batch script. The second path is maintained for compatibility with older GHC versions.

hadrianScriptsPosix :: [Path Rel File] Source #

Relative paths inside a GHC repo to the Hadrian build shell script The second path is maintained for compatibility with older GHC versions.

libDirs :: [Path Abs Dir] Source #

Used in Stack.Setup for detecting libc.musl-x86_64.so.1, see comments at use site

usrLibDirs :: [Path Abs Dir] Source #

Used in Stack.Setup for detecting libtinfo, see comments at use site

testGhcEnvRelFile :: Path Rel File Source #

Relative file path for a temporary GHC environment file for tests

relFileBuildLock :: Path Rel File Source #

File inside a dist directory to use for locking

stackDeveloperModeDefault :: Bool Source #

What should the default be for stack-developer-mode

isStackUploadDisabled :: Bool Source #

What should the default be for stack-developer-mode

globalFooter :: String Source #

The footer to the help for Stack's subcommands

gitHubBasicAuthType :: ByteString Source #

The type for GitHub REST API HTTP 'Basic' authentication.

gitHubTokenEnvVar :: String Source #

Environment variable to hold credentials for GitHub REST API HTTP 'Basic' authentication.

altGitHubTokenEnvVar :: String Source #

Alternate environment variable to hold credentials for GitHub REST API HTTP 'Basic' authentication.