stack-1.4.0: The Haskell Tool Stack

Safe Haskell | None
Language | Haskell2010

Stack.Types.Config.Build

Description

Configuration options for building.

Synopsis

- data BuildOpts = BuildOpts {
  - boptsLibProfile :: !Bool
  - boptsExeProfile :: !Bool
  - boptsLibStrip :: !Bool
  - boptsExeStrip :: !Bool
  - boptsHaddock :: !Bool
  - boptsHaddockOpts :: !HaddockOpts
  - boptsOpenHaddocks :: !Bool
  - boptsHaddockDeps :: !(Maybe Bool)
  - boptsHaddockInternal :: !Bool
  - boptsInstallExes :: !Bool
  - boptsPreFetch :: !Bool
  - boptsKeepGoing :: !(Maybe Bool)
  - boptsForceDirty :: !Bool
  - boptsTests :: !Bool
  - boptsTestOpts :: !TestOpts
  - boptsBenchmarks :: !Bool
  - boptsBenchmarkOpts :: !BenchmarkOpts
  - boptsReconfigure :: !Bool
  - boptsCabalVerbose :: !Bool
  - boptsSplitObjs :: !Bool
  }
- data BuildCommand
  - = Build
  - | Test
  - | Haddock
  - | Bench
  - | Install
- defaultBuildOpts :: BuildOpts
- defaultBuildOptsCLI :: BuildOptsCLI
- data BuildOptsCLI = BuildOptsCLI {
  - 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
  }
- data BuildOptsMonoid = BuildOptsMonoid {
  - 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)
  - buildMonoidInstallExes :: !(First Bool)
  - buildMonoidPreFetch :: !(First Bool)
  - buildMonoidKeepGoing :: !(First Bool)
  - buildMonoidForceDirty :: !(First Bool)
  - buildMonoidTests :: !(First Bool)
  - buildMonoidTestOpts :: !TestOptsMonoid
  - buildMonoidBenchmarks :: !(First Bool)
  - buildMonoidBenchmarkOpts :: !BenchmarkOptsMonoid
  - buildMonoidReconfigure :: !(First Bool)
  - buildMonoidCabalVerbose :: !(First Bool)
  - buildMonoidSplitObjs :: !(First Bool)
  }
- data TestOpts = TestOpts {
  - toRerunTests :: !Bool
  - toAdditionalArgs :: ![String]
  - toCoverage :: !Bool
  - toDisableRun :: !Bool
  }
- defaultTestOpts :: TestOpts
- data TestOptsMonoid = TestOptsMonoid {
  - toMonoidRerunTests :: !(First Bool)
  - toMonoidAdditionalArgs :: ![String]
  - toMonoidCoverage :: !(First Bool)
  - toMonoidDisableRun :: !(First Bool)
  }
- newtype HaddockOpts = HaddockOpts {
  - hoAdditionalArgs :: [String]
  }
- defaultHaddockOpts :: HaddockOpts
- newtype HaddockOptsMonoid = HaddockOptsMonoid {
  - hoMonoidAdditionalArgs :: [String]
  }
- data BenchmarkOpts = BenchmarkOpts {
  - beoAdditionalArgs :: !(Maybe String)
  - beoDisableRun :: !Bool
  }
- defaultBenchmarkOpts :: BenchmarkOpts
- data BenchmarkOptsMonoid = BenchmarkOptsMonoid {
  - beoMonoidAdditionalArgs :: !(First String)
  - beoMonoidDisableRun :: !(First Bool)
  }
- data FileWatchOpts
  - = NoFileWatch
  - | FileWatch
  - | FileWatchPoll
- data BuildSubset
  - = BSAll
  - | BSOnlySnapshot
  - | BSOnlyDependencies

# 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` boptsInstallExes :: !Bool Install executables to user path after building? boptsPreFetch :: !Bool Fetch all packages immediately ^ Watch files for changes and automatically rebuild boptsKeepGoing :: !(Maybe Bool) Keep building/running after failure 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.

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 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) buildMonoidInstallExes :: !(First Bool) buildMonoidPreFetch :: !(First Bool) buildMonoidKeepGoing :: !(First Bool) buildMonoidForceDirty :: !(First Bool) buildMonoidTests :: !(First Bool) buildMonoidTestOpts :: !TestOptsMonoid buildMonoidBenchmarks :: !(First Bool) buildMonoidBenchmarkOpts :: !BenchmarkOptsMonoid buildMonoidReconfigure :: !(First Bool) buildMonoidCabalVerbose :: !(First Bool) buildMonoidSplitObjs :: !(First Bool)

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 #
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.4.0-5VbagGyw9hyAgBJq8WQvrq" False) (C1 (MetaCons "BuildOptsMonoid" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (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 "buildMonoidInstallExes") 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 "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)))))))))

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 #
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.4.0-5VbagGyw9hyAgBJq8WQvrq" 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 #
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.4.0-5VbagGyw9hyAgBJq8WQvrq" 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 #
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.4.0-5VbagGyw9hyAgBJq8WQvrq" 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 #