Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Napkin.Spec.Cli

Description

Napkin Command Line Interface, CLI

Synopsis

data CliOptions
- = Run RunOptions
- | Dump DumpOptions
- | ListTags
- | DumpDeps
data DumpOptions = DumpOptions {
}
data RunOptions = RunOptions {
- _runOptions_disableAll :: Bool
- _runOptions_enableAll :: Bool
- _runOptions_depsOnly :: Bool
- _runOptions_forceTables :: [Ref Table]
- _runOptions_skipTables :: [Ref Table]
- _runOptions_naturalUpdates :: [Ref Table]
- _runOptions_app :: Text
- _runOptions_logLevel :: Maybe Severity
- _runOptions_dryRun :: Bool
- _runOptions_namespace :: Maybe Text
- _runOptions_metadataConnectionString :: Maybe Text
- _runOptions_showProgress :: Bool
- _runOptions_meta :: [ByteString]
- _runOptions_enableTags :: [TableSpecTag]
- _runOptions_disableTags :: [TableSpecTag]
}
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 :: forall bk a. (ReifiesBackend bk, MustacheBackend bk, RunBackendEffect bk, DumpBackendRequirements bk) => RuntimeEnv -> ExternMacros -> bk -> Spec bk a -> IO ()
compileSpecs :: MonadIO m => [(t, Spec b a)] -> m [(t, Specs b)]
specMain :: SpecBackend bk => bk -> SpecRuntime bk -> Spec bk a -> IO ExitCode
specMainWith :: forall bk a. SpecBackend bk => (AppConfig -> ResourceT IO ComboEnv) -> CliOptions -> bk -> CustomSpecPreprocessor bk -> CustomValidator -> ExternMacros -> SpecRuntime bk -> Spec bk a -> IO ExitCode
specMainWithInterpreter :: forall bk a. SpecBackend bk => RuntimeEnv -> (AppConfig -> ResourceT IO ComboEnv) -> CliOptions -> bk -> CustomSpecPreprocessor bk -> CustomValidator -> ExternMacros -> SpecRuntime bk -> Spec bk a -> IO ExitCode
exitRunFailed :: ExitCode
exitValidationFailed :: ExitCode
specTagRefMap :: [TableSpec b] -> Map (Maybe TableSpecTag) [Ref Table]

Documentation

data CliOptions #

Data structure for all CLI commnad and sub-commands.

SubCommand data strucres are Run, Dump, ListTags, DumpDeps Each SubCommands data strucures contain the available commands

Constructors

Run RunOptions
Dump DumpOptions
ListTags
DumpDeps

Instances

Instances details

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

data DumpOptions #

Data structure dump sub-command.

Constructors

DumpOptions
Fields _dumpOptions_outputDirectory :: FilePath _dumpOptions_force :: Bool _dumpOptions_meta :: [ByteString] _dumpOptions_excludeUnmanagedTables :: Bool _dumpOptions_sqliteDirectory :: Maybe FilePath _dumpOptions_generateHtml :: Bool

Instances

Instances details

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

data RunOptions #

Data structure run sub-command.

Constructors

RunOptions

Fields

_runOptions_disableAll :: Bool
_runOptions_enableAll :: Bool
_runOptions_depsOnly :: Bool
_runOptions_forceTables :: [Ref Table]
_runOptions_skipTables :: [Ref Table]
_runOptions_naturalUpdates :: [Ref Table]
_runOptions_app :: Text
_runOptions_logLevel :: Maybe Severity
_runOptions_dryRun :: Bool
_runOptions_namespace :: Maybe Text
_runOptions_metadataConnectionString :: Maybe Text
_runOptions_showProgress :: Bool
_runOptions_meta :: [ByteString]
_runOptions_enableTags :: [TableSpecTag]
_runOptions_disableTags :: [TableSpecTag]

Instances

Instances details

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

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 :: forall bk a. (ReifiesBackend bk, MustacheBackend bk, RunBackendEffect bk, DumpBackendRequirements bk) => RuntimeEnv -> ExternMacros -> bk -> Spec bk a -> IO () #

compileSpecs :: MonadIO m => [(t, Spec b a)] -> m [(t, Specs b)] #

Compile given list of specs into ready to execute form.

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

:: forall bk a. SpecBackend bk
=> (AppConfig -> ResourceT IO ComboEnv)	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

:: forall bk a. SpecBackend bk
=> RuntimeEnv
-> (AppConfig -> ResourceT IO ComboEnv)	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) [Ref Table] #

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