stack-0.1.0.0: 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.

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.

haskellFileExts :: [Text] Source

Extensions used for Haskell files.

projectDockerSandboxDir :: Path Abs Dir -> Path Abs Dir Source

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.

stackProgName :: String Source

Name of the stack program.

cabalPackageName :: PackageName Source

Just to avoid repetition and magic strings.

implicitGlobalDir Source

Arguments

:: Path Abs Dir

Stack root.

-> Path Abs Dir 

Implicit global directory used when outside of a project.

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.

dotHpc :: Path Rel Dir Source

Where .mix files go.