Safe Haskell	None
Language	GHC2021

Napkin.Spec.Cli

Synopsis

data CliOptions
- = Run RunOptions
- | Dump DumpOptions
- | ListTags
- | DumpDeps
data DumpOptions = DumpOptions {
- outputDirectory :: FilePath
- meta :: [ByteString]
- excludeUnmanagedTables :: Bool
}
data RunOptions = RunOptions {
- disableAll :: Bool
- enableAll :: Bool
- depsOnly :: Bool
- forceTables :: [SpecTableName]
- skipTables :: [SpecTableName]
- naturalUpdates :: [SpecTableName]
- app :: Text
- logLevel :: Maybe Severity
- dryRun :: Bool
- namespace :: Maybe Text
- metadataConnectionString :: Maybe Text
- showProgress :: Bool
- meta :: [ByteString]
- enableTags :: [TableSpecTag]
- disableTags :: [TableSpecTag]
- condensedLogging :: CondensedLogging
- maxConcurrency :: Maybe Natural
}
newtype CustomSpecPreprocessor bk = CustomSpecPreprocessor (SpecMetaArgs -> SpecRuntime bk -> Specs bk -> Specs bk)
parseRunOptions :: Parser CliOptions
parseDumpOptions :: Parser CliOptions
parseCliOption :: Parser CliOptions
parseSpecMetaArgs :: [ByteString] -> Either String SpecMetaArgs
dumpDeps :: (MustacheBackend bk, RunBackendEffect bk, DumpBackendRequirements bk) => RuntimeEnv -> ExternMacros -> bk -> Spec bk a -> IO ()
specMain :: SpecBackend bk => bk -> SpecRuntime bk -> Spec bk a -> IO ExitCode
specMainWith :: SpecBackend bk => (AppConfig -> ResourceT IO (ComboEnv bk)) -> CliOptions -> bk -> CustomSpecPreprocessor bk -> CustomValidator -> ExternMacros -> SpecRuntime bk -> Spec bk a -> IO ExitCode
specMainWithInterpreter :: SpecBackend bk => RuntimeEnv -> (AppConfig -> ResourceT IO (ComboEnv bk)) -> CliOptions -> bk -> CustomSpecPreprocessor bk -> CustomValidator -> ExternMacros -> SpecRuntime bk -> Spec bk a -> IO ExitCode
exitRunFailed :: ExitCode
exitValidationFailed :: ExitCode
specTagRefMap :: [TableSpec b] -> Map (Maybe TableSpecTag) [SpecTableName]
specListTags :: (SpecBackend bk, MonadIO m) => Specs bk -> m ()

Documentation

data CliOptions #

Data structure for all CLI command and sub-commands.

Constructors

Run RunOptions
Dump DumpOptions
ListTags
DumpDeps

Instances

Instances details

Show CliOptions #
Instance details Defined in Napkin.Spec.Cli Methods showsPrec :: Int -> CliOptions -> ShowS # show :: CliOptions -> String # showList :: [CliOptions] -> ShowS #
Eq CliOptions #
Instance details Defined in Napkin.Spec.Cli Methods (==) :: CliOptions -> CliOptions -> Bool # (/=) :: CliOptions -> CliOptions -> Bool #

data DumpOptions #

Data structure dump sub-command.

Constructors

DumpOptions
Fields outputDirectory :: FilePath meta :: [ByteString] excludeUnmanagedTables :: Bool

Instances

Instances details

Generic DumpOptions #

Instance details

Defined in Napkin.Spec.Cli

Associated Types

type Rep DumpOptions

Instance details

Defined in Napkin.Spec.Cli

type Rep DumpOptions = D1 ('MetaData "DumpOptions" "Napkin.Spec.Cli" "napkin-1.0.0-5YkWAC9Wc776PT0LDghaFb" 'False) (C1 ('MetaCons "DumpOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "outputDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: (S1 ('MetaSel ('Just "meta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ByteString]) :*: S1 ('MetaSel ('Just "excludeUnmanagedTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

Methods

from :: DumpOptions -> Rep DumpOptions x #

to :: Rep DumpOptions x -> DumpOptions #

Show DumpOptions #

Instance details

Defined in Napkin.Spec.Cli

Methods

showsPrec :: Int -> DumpOptions -> ShowS #

show :: DumpOptions -> String #

showList :: [DumpOptions] -> ShowS #

Eq DumpOptions #

Instance details

Defined in Napkin.Spec.Cli

Methods

(==) :: DumpOptions -> DumpOptions -> Bool #

(/=) :: DumpOptions -> DumpOptions -> Bool #

type Rep DumpOptions #

Instance details

Defined in Napkin.Spec.Cli

type Rep DumpOptions = D1 ('MetaData "DumpOptions" "Napkin.Spec.Cli" "napkin-1.0.0-5YkWAC9Wc776PT0LDghaFb" 'False) (C1 ('MetaCons "DumpOptions" 'PrefixI 'True) (S1 ('MetaSel ('Just "outputDirectory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :*: (S1 ('MetaSel ('Just "meta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ByteString]) :*: S1 ('MetaSel ('Just "excludeUnmanagedTables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

data RunOptions #

Data structure run sub-command.

Constructors

RunOptions

Fields

Instances

Instances details

Generic RunOptions #

Instance details

Defined in Napkin.Spec.Cli

Associated Types

type Rep RunOptions

Instance details

Defined in Napkin.Spec.Cli

Methods

from :: RunOptions -> Rep RunOptions x #

to :: Rep RunOptions x -> RunOptions #

Show RunOptions #

Instance details

Defined in Napkin.Spec.Cli

Methods

showsPrec :: Int -> RunOptions -> ShowS #

show :: RunOptions -> String #

showList :: [RunOptions] -> ShowS #

Eq RunOptions #

Instance details

Defined in Napkin.Spec.Cli

Methods

(==) :: RunOptions -> RunOptions -> Bool #

(/=) :: RunOptions -> RunOptions -> Bool #

type Rep RunOptions #

Instance details

Defined in Napkin.Spec.Cli

newtype CustomSpecPreprocessor bk #

User-specified function to preprocess all specs. Useful for renaming all tables, for example, in development vs. production mode.

Constructors

CustomSpecPreprocessor (SpecMetaArgs -> SpecRuntime bk -> Specs bk -> Specs bk)

Instances

Instances details

Default (CustomSpecPreprocessor bk) #
Instance details Defined in Napkin.Spec.Cli Methods def :: CustomSpecPreprocessor bk #

parseRunOptions :: Parser CliOptions #

Parser for the run CLI sub-command

Parses available commands for the run sub-command and provides detail CLI help text

parseDumpOptions :: Parser CliOptions #

Parser for the dump CLI sub-command Parses available commands for the run sub-command and provides detail CLI help text

parseCliOption :: Parser CliOptions #

parseSpecMetaArgs :: [ByteString] -> Either String SpecMetaArgs #

dumpDeps :: (MustacheBackend bk, RunBackendEffect bk, DumpBackendRequirements bk) => RuntimeEnv -> ExternMacros -> bk -> Spec bk a -> IO () #

specMain :: SpecBackend bk => bk -> SpecRuntime bk -> Spec bk a -> IO ExitCode #

Use this to make your main entry point for your spec running application. specMain :: bk -> [(NS.SpecRuntime bk, NST.Spec bk ())] -> IO ()

specMainWith #

Arguments

:: SpecBackend bk
=> (AppConfig -> ResourceT IO (ComboEnv bk))	How to build the combo. register any cleanup
-> CliOptions
-> bk
-> CustomSpecPreprocessor bk
-> CustomValidator
-> ExternMacros
-> SpecRuntime bk
-> Spec bk a
-> IO ExitCode

A more customizable specMain for embedding in larger programs. This API is unstable

specMainWithInterpreter #

Arguments

:: SpecBackend bk
=> RuntimeEnv
-> (AppConfig -> ResourceT IO (ComboEnv bk))	How to build the combo. register any cleanup
-> CliOptions
-> bk
-> CustomSpecPreprocessor bk
-> CustomValidator
-> ExternMacros
-> SpecRuntime bk
-> Spec bk a
-> IO ExitCode

exitRunFailed :: ExitCode #

exitValidationFailed :: ExitCode #

specTagRefMap :: [TableSpec b] -> Map (Maybe TableSpecTag) [SpecTableName] #

create a mapping of TableSpecTags to `Ref Table`s for dumping.

specListTags :: (SpecBackend bk, MonadIO m) => Specs bk -> m () #

Print the result of specTagRefMap'ing a particular spec to terminal.