Stack.Types.Config.Build

Configuration options for building.

Documentation

data BuildOpts

Build options that is interpreted by the build command. This is built up from BuildOptsCLI and BuildOptsMonoid

Constructors

BuildOpts

Fields

• boptsLibProfile :: !Bool
• boptsExeProfile :: !Bool
• boptsLibStrip :: !Bool
• boptsExeStrip :: !Bool
• boptsHaddock :: !Bool

  Build haddocks?

• boptsHaddockOpts :: !HaddockOpts

  Options to pass to haddock

• boptsOpenHaddocks :: !Bool

  Open haddocks in the browser?

• boptsHaddockDeps :: !(Maybe Bool)

  Build haddocks for dependencies?

• boptsHaddockInternal :: !Bool

  Build haddocks for all symbols and packages, like cabal haddock --internal

• boptsHaddockHyperlinkSource :: !Bool

  Build hyperlinked source if possible. Fallback to hscolour. Disable for no sources.

• boptsInstallExes :: !Bool

  Install executables to user path after building?

• boptsInstallCompilerTool :: !Bool

  Install executables to compiler tools path after building?

• boptsPreFetch :: !Bool

  Fetch all packages immediately ^ Watch files for changes and automatically rebuild

• boptsKeepGoing :: !(Maybe Bool)

  Keep building/running after failure

• boptsKeepTmpFiles :: !(Maybe Bool)

  Keep intermediate files and build directories

• boptsForceDirty :: !Bool

  Force treating all local packages as having dirty files

• boptsTests :: !Bool

  Turn on tests for local targets

• boptsTestOpts :: !TestOpts

  Additional test arguments

• boptsBenchmarks :: !Bool

  Turn on benchmarks for local targets

• boptsBenchmarkOpts :: !BenchmarkOpts

  Additional test arguments ^ Commands (with arguments) to run after a successful build ^ Only perform the configure step when building

• boptsReconfigure :: !Bool

  Perform the configure step even if already configured

• boptsCabalVerbose :: !Bool

  Ask Cabal to be verbose in its builds

• boptsSplitObjs :: !Bool

  Whether to enable split-objs.

• boptsSkipComponents :: ![Text]

  Which components to skip when building

• boptsInterleavedOutput :: !Bool

  Should we use the interleaved GHC output when building multiple packages?

Instances

Show BuildOpts

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> BuildOpts -> ShowS

show :: BuildOpts -> String

showList :: [BuildOpts] -> ShowS

data BuildCommand

Command sum type for conditional arguments.

Constructors

Build

Test

Haddock

Bench

Install

Instances

Eq BuildCommand

Defined in Stack.Types.Config.Build

Methods

(==) :: BuildCommand -> BuildCommand -> Bool

(/=) :: BuildCommand -> BuildCommand -> Bool

Show BuildCommand

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> BuildCommand -> ShowS

show :: BuildCommand -> String

showList :: [BuildCommand] -> ShowS

defaultBuildOpts :: BuildOpts

defaultBuildOptsCLI :: BuildOptsCLI

data BuildOptsCLI

Build options that may only be specified from the CLI

Constructors

BuildOptsCLI

Fields

• boptsCLITargets :: ![Text]
• boptsCLIDryrun :: !Bool
• boptsCLIGhcOptions :: ![Text]
• boptsCLIFlags :: !(Map (Maybe PackageName) (Map FlagName Bool))
• boptsCLIBuildSubset :: !BuildSubset
• boptsCLIFileWatch :: !FileWatchOpts
• boptsCLIExec :: ![(String, [String])]
• boptsCLIOnlyConfigure :: !Bool
• boptsCLICommand :: !BuildCommand
• boptsCLIInitialBuildSteps :: !Bool

Instances

Show BuildOptsCLI

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> BuildOptsCLI -> ShowS

show :: BuildOptsCLI -> String

showList :: [BuildOptsCLI] -> ShowS

data BuildOptsMonoid

Build options that may be specified in the stack.yaml or from the CLI

Constructors

BuildOptsMonoid

Fields

• buildMonoidTrace :: !Any
• buildMonoidProfile :: !Any
• buildMonoidNoStrip :: !Any
• buildMonoidLibProfile :: !(First Bool)
• buildMonoidExeProfile :: !(First Bool)
• buildMonoidLibStrip :: !(First Bool)
• buildMonoidExeStrip :: !(First Bool)
• buildMonoidHaddock :: !(First Bool)
• buildMonoidHaddockOpts :: !HaddockOptsMonoid
• buildMonoidOpenHaddocks :: !(First Bool)
• buildMonoidHaddockDeps :: !(First Bool)
• buildMonoidHaddockInternal :: !(First Bool)
• buildMonoidHaddockHyperlinkSource :: !(First Bool)
• buildMonoidInstallExes :: !(First Bool)
• buildMonoidInstallCompilerTool :: !(First Bool)
• buildMonoidPreFetch :: !(First Bool)
• buildMonoidKeepGoing :: !(First Bool)
• buildMonoidKeepTmpFiles :: !(First Bool)
• buildMonoidForceDirty :: !(First Bool)
• buildMonoidTests :: !(First Bool)
• buildMonoidTestOpts :: !TestOptsMonoid
• buildMonoidBenchmarks :: !(First Bool)
• buildMonoidBenchmarkOpts :: !BenchmarkOptsMonoid
• buildMonoidReconfigure :: !(First Bool)
• buildMonoidCabalVerbose :: !(First Bool)
• buildMonoidSplitObjs :: !(First Bool)
• buildMonoidSkipComponents :: ![Text]
• buildMonoidInterleavedOutput :: !(First Bool)

Instances

Show BuildOptsMonoid

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> BuildOptsMonoid -> ShowS

show :: BuildOptsMonoid -> String

showList :: [BuildOptsMonoid] -> ShowS

Generic BuildOptsMonoid

Defined in Stack.Types.Config.Build

Associated Types

type Rep BuildOptsMonoid :: Type -> Type

Methods

from :: BuildOptsMonoid -> Rep BuildOptsMonoid x

to :: Rep BuildOptsMonoid x -> BuildOptsMonoid

Semigroup BuildOptsMonoid

Defined in Stack.Types.Config.Build

Methods

(<>) :: BuildOptsMonoid -> BuildOptsMonoid -> BuildOptsMonoid

sconcat :: NonEmpty BuildOptsMonoid -> BuildOptsMonoid

stimes :: Integral b => b -> BuildOptsMonoid -> BuildOptsMonoid

Monoid BuildOptsMonoid

Defined in Stack.Types.Config.Build

Methods

mempty :: BuildOptsMonoid

mappend :: BuildOptsMonoid -> BuildOptsMonoid -> BuildOptsMonoid

mconcat :: [BuildOptsMonoid] -> BuildOptsMonoid

FromJSON (WithJSONWarnings BuildOptsMonoid)

Defined in Stack.Types.Config.Build

Methods

parseJSON :: Value -> Parser (WithJSONWarnings BuildOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings BuildOptsMonoid]

type Rep BuildOptsMonoid

Defined in Stack.Types.Config.Build

type Rep BuildOptsMonoid = D1 (MetaData "BuildOptsMonoid" "Stack.Types.Config.Build" "stack-1.9.3-A8b1pQY9CjdHmL7IWv3q9b" False) (C1 (MetaCons "BuildOptsMonoid" PrefixI True) ((((S1 (MetaSel (Just "buildMonoidTrace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Any) :*: (S1 (MetaSel (Just "buildMonoidProfile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Any) :*: S1 (MetaSel (Just "buildMonoidNoStrip") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Any))) :*: ((S1 (MetaSel (Just "buildMonoidLibProfile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "buildMonoidExeProfile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) :*: (S1 (MetaSel (Just "buildMonoidLibStrip") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "buildMonoidExeStrip") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))))) :*: ((S1 (MetaSel (Just "buildMonoidHaddock") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: (S1 (MetaSel (Just "buildMonoidHaddockOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 HaddockOptsMonoid) :*: S1 (MetaSel (Just "buildMonoidOpenHaddocks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))) :*: ((S1 (MetaSel (Just "buildMonoidHaddockDeps") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "buildMonoidHaddockInternal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) :*: (S1 (MetaSel (Just "buildMonoidHaddockHyperlinkSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "buildMonoidInstallExes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))))) :*: (((S1 (MetaSel (Just "buildMonoidInstallCompilerTool") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: (S1 (MetaSel (Just "buildMonoidPreFetch") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "buildMonoidKeepGoing") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))) :*: ((S1 (MetaSel (Just "buildMonoidKeepTmpFiles") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "buildMonoidForceDirty") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) :*: (S1 (MetaSel (Just "buildMonoidTests") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "buildMonoidTestOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 TestOptsMonoid)))) :*: ((S1 (MetaSel (Just "buildMonoidBenchmarks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: (S1 (MetaSel (Just "buildMonoidBenchmarkOpts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 BenchmarkOptsMonoid) :*: S1 (MetaSel (Just "buildMonoidReconfigure") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))) :*: ((S1 (MetaSel (Just "buildMonoidCabalVerbose") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "buildMonoidSplitObjs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))) :*: (S1 (MetaSel (Just "buildMonoidSkipComponents") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text]) :*: S1 (MetaSel (Just "buildMonoidInterleavedOutput") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))))))))

data TestOpts

Options for the FinalAction DoTests

Constructors

TestOpts

Fields

• toRerunTests :: !Bool

  Whether successful tests will be run gain

• toAdditionalArgs :: ![String]

  Arguments passed to the test program

• toCoverage :: !Bool

  Generate a code coverage report

• toDisableRun :: !Bool

  Disable running of tests

Instances

Eq TestOpts

Defined in Stack.Types.Config.Build

Methods

(==) :: TestOpts -> TestOpts -> Bool

(/=) :: TestOpts -> TestOpts -> Bool

Show TestOpts

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> TestOpts -> ShowS

show :: TestOpts -> String

showList :: [TestOpts] -> ShowS

defaultTestOpts :: TestOpts

data TestOptsMonoid

Constructors

TestOptsMonoid

Fields

• toMonoidRerunTests :: !(First Bool)
• toMonoidAdditionalArgs :: ![String]
• toMonoidCoverage :: !(First Bool)
• toMonoidDisableRun :: !(First Bool)

Instances

Show TestOptsMonoid

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> TestOptsMonoid -> ShowS

show :: TestOptsMonoid -> String

showList :: [TestOptsMonoid] -> ShowS

Generic TestOptsMonoid

Defined in Stack.Types.Config.Build

Associated Types

type Rep TestOptsMonoid :: Type -> Type

Methods

from :: TestOptsMonoid -> Rep TestOptsMonoid x

to :: Rep TestOptsMonoid x -> TestOptsMonoid

Semigroup TestOptsMonoid

Defined in Stack.Types.Config.Build

Methods

(<>) :: TestOptsMonoid -> TestOptsMonoid -> TestOptsMonoid

sconcat :: NonEmpty TestOptsMonoid -> TestOptsMonoid

stimes :: Integral b => b -> TestOptsMonoid -> TestOptsMonoid

Monoid TestOptsMonoid

Defined in Stack.Types.Config.Build

Methods

mempty :: TestOptsMonoid

mappend :: TestOptsMonoid -> TestOptsMonoid -> TestOptsMonoid

mconcat :: [TestOptsMonoid] -> TestOptsMonoid

FromJSON (WithJSONWarnings TestOptsMonoid)

Defined in Stack.Types.Config.Build

Methods

parseJSON :: Value -> Parser (WithJSONWarnings TestOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings TestOptsMonoid]

type Rep TestOptsMonoid

Defined in Stack.Types.Config.Build

type Rep TestOptsMonoid = D1 (MetaData "TestOptsMonoid" "Stack.Types.Config.Build" "stack-1.9.3-A8b1pQY9CjdHmL7IWv3q9b" False) (C1 (MetaCons "TestOptsMonoid" PrefixI True) ((S1 (MetaSel (Just "toMonoidRerunTests") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "toMonoidAdditionalArgs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [String])) :*: (S1 (MetaSel (Just "toMonoidCoverage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)) :*: S1 (MetaSel (Just "toMonoidDisableRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool)))))

newtype HaddockOpts

Haddock Options

Constructors

HaddockOpts

Fields

• hoAdditionalArgs :: [String]

  Arguments passed to haddock program

Instances

Eq HaddockOpts

Defined in Stack.Types.Config.Build

Methods

(==) :: HaddockOpts -> HaddockOpts -> Bool

(/=) :: HaddockOpts -> HaddockOpts -> Bool

Show HaddockOpts

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> HaddockOpts -> ShowS

show :: HaddockOpts -> String

showList :: [HaddockOpts] -> ShowS

defaultHaddockOpts :: HaddockOpts

newtype HaddockOptsMonoid

Constructors

HaddockOptsMonoid

Fields

• hoMonoidAdditionalArgs :: [String]

Instances

Show HaddockOptsMonoid

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> HaddockOptsMonoid -> ShowS

show :: HaddockOptsMonoid -> String

showList :: [HaddockOptsMonoid] -> ShowS

Generic HaddockOptsMonoid

Defined in Stack.Types.Config.Build

Associated Types

type Rep HaddockOptsMonoid :: Type -> Type

Methods

from :: HaddockOptsMonoid -> Rep HaddockOptsMonoid x

to :: Rep HaddockOptsMonoid x -> HaddockOptsMonoid

Semigroup HaddockOptsMonoid

Defined in Stack.Types.Config.Build

Methods

(<>) :: HaddockOptsMonoid -> HaddockOptsMonoid -> HaddockOptsMonoid

sconcat :: NonEmpty HaddockOptsMonoid -> HaddockOptsMonoid

stimes :: Integral b => b -> HaddockOptsMonoid -> HaddockOptsMonoid

Monoid HaddockOptsMonoid

Defined in Stack.Types.Config.Build

Methods

mempty :: HaddockOptsMonoid

mappend :: HaddockOptsMonoid -> HaddockOptsMonoid -> HaddockOptsMonoid

mconcat :: [HaddockOptsMonoid] -> HaddockOptsMonoid

FromJSON (WithJSONWarnings HaddockOptsMonoid)

Defined in Stack.Types.Config.Build

Methods

parseJSON :: Value -> Parser (WithJSONWarnings HaddockOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings HaddockOptsMonoid]

type Rep HaddockOptsMonoid

Defined in Stack.Types.Config.Build

type Rep HaddockOptsMonoid = D1 (MetaData "HaddockOptsMonoid" "Stack.Types.Config.Build" "stack-1.9.3-A8b1pQY9CjdHmL7IWv3q9b" True) (C1 (MetaCons "HaddockOptsMonoid" PrefixI True) (S1 (MetaSel (Just "hoMonoidAdditionalArgs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))

data BenchmarkOpts

Options for the FinalAction DoBenchmarks

Constructors

BenchmarkOpts

Fields

• beoAdditionalArgs :: !(Maybe String)

  Arguments passed to the benchmark program

• beoDisableRun :: !Bool

  Disable running of benchmarks

Instances

Eq BenchmarkOpts

Defined in Stack.Types.Config.Build

Methods

(==) :: BenchmarkOpts -> BenchmarkOpts -> Bool

(/=) :: BenchmarkOpts -> BenchmarkOpts -> Bool

Show BenchmarkOpts

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> BenchmarkOpts -> ShowS

show :: BenchmarkOpts -> String

showList :: [BenchmarkOpts] -> ShowS

defaultBenchmarkOpts :: BenchmarkOpts

data BenchmarkOptsMonoid

Constructors

BenchmarkOptsMonoid

Fields

• beoMonoidAdditionalArgs :: !(First String)
• beoMonoidDisableRun :: !(First Bool)

Instances

Show BenchmarkOptsMonoid

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> BenchmarkOptsMonoid -> ShowS

show :: BenchmarkOptsMonoid -> String

showList :: [BenchmarkOptsMonoid] -> ShowS

Generic BenchmarkOptsMonoid

Defined in Stack.Types.Config.Build

Associated Types

type Rep BenchmarkOptsMonoid :: Type -> Type

Methods

from :: BenchmarkOptsMonoid -> Rep BenchmarkOptsMonoid x

to :: Rep BenchmarkOptsMonoid x -> BenchmarkOptsMonoid

Semigroup BenchmarkOptsMonoid

Defined in Stack.Types.Config.Build

Methods

(<>) :: BenchmarkOptsMonoid -> BenchmarkOptsMonoid -> BenchmarkOptsMonoid

sconcat :: NonEmpty BenchmarkOptsMonoid -> BenchmarkOptsMonoid

stimes :: Integral b => b -> BenchmarkOptsMonoid -> BenchmarkOptsMonoid

Monoid BenchmarkOptsMonoid

Defined in Stack.Types.Config.Build

Methods

mempty :: BenchmarkOptsMonoid

mappend :: BenchmarkOptsMonoid -> BenchmarkOptsMonoid -> BenchmarkOptsMonoid

mconcat :: [BenchmarkOptsMonoid] -> BenchmarkOptsMonoid

FromJSON (WithJSONWarnings BenchmarkOptsMonoid)

Defined in Stack.Types.Config.Build

Methods

parseJSON :: Value -> Parser (WithJSONWarnings BenchmarkOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings BenchmarkOptsMonoid]

type Rep BenchmarkOptsMonoid

Defined in Stack.Types.Config.Build

type Rep BenchmarkOptsMonoid = D1 (MetaData "BenchmarkOptsMonoid" "Stack.Types.Config.Build" "stack-1.9.3-A8b1pQY9CjdHmL7IWv3q9b" False) (C1 (MetaCons "BenchmarkOptsMonoid" PrefixI True) (S1 (MetaSel (Just "beoMonoidAdditionalArgs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First String)) :*: S1 (MetaSel (Just "beoMonoidDisableRun") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (First Bool))))

data FileWatchOpts

Constructors

NoFileWatch

FileWatch

FileWatchPoll

Instances

Eq FileWatchOpts

Defined in Stack.Types.Config.Build

Methods

(==) :: FileWatchOpts -> FileWatchOpts -> Bool

(/=) :: FileWatchOpts -> FileWatchOpts -> Bool

Show FileWatchOpts

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> FileWatchOpts -> ShowS

show :: FileWatchOpts -> String

showList :: [FileWatchOpts] -> ShowS

data BuildSubset

Which subset of packages to build

Constructors

BSAll

BSOnlySnapshot

Only install packages in the snapshot database, skipping packages intended for the local database.

BSOnlyDependencies

Instances

Eq BuildSubset

Defined in Stack.Types.Config.Build

Methods

(==) :: BuildSubset -> BuildSubset -> Bool

(/=) :: BuildSubset -> BuildSubset -> Bool

Show BuildSubset

Defined in Stack.Types.Config.Build

Methods

showsPrec :: Int -> BuildSubset -> ShowS

show :: BuildSubset -> String

showList :: [BuildSubset] -> ShowS