diff options
| author | IRONM00N <64110067+IRONM00N@users.noreply.github.com> | 2022-03-14 01:04:20 -0400 |
|---|---|---|
| committer | IRONM00N <64110067+IRONM00N@users.noreply.github.com> | 2022-03-14 01:04:20 -0400 |
| commit | 1e90863cf79eb9674248ff3b8abb19d5c3936993 (patch) | |
| tree | 506d65b8a1d43d81725e8cdc9a810b4e49e9cc19 /src/commands | |
| parent | bf60ddfed9a4042d37172eca2abb715dba6be4c4 (diff) | |
| download | tanzanite-1e90863cf79eb9674248ff3b8abb19d5c3936993.tar.gz tanzanite-1e90863cf79eb9674248ff3b8abb19d5c3936993.tar.bz2 tanzanite-1e90863cf79eb9674248ff3b8abb19d5c3936993.zip | |
chore(hl): add usages and examples
Diffstat (limited to 'src/commands')
| -rw-r--r-- | src/commands/utilities/highlight-!.ts | 22 |
1 files changed, 19 insertions, 3 deletions
diff --git a/src/commands/utilities/highlight-!.ts b/src/commands/utilities/highlight-!.ts index 0531cfd..2ec1a29 100644 --- a/src/commands/utilities/highlight-!.ts +++ b/src/commands/utilities/highlight-!.ts @@ -81,9 +81,25 @@ export default class HighlightCommand extends BushCommand { super('highlight', { aliases: ['highlight', 'hl'], category: 'utilities', - description: 'Command description.', - usage: ['template <requiredArg> [optionalArg]'], - examples: ['template 1 2'], + description: 'Highlight a word or phrase and have Tanzanite dm you when someone mentions it.', + usage: [ + 'highlight add <word>', + 'highlight remove <word>', + 'highlight block <user|channel>', + 'highlight unblock <user|channel>', + 'highlight show', + 'highlight clear', + 'highlight matches <phrase>' + ], + examples: [ + 'highlight add spaghetti', + 'highlight remove meatballs', + 'highlight block @tyman', + 'highlight unblock #bot-commands', + 'highlight show', + 'highlight clear', + 'highlight matches I really like to eat bacon with my spaghetti' + ], slashOptions: Object.entries(highlightSubcommands).map((args) => { // typescript being annoying const [subcommand, description] = args as [keyof typeof highlightSubcommands, typeof args[1]]; |