Safe Haskell	Safe-Inferred
Language	GHC2021

Stack.Types.BuildOpts

Description

Configuration options for building.

Synopsis

data BuildOpts = BuildOpts {
- libProfile :: !Bool
- exeProfile :: !Bool
- libStrip :: !Bool
- exeStrip :: !Bool
- buildHaddocks :: !Bool
- haddockOpts :: !HaddockOpts
- openHaddocks :: !Bool
- haddockDeps :: !(Maybe Bool)
- haddockInternal :: !Bool
- haddockHyperlinkSource :: !Bool
- haddockForHackage :: !Bool
- installExes :: !Bool
- installCompilerTool :: !Bool
- preFetch :: !Bool
- keepGoing :: !(Maybe Bool)
- keepTmpFiles :: !Bool
- forceDirty :: !Bool
- tests :: !Bool
- testOpts :: !TestOpts
- benchmarks :: !Bool
- benchmarkOpts :: !BenchmarkOpts
- reconfigure :: !Bool
- cabalVerbose :: !CabalVerbosity
- splitObjs :: !Bool
- skipComponents :: ![Text]
- interleavedOutput :: !Bool
- progressBar :: !ProgressBarFormat
- ddumpDir :: !(Maybe Text)
}
newtype HaddockOpts = HaddockOpts {
- additionalArgs :: [String]
}
data TestOpts = TestOpts {
- rerunTests :: !Bool
- additionalArgs :: ![String]
- coverage :: !Bool
- disableRun :: !Bool
- maximumTimeSeconds :: !(Maybe Int)
- allowStdin :: !Bool
}
data BenchmarkOpts = BenchmarkOpts {
- additionalArgs :: !(Maybe String)
- disableRun :: !Bool
}
buildOptsHaddockL :: Lens' BuildOpts Bool
buildOptsInstallExesL :: Lens' BuildOpts Bool

Documentation

data BuildOpts Source #

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

Constructors

BuildOpts

Fields

libProfile :: !Bool
exeProfile :: !Bool
libStrip :: !Bool
exeStrip :: !Bool
buildHaddocks :: !Bool
Build Haddock documentation?
haddockOpts :: !HaddockOpts
Options to pass to haddock
openHaddocks :: !Bool
Open haddocks in the browser?
haddockDeps :: !(Maybe Bool)
Build haddocks for dependencies?
haddockInternal :: !Bool
Build haddocks for all symbols and packages, like cabal haddock --internal
haddockHyperlinkSource :: !Bool
Build hyperlinked source. Disable for no sources.
haddockForHackage :: !Bool
Build with flags to generate Haddock documentation suitable to upload to Hackage.
installExes :: !Bool
Install executables to user path after building?
installCompilerTool :: !Bool
Install executables to compiler tools path after building?
preFetch :: !Bool
Fetch all packages immediately ^ Watch files for changes and automatically rebuild
keepGoing :: !(Maybe Bool)
Keep building/running after failure
keepTmpFiles :: !Bool
Keep intermediate files and build directories
forceDirty :: !Bool
Force treating all local packages as having dirty files
tests :: !Bool
Turn on tests for local targets
testOpts :: !TestOpts
Additional test arguments
benchmarks :: !Bool
Turn on benchmarks for local targets
benchmarkOpts :: !BenchmarkOpts
Additional test arguments ^ Commands (with arguments) to run after a successful build ^ Only perform the configure step when building
reconfigure :: !Bool
Perform the configure step even if already configured
cabalVerbose :: !CabalVerbosity
Ask Cabal to be verbose in its builds
splitObjs :: !Bool
Whether to enable split-objs.
skipComponents :: ![Text]
Which components to skip when building
interleavedOutput :: !Bool
Should we use the interleaved GHC output when building multiple packages?
progressBar :: !ProgressBarFormat
Format of the progress bar
ddumpDir :: !(Maybe Text)

Instances

Instances details

Show BuildOpts Source #
Instance details Defined in Stack.Types.BuildOpts Methods showsPrec :: Int -> BuildOpts -> ShowS # show :: BuildOpts -> String # showList :: [BuildOpts] -> ShowS #

newtype HaddockOpts Source #

Haddock Options

Constructors

HaddockOpts
Fields additionalArgs :: [String] Arguments passed to haddock program

Instances

Instances details

Show HaddockOpts Source #
Instance details Defined in Stack.Types.BuildOpts Methods showsPrec :: Int -> HaddockOpts -> ShowS # show :: HaddockOpts -> String # showList :: [HaddockOpts] -> ShowS #
Eq HaddockOpts Source #
Instance details Defined in Stack.Types.BuildOpts Methods (==) :: HaddockOpts -> HaddockOpts -> Bool # (/=) :: HaddockOpts -> HaddockOpts -> Bool #

data TestOpts Source #

Options for the FinalAction DoTests

Constructors

TestOpts
Fields rerunTests :: !Bool Whether successful tests will be run gain additionalArgs :: ![String] Arguments passed to the test program coverage :: !Bool Generate a code coverage report disableRun :: !Bool Disable running of tests maximumTimeSeconds :: !(Maybe Int) test suite timeout in seconds allowStdin :: !Bool Whether to allow standard input

Instances

Instances details

Show TestOpts Source #
Instance details Defined in Stack.Types.BuildOpts Methods showsPrec :: Int -> TestOpts -> ShowS # show :: TestOpts -> String # showList :: [TestOpts] -> ShowS #
Eq TestOpts Source #
Instance details Defined in Stack.Types.BuildOpts Methods (==) :: TestOpts -> TestOpts -> Bool # (/=) :: TestOpts -> TestOpts -> Bool #

data BenchmarkOpts Source #

Options for the FinalAction DoBenchmarks

Constructors

BenchmarkOpts
Fields additionalArgs :: !(Maybe String) Arguments passed to the benchmark program disableRun :: !Bool Disable running of benchmarks

Instances

Instances details

Show BenchmarkOpts Source #
Instance details Defined in Stack.Types.BuildOpts Methods showsPrec :: Int -> BenchmarkOpts -> ShowS # show :: BenchmarkOpts -> String # showList :: [BenchmarkOpts] -> ShowS #
Eq BenchmarkOpts Source #
Instance details Defined in Stack.Types.BuildOpts Methods (==) :: BenchmarkOpts -> BenchmarkOpts -> Bool # (/=) :: BenchmarkOpts -> BenchmarkOpts -> Bool #

buildOptsHaddockL :: Lens' BuildOpts Bool Source #

buildOptsInstallExesL :: Lens' BuildOpts Bool Source #