Stack.Constants

Constants used throughout the project.

Documentation

buildPlanDir

Arguments

:: Path Abs Dir

Stack root

-> Path Abs Dir

Path where build plans are stored.

buildPlanCacheDir

Arguments

:: Path Abs Dir

Stack root

-> Path Abs Dir

Path where binary caches of the build plans are stored.

haskellModuleExts :: [Text]

Extensions for anything that can be a Haskell module.

stackDotYaml :: Path Rel File

The filename used for the stack config file.

stackWorkEnvVar :: String

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

stackRootEnvVar :: String

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

stackRootOptionName :: String

Option name for the global stack root.

deprecatedStackRootOptionName :: String

Deprecated option name for the global stack root.

Deprecated since stack-1.1.0.

TODO: Remove occurences of this variable and use stackRootOptionName only after an appropriate deprecation period.

inContainerEnvVar :: String

Environment variable used to indicate stack is running in container.

inNixShellEnvVar :: String

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.

stackProgName :: String

Name of the stack program.

stackProgNameUpper :: String

Name of the stack program, uppercased

wiredInPackages :: HashSet PackageName

ghcjsBootPackages :: HashSet PackageName

cabalPackageName :: PackageName

Just to avoid repetition and magic strings.

implicitGlobalProjectDirDeprecated

Arguments

:: Path Abs Dir

Stack root.

-> Path Abs Dir

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

implicitGlobalProjectDir

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

Deprecated default global config path.

defaultUserConfigPath :: Path Abs Dir -> Path Abs File

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

defaultGlobalConfigPathDeprecated :: Maybe (Path Abs File)

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

defaultGlobalConfigPath :: Maybe (Path Abs File)

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

platformVariantEnvVar :: String

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

Provides --ghc-options for Ghc, and similarly, --ghcjs-options for Ghcjs.

ghcColorForceFlag :: String

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

minTerminalWidth :: Int

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

maxTerminalWidth :: Int

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

defaultTerminalWidth :: Int

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

osIsWindows :: Bool

True if using Windows OS.