Safe Haskell	None
Language	GHC2024

Napkin.Cli.Interactive.Interactive

Synopsis

data SpecFolders = SpecFolders {
- sqlFolder :: FilePath
- haskellFolders :: Set FilePath
- hpackFile :: Maybe FilePath
}
data InteractiveRuntimeEnv
- = EnvNotLoaded
- | EnvLoaded RuntimeEnv
- | EnvNeedsReload
data InteractiveCommandOptions = InteractiveCommandOptions {
- specFiles :: SpecFilesWithOverrides
- autoReload :: Bool
- liveMode :: LiveMode
- interpolationMode :: InterpolationMode
- meta :: [SpecMetaArgsOpt]
}
type InteractiveCLICommand = NapkinExceptIO InteractiveRuntimeEnv
data InteractiveActionEnv b = InteractiveActionEnv {
- interpretedSpec :: RawInterpretedSpec b
- runtimeEnv :: RuntimeEnv
- parsedYaml :: YamlSpec b
- rawYaml :: Value
}
type InteractiveAction e = forall b. ValidateSpecsRequirements b => InteractiveActionEnv 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, InterpreterBackendSupport b) => SpecFilesWithOverrides -> 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 specFiles :: SpecFilesWithOverrides autoReload :: Bool liveMode :: LiveMode interpolationMode :: InterpolationMode meta :: [SpecMetaArgsOpt]

Instances

Instances details

Generic InteractiveCommandOptions #

Instance details

Defined in Napkin.Cli.Interactive.Interactive

Associated Types

type Rep InteractiveCommandOptions

Instance details

Defined in Napkin.Cli.Interactive.Interactive

type Rep InteractiveCommandOptions = D1 ('MetaData "InteractiveCommandOptions" "Napkin.Cli.Interactive.Interactive" "napkin-cli-2.0.0-4ha97GXrcwU2qMy5j7dc75" 'False) (C1 ('MetaCons "InteractiveCommandOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "specFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpecFilesWithOverrides) :*: S1 ('MetaSel ('Just "autoReload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "liveMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LiveMode) :*: (S1 ('MetaSel ('Just "interpolationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InterpolationMode) :*: S1 ('MetaSel ('Just "meta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SpecMetaArgsOpt])))))

Methods

from :: InteractiveCommandOptions -> Rep InteractiveCommandOptions x #

to :: Rep InteractiveCommandOptions x -> InteractiveCommandOptions #

type Rep InteractiveCommandOptions #

Instance details

Defined in Napkin.Cli.Interactive.Interactive

type Rep InteractiveCommandOptions = D1 ('MetaData "InteractiveCommandOptions" "Napkin.Cli.Interactive.Interactive" "napkin-cli-2.0.0-4ha97GXrcwU2qMy5j7dc75" 'False) (C1 ('MetaCons "InteractiveCommandOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "specFiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpecFilesWithOverrides) :*: S1 ('MetaSel ('Just "autoReload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "liveMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 LiveMode) :*: (S1 ('MetaSel ('Just "interpolationMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 InterpolationMode) :*: S1 ('MetaSel ('Just "meta") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [SpecMetaArgsOpt])))))

type InteractiveCLICommand = NapkinExceptIO InteractiveRuntimeEnv #

data InteractiveActionEnv b #

Constructors

InteractiveActionEnv
Fields interpretedSpec :: RawInterpretedSpec b runtimeEnv :: RuntimeEnv parsedYaml :: YamlSpec b rawYaml :: Value

type InteractiveAction e = forall b. ValidateSpecsRequirements b => InteractiveActionEnv 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, InterpreterBackendSupport b) => SpecFilesWithOverrides -> YamlSpec b -> m SpecFolders #