| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Stack.Constants
Description
Constants used throughout the project.
- buildPlanDir :: Path Abs Dir -> Path Abs Dir
- distDirFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir)
- workDirFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir)
- distRelativeDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => m (Path Rel Dir)
- haskellModuleExts :: [Text]
- imageStagingDir :: (MonadReader env m, HasConfig env, MonadThrow m) => Path Abs Dir -> Int -> m (Path Abs Dir)
- projectDockerSandboxDir :: (MonadReader env m, HasConfig env) => Path Abs Dir -> m (Path Abs Dir)
- stackDotYaml :: Path Rel File
- stackRootEnvVar :: String
- stackRootOptionName :: String
- deprecatedStackRootOptionName :: String
- inContainerEnvVar :: String
- configCacheFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- configCabalMod :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- buildCacheFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- testSuccessFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- testBuiltFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- 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
- hpcRelativeDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => m (Path Rel Dir)
- hpcDirFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir)
- objectInterfaceDir :: (MonadReader env m, HasConfig env) => BuildConfig -> m (Path Abs Dir)
- templatesDir :: Config -> 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
Documentation
Path where build plans are stored.
distDirFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir) Source
Package's build artifacts directory.
workDirFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir) Source
Package's working directory.
distRelativeDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => m (Path Rel Dir) Source
Relative location of build artifacts.
haskellModuleExts :: [Text] Source
Extensions for anything that can be a Haskell module.
Arguments
| :: (MonadReader env m, HasConfig env, MonadThrow m) | |
| => Path Abs Dir | Project root |
| -> Int | Index of image |
| -> m (Path Abs Dir) | Docker sandbox |
Image staging dir from project root.
projectDockerSandboxDir Source
Arguments
| :: (MonadReader env m, HasConfig env) | |
| => Path Abs Dir | Project root |
| -> m (Path Abs Dir) | Docker sandbox |
Docker sandbox from project root.
stackDotYaml :: Path Rel File Source
The filename used for the stack config file.
stackRootEnvVar :: String Source
Environment variable used to override the '~/.stack' location.
stackRootOptionName :: String Source
Option name for the global stack root.
deprecatedStackRootOptionName :: String Source
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 Source
Environment variable used to indicate stack is running in container.
Arguments
| :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) | |
| => Path Abs Dir | Package directory. |
| -> m (Path Abs File) |
The filename used for dirtiness check of config.
Arguments
| :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) | |
| => Path Abs Dir | Package directory. |
| -> m (Path Abs File) |
The filename used for modification check of .cabal
Arguments
| :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) | |
| => Path Abs Dir | Package directory. |
| -> m (Path Abs File) |
The filename used for dirtiness check of source files.
Arguments
| :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) | |
| => Path Abs Dir | Package directory |
| -> m (Path Abs File) |
The filename used to mark tests as having succeeded
Arguments
| :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) | |
| => Path Abs Dir | Package directory |
| -> m (Path Abs File) |
The filename used to mark tests as having built
stackProgName :: String Source
Name of the stack program.
stackProgNameUpper :: String Source
Name of the stack program, uppercased
cabalPackageName :: PackageName Source
Just to avoid repetition and magic strings.
implicitGlobalProjectDirDeprecated Source
Deprecated implicit global project directory used when outside of a project.
implicitGlobalProjectDir Source
Implicit global project directory used when outside of a project.
Normally, getImplicitGlobalProjectDir should be used instead.
hpcRelativeDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => m (Path Rel Dir) Source
Relative location of directory for HPC work.
Arguments
| :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) | |
| => Path Abs Dir | Package directory. |
| -> m (Path Abs Dir) |
Directory for HPC work.
objectInterfaceDir :: (MonadReader env m, HasConfig env) => BuildConfig -> m (Path Abs Dir) Source
Output .o/.hi directory.
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