Safe Haskell | None |
---|---|
Language | Haskell2010 |
Stack.Constants
Description
Constants used throughout the project.
Synopsis
- buildPlanDir :: Path Abs Dir -> Path Abs Dir
- buildPlanCacheDir :: Path Abs Dir -> Path Abs Dir
- haskellModuleExts :: [Text]
- stackDotYaml :: Path Rel File
- stackWorkEnvVar :: String
- stackRootEnvVar :: String
- stackRootOptionName :: String
- deprecatedStackRootOptionName :: String
- inContainerEnvVar :: String
- inNixShellEnvVar :: String
- stackProgName :: String
- stackProgNameUpper :: String
- wiredInPackages :: HashSet PackageName
- ghcjsBootPackages :: HashSet PackageName
- cabalPackageName :: PackageName
- implicitGlobalProjectDirDeprecated :: Path Abs Dir -> Path Abs Dir
- implicitGlobalProjectDir :: Path Abs Dir -> Path Abs Dir
- defaultUserConfigPathDeprecated :: Path Abs Dir -> Path Abs File
- defaultUserConfigPath :: Path Abs Dir -> Path Abs File
- defaultGlobalConfigPathDeprecated :: Maybe (Path Abs File)
- defaultGlobalConfigPath :: Maybe (Path Abs File)
- platformVariantEnvVar :: String
- compilerOptionsCabalFlag :: WhichCompiler -> String
- ghcColorForceFlag :: String
- minTerminalWidth :: Int
- maxTerminalWidth :: Int
- defaultTerminalWidth :: Int
- osIsWindows :: Bool
Documentation
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.
Environment variable used to override the '.stack-work' relative dir.
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.
Environment variable used to indicate stack is running in container.
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
cabalPackageName :: PackageName #
Just to avoid repetition and magic strings.
implicitGlobalProjectDirDeprecated #
Deprecated implicit global project directory used when outside of a project.
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
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.
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.