napkin-1.0.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Napkin.Cli.Interactive.Interactive

Synopsis

Documentation

data SpecFolders #

Constructors

SpecFolders 

Fields

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

Instances

Instances details
Generic InteractiveCommandOptions # 
Instance details

Defined in Napkin.Cli.Interactive.Interactive

Associated Types

type Rep InteractiveCommandOptions :: Type -> Type #

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-1.0.0-B79azc00rn1K8mj00hwhwG" '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

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 => SpecFilesWithOverrides -> YamlSpec b -> m SpecFolders #