tasklite-core-0.5.0.0: CLI task / todo list manager with SQLite backend

Safe Haskell	None
Language	GHC2021

Hooks

Synopsis

data HookTiming
- = PreEvent
- | PostEvent
data HookType
- = LaunchHook
- | AddHook
- | ModifyHook
- | ExitHook
data HookEvent = HookEvent HookType HookTiming
data HookResult
- = BasicHookResult {
  - message :: Maybe Text
  - warning :: Maybe Text
  - error :: Maybe Text
  }
- | TaskHookResult {
  - task :: Maybe ImportTask
  - message :: Maybe Text
  - warning :: Maybe Text
  - error :: Maybe Text
  }
data ExecMode
- = ExecFile
- | ExecStdin
type String = [Char]
executeHooks :: Text -> [Hook] -> IO [Either Text HookResult]
formatHookResult :: Config -> HookResult -> Doc AnsiStyle

Documentation

data HookTiming Source #

Constructors

PreEvent
PostEvent

Instances

Instances details

Show HookTiming Source #
Instance details Defined in Hooks Methods showsPrec :: Int -> HookTiming -> ShowS # show :: HookTiming -> String # showList :: [HookTiming] -> ShowS #

data HookType Source #

Constructors

LaunchHook
AddHook
ModifyHook
ExitHook

Instances

Instances details

Show HookType Source #
Instance details Defined in Hooks Methods showsPrec :: Int -> HookType -> ShowS # show :: HookType -> String # showList :: [HookType] -> ShowS #

data HookEvent Source #

Constructors

HookEvent HookType HookTiming

Instances

Instances details

Show HookEvent Source #
Instance details Defined in Hooks Methods showsPrec :: Int -> HookEvent -> ShowS # show :: HookEvent -> String # showList :: [HookEvent] -> ShowS #

data HookResult Source #

Output of a hook that must be parsed by TaskLite

Constructors

BasicHookResult
Fields message :: Maybe Text warning :: Maybe Text error :: Maybe Text
TaskHookResult
Fields task :: Maybe ImportTask message :: Maybe Text warning :: Maybe Text error :: Maybe Text

Instances

Instances details

FromJSON HookResult Source #

Instance details

Defined in Hooks

Methods

parseJSON :: Value -> Parser HookResult #

parseJSONList :: Value -> Parser [HookResult] #

omittedField :: Maybe HookResult #

Generic HookResult Source #

Instance details

Defined in Hooks

Associated Types

type Rep HookResult

Instance details

Defined in Hooks

type Rep HookResult = D1 ('MetaData "HookResult" "Hooks" "tasklite-core-0.5.0.0-LQthVJoAqpD9KkDBxzljEd" 'False) (C1 ('MetaCons "BasicHookResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "warning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :+: C1 ('MetaCons "TaskHookResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ImportTask)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "warning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

Methods

from :: HookResult -> Rep HookResult x #

to :: Rep HookResult x -> HookResult #

Show HookResult Source #

Instance details

Defined in Hooks

Methods

showsPrec :: Int -> HookResult -> ShowS #

show :: HookResult -> String #

showList :: [HookResult] -> ShowS #

type Rep HookResult Source #

Instance details

Defined in Hooks

type Rep HookResult = D1 ('MetaData "HookResult" "Hooks" "tasklite-core-0.5.0.0-LQthVJoAqpD9KkDBxzljEd" 'False) (C1 ('MetaCons "BasicHookResult" 'PrefixI 'True) (S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "warning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :+: C1 ('MetaCons "TaskHookResult" 'PrefixI 'True) ((S1 ('MetaSel ('Just "task") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ImportTask)) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "warning") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "error") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

data ExecMode Source #

Constructors

ExecFile
ExecStdin

type String = [Char] Source #

executeHooks :: Text -> [Hook] -> IO [Either Text HookResult] Source #

formatHookResult :: Config -> HookResult -> Doc AnsiStyle Source #