Safe Haskell | Safe-Inferred |
---|---|
Language | GHC2021 |
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
- boptsHaddockHyperlinkSource :: !Bool
- boptsHaddockForHackage :: !Bool
- boptsInstallExes :: !Bool
- boptsInstallCompilerTool :: !Bool
- boptsPreFetch :: !Bool
- boptsKeepGoing :: !(Maybe Bool)
- boptsKeepTmpFiles :: !Bool
- boptsForceDirty :: !Bool
- boptsTests :: !Bool
- boptsTestOpts :: !TestOpts
- boptsBenchmarks :: !Bool
- boptsBenchmarkOpts :: !BenchmarkOpts
- boptsReconfigure :: !Bool
- boptsCabalVerbose :: !CabalVerbosity
- boptsSplitObjs :: !Bool
- boptsSkipComponents :: ![Text]
- boptsInterleavedOutput :: !Bool
- boptsProgressBar :: !ProgressBarFormat
- boptsDdumpDir :: !(Maybe Text)
- buildOptsHaddockL :: Lens' BuildOpts Bool
- buildOptsInstallExesL :: Lens' BuildOpts Bool
- data BuildCommand
- defaultBuildOpts :: BuildOpts
- defaultBuildOptsCLI :: BuildOptsCLI
- data BuildOptsCLI = BuildOptsCLI {
- boptsCLITargets :: ![Text]
- boptsCLIDryrun :: !Bool
- boptsCLIGhcOptions :: ![Text]
- boptsCLIProgsOptions :: ![(Text, [Text])]
- boptsCLIFlags :: !(Map ApplyCLIFlag (Map FlagName Bool))
- boptsCLIBuildSubset :: !BuildSubset
- boptsCLIFileWatch :: !FileWatchOpts
- boptsCLIWatchAll :: !Bool
- boptsCLIExec :: ![(String, [String])]
- boptsCLIOnlyConfigure :: !Bool
- boptsCLICommand :: !BuildCommand
- boptsCLIInitialBuildSteps :: !Bool
- boptsCLIAllProgOptions :: BuildOptsCLI -> [Text]
- data BuildOptsMonoid = BuildOptsMonoid {
- buildMonoidTrace :: !Any
- buildMonoidProfile :: !Any
- buildMonoidNoStrip :: !Any
- buildMonoidLibProfile :: !FirstFalse
- buildMonoidExeProfile :: !FirstFalse
- buildMonoidLibStrip :: !FirstTrue
- buildMonoidExeStrip :: !FirstTrue
- buildMonoidHaddock :: !FirstFalse
- buildMonoidHaddockOpts :: !HaddockOptsMonoid
- buildMonoidOpenHaddocks :: !FirstFalse
- buildMonoidHaddockDeps :: !(First Bool)
- buildMonoidHaddockInternal :: !FirstFalse
- buildMonoidHaddockHyperlinkSource :: !FirstTrue
- buildMonoidHaddockForHackage :: !FirstFalse
- buildMonoidInstallExes :: !FirstFalse
- buildMonoidInstallCompilerTool :: !FirstFalse
- buildMonoidPreFetch :: !FirstFalse
- buildMonoidKeepGoing :: !(First Bool)
- buildMonoidKeepTmpFiles :: !FirstFalse
- buildMonoidForceDirty :: !FirstFalse
- buildMonoidTests :: !FirstFalse
- buildMonoidTestOpts :: !TestOptsMonoid
- buildMonoidBenchmarks :: !FirstFalse
- buildMonoidBenchmarkOpts :: !BenchmarkOptsMonoid
- buildMonoidReconfigure :: !FirstFalse
- buildMonoidCabalVerbose :: !(First CabalVerbosity)
- buildMonoidSplitObjs :: !FirstFalse
- buildMonoidSkipComponents :: ![Text]
- buildMonoidInterleavedOutput :: !FirstTrue
- buildMonoidProgressBar :: !(First ProgressBarFormat)
- buildMonoidDdumpDir :: !(First Text)
- data ProgressBarFormat
- readProgressBarFormat :: String -> Either String ProgressBarFormat
- buildOptsMonoidBenchmarksL :: Lens' BuildOptsMonoid (Maybe Bool)
- buildOptsMonoidHaddockL :: Lens' BuildOptsMonoid (Maybe Bool)
- buildOptsMonoidInstallExesL :: Lens' BuildOptsMonoid (Maybe Bool)
- buildOptsMonoidTestsL :: Lens' BuildOptsMonoid (Maybe Bool)
- data TestOpts = TestOpts {
- toRerunTests :: !Bool
- toAdditionalArgs :: ![String]
- toCoverage :: !Bool
- toDisableRun :: !Bool
- toMaximumTimeSeconds :: !(Maybe Int)
- toAllowStdin :: !Bool
- defaultTestOpts :: TestOpts
- data TestOptsMonoid = TestOptsMonoid {}
- newtype HaddockOpts = HaddockOpts {
- hoAdditionalArgs :: [String]
- defaultHaddockOpts :: HaddockOpts
- newtype HaddockOptsMonoid = HaddockOptsMonoid {}
- data BenchmarkOpts = BenchmarkOpts {
- beoAdditionalArgs :: !(Maybe String)
- beoDisableRun :: !Bool
- defaultBenchmarkOpts :: BenchmarkOpts
- data BenchmarkOptsMonoid = BenchmarkOptsMonoid {
- beoMonoidAdditionalArgs :: !(First String)
- beoMonoidDisableRun :: !(First Bool)
- data FileWatchOpts
- data BuildSubset
- data ApplyCLIFlag
- boptsCLIFlagsByName :: BuildOptsCLI -> Map PackageName (Map FlagName Bool)
- newtype CabalVerbosity = CabalVerbosity Verbosity
- toFirstCabalVerbosity :: FirstFalse -> First CabalVerbosity
Documentation
Build options that is interpreted by the build command. This is built up from BuildOptsCLI and BuildOptsMonoid
BuildOpts | |
|
data BuildCommand Source #
Command sum type for conditional arguments.
Instances
Show BuildCommand Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> BuildCommand -> ShowS # show :: BuildCommand -> String # showList :: [BuildCommand] -> ShowS # | |
Eq BuildCommand Source # | |
Defined in Stack.Types.BuildOpts (==) :: BuildCommand -> BuildCommand -> Bool # (/=) :: BuildCommand -> BuildCommand -> Bool # |
data BuildOptsCLI Source #
Build options that may only be specified from the CLI
BuildOptsCLI | |
|
Instances
Show BuildOptsCLI Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> BuildOptsCLI -> ShowS # show :: BuildOptsCLI -> String # showList :: [BuildOptsCLI] -> ShowS # |
boptsCLIAllProgOptions :: BuildOptsCLI -> [Text] Source #
Generate a list of --PROG-option="argument" arguments for all PROGs.
data BuildOptsMonoid Source #
Build options that may be specified in the stack.yaml or from the CLI
Instances
data ProgressBarFormat Source #
Instances
FromJSON ProgressBarFormat Source # | |
Defined in Stack.Types.BuildOpts parseJSON :: Value -> Parser ProgressBarFormat # parseJSONList :: Value -> Parser [ProgressBarFormat] # | |
Show ProgressBarFormat Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> ProgressBarFormat -> ShowS # show :: ProgressBarFormat -> String # showList :: [ProgressBarFormat] -> ShowS # | |
Eq ProgressBarFormat Source # | |
Defined in Stack.Types.BuildOpts (==) :: ProgressBarFormat -> ProgressBarFormat -> Bool # (/=) :: ProgressBarFormat -> ProgressBarFormat -> Bool # |
readProgressBarFormat :: String -> Either String ProgressBarFormat Source #
Parse ProgressBarFormat from a String.
Options for the FinalAction
DoTests
TestOpts | |
|
data TestOptsMonoid Source #
Instances
newtype HaddockOpts Source #
Haddock Options
HaddockOpts | |
|
Instances
Show HaddockOpts Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> HaddockOpts -> ShowS # show :: HaddockOpts -> String # showList :: [HaddockOpts] -> ShowS # | |
Eq HaddockOpts Source # | |
Defined in Stack.Types.BuildOpts (==) :: HaddockOpts -> HaddockOpts -> Bool # (/=) :: HaddockOpts -> HaddockOpts -> Bool # |
newtype HaddockOptsMonoid Source #
Instances
data BenchmarkOpts Source #
Options for the FinalAction
DoBenchmarks
BenchmarkOpts | |
|
Instances
Show BenchmarkOpts Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> BenchmarkOpts -> ShowS # show :: BenchmarkOpts -> String # showList :: [BenchmarkOpts] -> ShowS # | |
Eq BenchmarkOpts Source # | |
Defined in Stack.Types.BuildOpts (==) :: BenchmarkOpts -> BenchmarkOpts -> Bool # (/=) :: BenchmarkOpts -> BenchmarkOpts -> Bool # |
data BenchmarkOptsMonoid Source #
Instances
data FileWatchOpts Source #
Instances
Show FileWatchOpts Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> FileWatchOpts -> ShowS # show :: FileWatchOpts -> String # showList :: [FileWatchOpts] -> ShowS # | |
Eq FileWatchOpts Source # | |
Defined in Stack.Types.BuildOpts (==) :: FileWatchOpts -> FileWatchOpts -> Bool # (/=) :: FileWatchOpts -> FileWatchOpts -> Bool # |
data BuildSubset Source #
Which subset of packages to build
BSAll | |
BSOnlySnapshot | Only install packages in the snapshot database, skipping packages intended for the local database. |
BSOnlyDependencies | |
BSOnlyLocals | Refuse to build anything in the snapshot database, see https://github.com/commercialhaskell/stack/issues/5272 |
Instances
Show BuildSubset Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> BuildSubset -> ShowS # show :: BuildSubset -> String # showList :: [BuildSubset] -> ShowS # | |
Eq BuildSubset Source # | |
Defined in Stack.Types.BuildOpts (==) :: BuildSubset -> BuildSubset -> Bool # (/=) :: BuildSubset -> BuildSubset -> Bool # |
data ApplyCLIFlag Source #
How to apply a CLI flag
ACFAllProjectPackages | Apply to all project packages which have such a flag name available. |
ACFByName !PackageName | Apply to the specified package only. |
Instances
Show ApplyCLIFlag Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> ApplyCLIFlag -> ShowS # show :: ApplyCLIFlag -> String # showList :: [ApplyCLIFlag] -> ShowS # | |
Eq ApplyCLIFlag Source # | |
Defined in Stack.Types.BuildOpts (==) :: ApplyCLIFlag -> ApplyCLIFlag -> Bool # (/=) :: ApplyCLIFlag -> ApplyCLIFlag -> Bool # | |
Ord ApplyCLIFlag Source # | |
Defined in Stack.Types.BuildOpts compare :: ApplyCLIFlag -> ApplyCLIFlag -> Ordering # (<) :: ApplyCLIFlag -> ApplyCLIFlag -> Bool # (<=) :: ApplyCLIFlag -> ApplyCLIFlag -> Bool # (>) :: ApplyCLIFlag -> ApplyCLIFlag -> Bool # (>=) :: ApplyCLIFlag -> ApplyCLIFlag -> Bool # max :: ApplyCLIFlag -> ApplyCLIFlag -> ApplyCLIFlag # min :: ApplyCLIFlag -> ApplyCLIFlag -> ApplyCLIFlag # |
boptsCLIFlagsByName :: BuildOptsCLI -> Map PackageName (Map FlagName Bool) Source #
Only flags set via ACFByName
newtype CabalVerbosity Source #
Instances
Parsec CabalVerbosity Source # | |
Defined in Stack.Types.BuildOpts parsec :: CabalParsing m => m CabalVerbosity # | |
FromJSON CabalVerbosity Source # | |
Defined in Stack.Types.BuildOpts parseJSON :: Value -> Parser CabalVerbosity # parseJSONList :: Value -> Parser [CabalVerbosity] # | |
Show CabalVerbosity Source # | |
Defined in Stack.Types.BuildOpts showsPrec :: Int -> CabalVerbosity -> ShowS # show :: CabalVerbosity -> String # showList :: [CabalVerbosity] -> ShowS # | |
Eq CabalVerbosity Source # | |
Defined in Stack.Types.BuildOpts (==) :: CabalVerbosity -> CabalVerbosity -> Bool # (/=) :: CabalVerbosity -> CabalVerbosity -> Bool # |