napkin-0.5.14

Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Cli.Interactive.Interactive

Description

Synopsis

data SpecFolders = SpecFolders {
- sqlFolder :: FilePath
- haskellFolders :: Set FilePath
- hpackFile :: Maybe FilePath
}
data InteractiveRuntimeEnv
- = EnvNotLoaded
- | EnvLoaded RuntimeEnv
- | EnvNeedsReload
data InteractiveCommandOptions = InteractiveCommandOptions {
}
type InteractiveCLICommand = NapkinExceptIO InteractiveRuntimeEnv
type InteractiveAction e = forall b. ValidateSpecsRequirements b => (RawInterpretedSpec b, RuntimeEnv, YamlSpec b) -> IO (Either e ())
class ToInteractiveOptions a where
- toInteractiveOptions :: a -> InteractiveCommandOptions
chooseInteractiveCommand :: ToNapkinError e => InteractiveCommandOptions -> LogOptions -> InteractiveAction e -> CLICommand
reloadableAction :: ToNapkinError e => Maybe SpecFolders -> Maybe RuntimeEnv -> InteractiveCommandOptions -> LogOptions -> InteractiveAction e -> InteractiveCLICommand
autoReloadAction :: ToNapkinError e => InteractiveCommandOptions -> LogOptions -> InteractiveAction e -> CLICommand
readSpecFolders :: MonadIO m => FilePath -> YamlSpec b -> m SpecFolders

Documentation

data SpecFolders #

Constructors

SpecFolders
Fields sqlFolder :: FilePath haskellFolders :: Set FilePath hpackFile :: Maybe FilePath

Instances

Instances details

Eq SpecFolders #
Instance details Defined in Napkin.Cli.Interactive.Interactive Methods (==) :: SpecFolders -> SpecFolders -> Bool # (/=) :: SpecFolders -> SpecFolders -> Bool #

data InteractiveRuntimeEnv #

Constructors

EnvNotLoaded
EnvLoaded RuntimeEnv
EnvNeedsReload

data InteractiveCommandOptions #

Constructors

InteractiveCommandOptions
Fields interactiveCommandOptions_specFile :: SpecFileWithOverrides interactiveCommandOptions_autoReload :: Bool interactiveCommandOptions_liveMode :: LiveMode interactiveCommandOptions_interpolationMode :: InterpolationMode interactiveCommandOptions_meta :: [SpecMetaArgsOpt]

type InteractiveCLICommand = NapkinExceptIO InteractiveRuntimeEnv #

type InteractiveAction e = forall b. ValidateSpecsRequirements b => (RawInterpretedSpec b, RuntimeEnv, YamlSpec b) -> IO (Either e ()) #

class ToInteractiveOptions a where #

Methods

toInteractiveOptions :: a -> InteractiveCommandOptions #

Instances

Instances details

ToInteractiveOptions DumpCommandOptions #
Instance details Defined in Napkin.Cli.Dump.Types Methods toInteractiveOptions :: DumpCommandOptions -> InteractiveCommandOptions #
ToInteractiveOptions ValidateCommandOptions #
Instance details Defined in Napkin.Cli.Validate.Types Methods toInteractiveOptions :: ValidateCommandOptions -> InteractiveCommandOptions #

chooseInteractiveCommand :: ToNapkinError e => InteractiveCommandOptions -> LogOptions -> InteractiveAction e -> CLICommand #

Choose whether to run a reloadable acton interactively or not.

reloadableAction :: ToNapkinError e => Maybe SpecFolders -> Maybe RuntimeEnv -> InteractiveCommandOptions -> LogOptions -> InteractiveAction e -> InteractiveCLICommand #

Run a reloadable action.

autoReloadAction :: ToNapkinError e => InteractiveCommandOptions -> LogOptions -> InteractiveAction e -> CLICommand #

Wait for a spec file or a Haskell file to change and reload action.

readSpecFolders :: MonadIO m => FilePath -> YamlSpec b -> m SpecFolders #