Calamity.Commands

Calamity commands This module only exports the DSL and core types for using commands

Documentation

module Calamity.Commands.Dsl

module Calamity.Commands.Error

module Calamity.Commands.Handler

module Calamity.Commands.Utils

module Calamity.Commands.ParsePrefix

module Calamity.Commands.Parser

module Calamity.Commands.Help

data Context

Invokation context for commands

Instances

Show Context

Defined in Calamity.Commands.Context

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

Generic Context

Defined in Calamity.Commands.Context

Associated Types

type Rep Context :: Type -> Type

Methods

from :: Context -> Rep Context x

to :: Rep Context x -> Context

TextShow Context

Defined in Calamity.Commands.Context

Methods

showbPrec :: Int -> Context -> Builder

showb :: Context -> Builder

showbList :: [Context] -> Builder

showtPrec :: Int -> Context -> Text

showt :: Context -> Text

showtList :: [Context] -> Text

showtlPrec :: Int -> Context -> Text

showtl :: Context -> Text

showtlList :: [Context] -> Text

Tellable Context

Defined in Calamity.Commands.Context

Methods

getChannel :: forall (r :: [(Type -> Type) -> Type -> Type]). (BotC r, Member (Error RestError) r) => Context -> Sem r (Snowflake Channel)

type Rep Context

Defined in Calamity.Commands.Context

type Rep Context = D1 ('MetaData "Context" "Calamity.Commands.Context" "calamity-0.1.11.1-inplace" 'False) (C1 ('MetaCons "Context" 'PrefixI 'True) (((S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Message) :*: S1 ('MetaSel ('Just "guild") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Guild))) :*: (S1 ('MetaSel ('Just "member") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Member)) :*: S1 ('MetaSel ('Just "channel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Channel))) :*: ((S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 User) :*: S1 ('MetaSel ('Just "command") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Command)) :*: (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "unparsedParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

Commands

This module provides abstractions for writing declarative commands, that support grouping, pre-invokation checks, and automatic argument parsing by using a type level list of parameter types.

A DSL is provided in Dsl for constructing commands declaratively.

You can implement Parser for your own types to allow them to be used in the parameter list of commands.

A default help command is provided in Help which can be added just by using helpCommand inside the command declaration DSL.

Custom Events

the event handler registered by addCommands will fire the following custom events:

1. "command-error" (Context, CommandError)

   Fired when a command returns an error.

2. "command-not-found" [Text]

   Fired when a valid prefix is used, but the command is not found.

3. "command-invoked" Context

   Fired when a command is successfully invoked.

Registered Metrics

1. Counter: "commands_invoked" [name]

   Incremented on each command invokation, the parameter name is the path/name of the invoked command.

Examples

An example of using commands:

addCommands $ do
  helpCommand
  command @'[User] "utest" $ ctx u -> do
    void $ tell ctx $ "got user: " <> showtl u
  group "admin" $ do
    command @'[] "bye" $ ctx -> do
      void $ tell ctx "bye!"
      stopBot