aboutsummaryrefslogtreecommitdiff
path: root/src/commands/utilities/highlight-!.ts
blob: f2ee25902cc8a3063e861e8a75b64550c6c2d028 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
import { BushCommand, clientSendAndPermCheck, deepWriteable, Highlight, HighlightWord, type SlashMessage } from '#lib';
import { Flag, type ArgumentGeneratorReturn, type SlashOption } from 'discord-akairo';
import { ApplicationCommandOptionType, Constants, type AutocompleteInteraction, type CacheType } from 'discord.js';

export const highlightSubcommands = deepWriteable({
	add: {
		description: 'Add a word to highlight.',
		type: ApplicationCommandOptionType.Subcommand,
		options: [
			{
				name: 'word',
				description: 'What word do you want to highlight?',
				retry: '{error} Enter a valid word.',
				type: ApplicationCommandOptionType.String,
				required: true
			}
			/* {
				name: 'regex',
				description: 'Should the word be matched using regular expression?',
				type: ApplicationCommandOptionType.Boolean,
				required: false
			} */
		]
	},
	remove: {
		description: 'Stop highting a word.',
		type: ApplicationCommandOptionType.Subcommand,
		options: [
			{
				name: 'word',
				description: 'Which word do you want to stop highlighting?',
				retry: '{error} Enter a valid word.',
				type: ApplicationCommandOptionType.String,
				required: true,
				autocomplete: true
			}
		]
	},
	block: {
		description: 'Block a user or channel from triggering your highlights.',
		type: ApplicationCommandOptionType.SubcommandGroup,
		options: [
			{
				name: 'user',
				description: 'Block a user from triggering your highlights.',
				start: 'What user/channel would you like to prevent from triggering your highlights?',
				type: ApplicationCommandOptionType.Subcommand,
				options: [
					{
						name: 'target',
						description: 'What user would you like to prevent from triggering your highlights?',
						retry: '{error} Enter a valid user or channel.',
						type: ApplicationCommandOptionType.User,
						resolve: 'Member',
						required: true
					}
				]
			},
			{
				name: 'channel',
				description: 'Block a channel from triggering your highlights.',
				type: ApplicationCommandOptionType.Subcommand,
				options: [
					{
						name: 'target',
						description: 'What channel would you like to prevent from triggering your highlights?',
						type: ApplicationCommandOptionType.Channel,
						channelTypes: Constants.TextBasedChannelTypes,
						required: true
					}
				]
			}
		]
	},
	unblock: {
		description: 'Re-allow a user or channel to triggering your highlights.',
		type: ApplicationCommandOptionType.SubcommandGroup,
		options: [
			{
				name: 'user',
				description: 'Re-allow a user to triggering your highlights',
				start: 'What user/channel would you like to allow triggering your highlights again?',
				type: ApplicationCommandOptionType.Subcommand,
				options: [
					{
						name: 'target',
						description: 'What user would you like to allow triggering your highlights again?',
						retry: '{error} Enter a valid user or channel.',
						type: ApplicationCommandOptionType.User,
						resolve: 'Member',
						required: true
					}
				]
			},
			{
				name: 'channel',
				description: 'Re-allow a channel to triggering your highlights.',
				type: ApplicationCommandOptionType.Subcommand,
				options: [
					{
						name: 'target',
						description: 'What channel would you like to prevent from triggering your highlights?',
						type: ApplicationCommandOptionType.Channel,
						channelTypes: Constants.TextBasedChannelTypes,
						required: true
					}
				]
			}
		]
	},
	show: {
		description: 'List all your current highlighted words.',
		type: ApplicationCommandOptionType.Subcommand,
		options: []
	},
	clear: {
		description: 'Remove all of your highlighted words.',
		type: ApplicationCommandOptionType.Subcommand,
		options: []
	},
	matches: {
		description: 'Test a phrase to see if it matches your current highlighted words.',
		type: ApplicationCommandOptionType.Subcommand,
		options: [
			{
				name: 'phrase',
				description: 'What phrase would you like to test your highlighted words against?',
				retry: '{error} Enter a valid phrase to test.',
				type: ApplicationCommandOptionType.String,
				required: true
			}
		]
	}
} as const);

export default class HighlightCommand extends BushCommand {
	public constructor() {
		super('highlight', {
			aliases: ['highlight', 'hl'],
			category: 'utilities',
			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(
				([subcommand, options]) => ({ name: subcommand, ...options } as SlashOption)
			),
			slash: true,
			channel: 'guild',
			clientPermissions: (m) => clientSendAndPermCheck(m),
			userPermissions: []
		});
	}

	public override *args(): ArgumentGeneratorReturn {
		const subcommand: keyof typeof highlightSubcommands = yield {
			id: 'subcommand',
			type: Object.keys(highlightSubcommands),
			prompt: {
				start: 'What sub command would you like to use?',
				retry: `{error} Valid subcommands are: ${Object.keys(highlightSubcommands)
					.map((s) => `\`${s}\``)
					.join()}.`
			}
		};

		return Flag.continue(`highlight-${subcommand}`);
	}

	public override async exec() {
		throw new Error('This command is not meant to be executed directly.');
	}

	public override async execSlash(message: SlashMessage, args: { subcommand: string; subcommandGroup?: string }) {
		// manual `Flag.continue`
		const subcommand = this.handler.modules.get(`highlight-${args.subcommandGroup ?? args.subcommand}`)!;
		return subcommand.exec(message, args);
	}

	public override async autocomplete(interaction: AutocompleteInteraction<CacheType>) {
		if (!interaction.inCachedGuild())
			return interaction.respond([{ name: 'You must be in a server to use this command.', value: 'error' }]);

		switch (interaction.options.getSubcommandGroup(false) ?? interaction.options.getSubcommand(true)) {
			case 'word': {
				const { words } = (await Highlight.findOne({
					where: { guild: interaction.guild.id, user: interaction.user.id }
				})) ?? { words: [] as HighlightWord[] };
				if (!words.length) return interaction.respond([]);
				return interaction.respond(words.map((w) => ({ name: w.word, value: w.word })));
			}
		}
	}
}