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

Instances

Show BuildOpts

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

Methods

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

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

Show BuildCommand

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

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]

Instances

Show BuildOptsMonoid

Methods

showsPrec :: Int -> BuildOptsMonoid -> ShowS

show :: BuildOptsMonoid -> String

showList :: [BuildOptsMonoid] -> ShowS

Generic BuildOptsMonoid

Associated Types

type Rep BuildOptsMonoid :: * -> *

Methods

from :: BuildOptsMonoid -> Rep BuildOptsMonoid x

to :: Rep BuildOptsMonoid x -> BuildOptsMonoid

Semigroup BuildOptsMonoid

Methods

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

sconcat :: NonEmpty BuildOptsMonoid -> BuildOptsMonoid

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

Monoid BuildOptsMonoid

Methods

mempty :: BuildOptsMonoid

mappend :: BuildOptsMonoid -> BuildOptsMonoid -> BuildOptsMonoid

mconcat :: [BuildOptsMonoid] -> BuildOptsMonoid

FromJSON (WithJSONWarnings BuildOptsMonoid)

Methods

parseJSON :: Value -> Parser (WithJSONWarnings BuildOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings BuildOptsMonoid]

type Rep BuildOptsMonoid

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

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

Methods

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

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

Show TestOpts

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

Methods

showsPrec :: Int -> TestOptsMonoid -> ShowS

show :: TestOptsMonoid -> String

showList :: [TestOptsMonoid] -> ShowS

Generic TestOptsMonoid

Associated Types

type Rep TestOptsMonoid :: * -> *

Methods

from :: TestOptsMonoid -> Rep TestOptsMonoid x

to :: Rep TestOptsMonoid x -> TestOptsMonoid

Semigroup TestOptsMonoid

Methods

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

sconcat :: NonEmpty TestOptsMonoid -> TestOptsMonoid

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

Monoid TestOptsMonoid

Methods

mempty :: TestOptsMonoid

mappend :: TestOptsMonoid -> TestOptsMonoid -> TestOptsMonoid

mconcat :: [TestOptsMonoid] -> TestOptsMonoid

FromJSON (WithJSONWarnings TestOptsMonoid)

Methods

parseJSON :: Value -> Parser (WithJSONWarnings TestOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings TestOptsMonoid]

type Rep TestOptsMonoid

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

newtype HaddockOpts

 Haddock Options

Constructors

HaddockOpts

Fields

• hoAdditionalArgs :: [String]

  Arguments passed to haddock program

Instances

Eq HaddockOpts

Methods

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

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

Show HaddockOpts

Methods

showsPrec :: Int -> HaddockOpts -> ShowS

show :: HaddockOpts -> String

showList :: [HaddockOpts] -> ShowS

defaultHaddockOpts :: HaddockOpts

newtype HaddockOptsMonoid

Constructors

HaddockOptsMonoid

Fields

• hoMonoidAdditionalArgs :: [String]

Instances

Show HaddockOptsMonoid

Methods

showsPrec :: Int -> HaddockOptsMonoid -> ShowS

show :: HaddockOptsMonoid -> String

showList :: [HaddockOptsMonoid] -> ShowS

Generic HaddockOptsMonoid

Associated Types

type Rep HaddockOptsMonoid :: * -> *

Methods

from :: HaddockOptsMonoid -> Rep HaddockOptsMonoid x

to :: Rep HaddockOptsMonoid x -> HaddockOptsMonoid

Semigroup HaddockOptsMonoid

Methods

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

sconcat :: NonEmpty HaddockOptsMonoid -> HaddockOptsMonoid

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

Monoid HaddockOptsMonoid

Methods

mempty :: HaddockOptsMonoid

mappend :: HaddockOptsMonoid -> HaddockOptsMonoid -> HaddockOptsMonoid

mconcat :: [HaddockOptsMonoid] -> HaddockOptsMonoid

FromJSON (WithJSONWarnings HaddockOptsMonoid)

Methods

parseJSON :: Value -> Parser (WithJSONWarnings HaddockOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings HaddockOptsMonoid]

type Rep HaddockOptsMonoid

type Rep HaddockOptsMonoid = D1 * (MetaData "HaddockOptsMonoid" "Stack.Types.Config.Build" "stack-1.7.1-8x9NSKj6gz3B3M9RWkyZVt" True) (C1 * (MetaCons "HaddockOptsMonoid" PrefixI True) (S1 * (MetaSel (Just Symbol "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

Methods

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

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

Show BenchmarkOpts

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

Methods

showsPrec :: Int -> BenchmarkOptsMonoid -> ShowS

show :: BenchmarkOptsMonoid -> String

showList :: [BenchmarkOptsMonoid] -> ShowS

Generic BenchmarkOptsMonoid

Associated Types

type Rep BenchmarkOptsMonoid :: * -> *

Methods

from :: BenchmarkOptsMonoid -> Rep BenchmarkOptsMonoid x

to :: Rep BenchmarkOptsMonoid x -> BenchmarkOptsMonoid

Semigroup BenchmarkOptsMonoid

Methods

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

sconcat :: NonEmpty BenchmarkOptsMonoid -> BenchmarkOptsMonoid

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

Monoid BenchmarkOptsMonoid

Methods

mempty :: BenchmarkOptsMonoid

mappend :: BenchmarkOptsMonoid -> BenchmarkOptsMonoid -> BenchmarkOptsMonoid

mconcat :: [BenchmarkOptsMonoid] -> BenchmarkOptsMonoid

FromJSON (WithJSONWarnings BenchmarkOptsMonoid)

Methods

parseJSON :: Value -> Parser (WithJSONWarnings BenchmarkOptsMonoid)

parseJSONList :: Value -> Parser [WithJSONWarnings BenchmarkOptsMonoid]

type Rep BenchmarkOptsMonoid

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

data FileWatchOpts

Constructors

NoFileWatch

FileWatch

FileWatchPoll

Instances

Eq FileWatchOpts

Methods

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

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

Show FileWatchOpts

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

Methods

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

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

Show BuildSubset

Methods

showsPrec :: Int -> BuildSubset -> ShowS

show :: BuildSubset -> String

showList :: [BuildSubset] -> ShowS