stack-0.1.10.1: The Haskell Tool Stack

Safe HaskellNone
LanguageHaskell2010

Stack.Constants

Description

Constants used throughout the project.

Synopsis

Documentation

builtConfigFileFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File) Source

The filename used for completed build indicators.

builtFileFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File) Source

The filename used for completed build indicators.

buildPlanDir Source

Arguments

:: Path Abs Dir

Stack root

-> Path Abs Dir 

Path where build plans are stored.

configuredFileFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File) Source

The filename used for completed configure indicators.

defaultShakeThreads :: Int Source

Default shake thread count for parallel builds.

distDirFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir) Source

Package's build artifacts 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.

imageStagingDir Source

Arguments

:: (MonadReader env m, HasConfig env) 
=> Path Abs Dir

Project root

-> 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.

rawGithubUrl Source

Arguments

:: Text

user/org name

-> Text

repo name

-> Text

branch name

-> Text

filename

-> Text 

Get a URL for a raw file on Github

stackDotYaml :: Path Rel File Source

The filename used for the stack config file.

stackRootEnvVar :: String Source

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

userDocsDir :: Config -> Path Abs Dir Source

User documentation directory.

configCacheFile Source

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.

configCabalMod Source

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

buildCacheFile Source

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.

testSuccessFile Source

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

testBuiltFile Source

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

benchBuiltFile Source

Arguments

:: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) 
=> Path Abs Dir

Package directory

-> m (Path Abs File) 

The filename used to mark benchmarks 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

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.

hpcRelativeDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => m (Path Rel Dir) Source

Relative location of directory for HPC work.

hpcDirFromDir Source

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.

templatesDir :: Config -> Path Abs Dir Source

Directory for project templates.

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