commands/tools/SnippetCommand.ts

/**
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * SudoBot is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SudoBot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
 */

import { PermissionsBitField, SlashCommandBuilder, escapeCodeBlock, escapeInlineCode } from "discord.js";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";

export default class SnippetCommand extends Command {
    public readonly subcommands = ["list", "create", "delete", "rename", "randomize", "pushfile", "pushfiles", "edit"];
    public readonly name = "snippet";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.String],
            name: "subcommand",
            requiredErrorMessage: `Please provide a valid subcommand! The available subcommands are: \`${this.subcommands.join("`, `")}\`.`
        },
        {
            types: [ArgumentType.String],
            name: "name",
            optional: true
        },
        {
            types: [ArgumentType.StringRest],
            name: "content",
            optional: true
        }
    ];
    public readonly permissions = [
        PermissionsBitField.Flags.BanMembers,
        PermissionsBitField.Flags.KickMembers,
        PermissionsBitField.Flags.ManageGuild,
        PermissionsBitField.Flags.ModerateMembers,
        PermissionsBitField.Flags.ManageMessages
    ];
    public readonly permissionMode = "or";
    public readonly aliases = ["tag", "tags", "snippets"];
    public readonly description = "Manage snippets/tags.";

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addSubcommand(subcommand =>
            subcommand
                .setName("create")
                .setDescription("Create a snippet")
                .addStringOption(option => option.setName("name").setDescription("The snippet name").setRequired(true))
                .addStringOption(option => option.setName("content").setDescription("The snippet content").setRequired(true))
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("delete")
                .setDescription("Delete a snippet")
                .addStringOption(option => option.setName("name").setDescription("The snippet name").setRequired(true))
        )
        .addSubcommand(subcommand =>
            subcommand
                .setName("rename")
                .setDescription("Rename a snippet")
                .addStringOption(option => option.setName("old_name").setDescription("The old snippet name").setRequired(true))
                .addStringOption(option => option.setName("new_name").setDescription("New snippet name to set").setRequired(true))
        )
        .addSubcommand(subcommand => subcommand.setName("list").setDescription("List all snippets in the server"));

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        const subcommand: string = context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true);

        if (!this.subcommands.includes(subcommand.toLowerCase())) {
            return {
                __reply: true,
                content: `\`${escapeInlineCode(
                    escapeCodeBlock(subcommand)
                )}\` is not a valid subcommand! The available subcommands are: \`${this.subcommands.join("`, `")}\``
            };
        }

        if (context.isLegacy && subcommand.toLowerCase() !== "list") {
            /* Ensure that `parsedNamedArgs.name` is populated */
            if (context.args[1] === undefined) {
                await this.error(message, "Please provide a snippet/tag name to perform this action!");
                return;
            }
        }

        await this.deferIfInteraction(message);

        const command = this.client.commands.get(`snippet__${subcommand}`);

        if (command) {
            return await command.execute(message, {
                ...context,
                ...(context.isLegacy
                    ? {
                          parsedNamedArgs: {
                              ...context.parsedNamedArgs,
                              name: context.parsedNamedArgs.name,
                              content: context.parsedNamedArgs.content,
                              new_name: subcommand === "rename" ? context.parsedNamedArgs.content.split(/ +/)[0] : undefined
                          }
                      }
                    : {})
            });
        }
    }
}
1	rakinar2	577	/**
2			* This file is part of SudoBot.
3			*
4			* Copyright (C) 2021-2023 OSN Developers.
5			*
6			* SudoBot is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU Affero General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* SudoBot is distributed in the hope that it will be useful, but
12			* WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU Affero General Public License for more details.
15			*
16			* You should have received a copy of the GNU Affero General Public License
17			* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			import { PermissionsBitField, SlashCommandBuilder, escapeCodeBlock, escapeInlineCode } from "discord.js";
21			import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
22
23			export default class SnippetCommand extends Command {
24			public readonly subcommands = ["list", "create", "delete", "rename", "randomize", "pushfile", "pushfiles", "edit"];
25			public readonly name = "snippet";
26			public readonly validationRules: ValidationRule[] = [
27			{
28			types: [ArgumentType.String],
29			name: "subcommand",
30			requiredErrorMessage: `Please provide a valid subcommand! The available subcommands are: \`${this.subcommands.join("`, `")}\`.`
31			},
32			{
33			types: [ArgumentType.String],
34			name: "name",
35			optional: true
36			},
37			{
38			types: [ArgumentType.StringRest],
39			name: "content",
40			optional: true
41			}
42			];
43			public readonly permissions = [
44			PermissionsBitField.Flags.BanMembers,
45			PermissionsBitField.Flags.KickMembers,
46			PermissionsBitField.Flags.ManageGuild,
47			PermissionsBitField.Flags.ModerateMembers,
48			PermissionsBitField.Flags.ManageMessages
49			];
50			public readonly permissionMode = "or";
51			public readonly aliases = ["tag", "tags", "snippets"];
52			public readonly description = "Manage snippets/tags.";
53
54			public readonly slashCommandBuilder = new SlashCommandBuilder()
55			.addSubcommand(subcommand =>
56			subcommand
57			.setName("create")
58			.setDescription("Create a snippet")
59			.addStringOption(option => option.setName("name").setDescription("The snippet name").setRequired(true))
60			.addStringOption(option => option.setName("content").setDescription("The snippet content").setRequired(true))
61			)
62			.addSubcommand(subcommand =>
63			subcommand
64			.setName("delete")
65			.setDescription("Delete a snippet")
66			.addStringOption(option => option.setName("name").setDescription("The snippet name").setRequired(true))
67			)
68			.addSubcommand(subcommand =>
69			subcommand
70			.setName("rename")
71			.setDescription("Rename a snippet")
72			.addStringOption(option => option.setName("old_name").setDescription("The old snippet name").setRequired(true))
73			.addStringOption(option => option.setName("new_name").setDescription("New snippet name to set").setRequired(true))
74			)
75			.addSubcommand(subcommand => subcommand.setName("list").setDescription("List all snippets in the server"));
76
77			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
78			const subcommand: string = context.isLegacy ? context.parsedNamedArgs.subcommand : context.options.getSubcommand(true);
79
80			if (!this.subcommands.includes(subcommand.toLowerCase())) {
81			return {
82			__reply: true,
83			content: `\`${escapeInlineCode(
84			escapeCodeBlock(subcommand)
85			)}\` is not a valid subcommand! The available subcommands are: \`${this.subcommands.join("`, `")}\``
86			};
87			}
88
89			if (context.isLegacy && subcommand.toLowerCase() !== "list") {
90			/* Ensure that `parsedNamedArgs.name` is populated */
91			if (context.args[1] === undefined) {
92			await this.error(message, "Please provide a snippet/tag name to perform this action!");
93			return;
94			}
95			}
96
97			await this.deferIfInteraction(message);
98
99			const command = this.client.commands.get(`snippet__${subcommand}`);
100
101			if (command) {
102			return await command.execute(message, {
103			...context,
104			...(context.isLegacy
105			? {
106			parsedNamedArgs: {
107			...context.parsedNamedArgs,
108			name: context.parsedNamedArgs.name,
109			content: context.parsedNamedArgs.content,
110			new_name: subcommand === "rename" ? context.parsedNamedArgs.content.split(/ +/)[0] : undefined
111			}
112			}
113			: {})
114			});
115			}
116			}
117			}