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, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir)
- workDirFromDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir)
- distRelativeDir :: (MonadThrow m, MonadReader env m, 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
- inNixShellEnvVar :: String
- configCacheFile :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- configCabalMod :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- buildCacheFile :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- testSuccessFile :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)
- testBuiltFile :: (MonadThrow m, MonadReader env m, 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, HasEnvConfig env) => m (Path Rel Dir)
- hpcDirFromDir :: (MonadThrow m, MonadReader env m, 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
- compilerOptionsCabalFlag :: WhichCompiler -> String
Documentation
distDirFromDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir) #
Package's build artifacts directory.
workDirFromDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir) #
Package's working directory.
distRelativeDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Rel Dir) #
Relative location of build artifacts.
haskellModuleExts :: [Text] #
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.
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 #
The filename used for the stack config file.
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.
Arguments
:: (MonadThrow m, MonadReader env m, 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, 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, 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, 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, HasEnvConfig env) | |
=> Path Abs Dir | Package directory |
-> m (Path Abs File) |
The filename used to mark tests as having built
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.
hpcRelativeDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Rel Dir) #
Relative location of directory for HPC work.
Arguments
:: (MonadThrow m, MonadReader env m, 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) #
Output .o/.hi directory.
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