From db898a2a36a8065433e7f3585575369f13b30cce Mon Sep 17 00:00:00 2001 From: Baipyrus Date: Thu, 4 Apr 2024 08:59:37 +0200 Subject: [PATCH] refactor: project wide renaming for accuracy --- commands/admin/custom_vc/slash.js | 12 ++++---- commands/admin/member_roles/slash.js | 14 ++++----- commands/admin/self_roles/context/register.js | 4 +-- commands/admin/self_roles/slash.js | 10 +++---- database.js | 30 +++++++++---------- events/channels/channelDelete.js | 4 +-- events/channels/voiceStateUpdate.js | 10 +++---- events/members/guildMemberAdd.js | 4 +-- events/messages/messageDelete.js | 4 +-- events/messages/reactionAdd.js | 6 ++-- events/messages/reactionRemove.js | 6 ++-- models/guilds.js | 2 +- models/messages.js | 2 +- models/roleEmojiPairs.js | 2 +- models/roles.js | 2 +- models/voiceChannels.js | 2 +- shared.js | 16 +++++----- 17 files changed, 65 insertions(+), 65 deletions(-) diff --git a/commands/admin/custom_vc/slash.js b/commands/admin/custom_vc/slash.js index b3fc6b6..e6c7a99 100644 --- a/commands/admin/custom_vc/slash.js +++ b/commands/admin/custom_vc/slash.js @@ -4,7 +4,7 @@ import { SlashCommandBuilder, ChatInputCommandInteraction } from 'discord.js'; -import { Guild, VoiceChannel } from '../../../database.js'; +import { Guilds, VoiceChannels } from '../../../database.js'; export const data = new SlashCommandBuilder() .setName('custom_vc') @@ -68,12 +68,12 @@ export async function execute(interaction) { step = 'save'; // Create guild if not exists - await Guild.findOrCreate({ + await Guilds.findOrCreate({ where: guildData, defaults: guildData }); // Save channel data - await VoiceChannel.create({ + await VoiceChannels.create({ id: channel.id, guild: guild.id, create: true @@ -94,12 +94,12 @@ export async function execute(interaction) { step = 'save'; // Create guild if not exists - await Guild.findOrCreate({ + await Guilds.findOrCreate({ where: guildData, defaults: guildData }); // Save channel data - await VoiceChannel.create({ + await VoiceChannels.create({ id, guild: guild.id, create: true @@ -120,7 +120,7 @@ export async function execute(interaction) { // Remove channel from guild step = 'remove'; - const count = await VoiceChannel.destroy({ + const count = await VoiceChannels.destroy({ where: { id, create: true diff --git a/commands/admin/member_roles/slash.js b/commands/admin/member_roles/slash.js index bdaa6c5..0f13507 100644 --- a/commands/admin/member_roles/slash.js +++ b/commands/admin/member_roles/slash.js @@ -1,20 +1,20 @@ import { SlashCommandBuilder, PermissionFlagsBits, ChatInputCommandInteraction } from 'discord.js'; -import { Role, Guild } from '../../../database.js'; +import { Roles, Guilds } from '../../../database.js'; /** - * @param {Guild} guild - * @param {Role} role + * @param {Guilds} guild + * @param {Roles} role */ const registerRole = async (guild, role) => { // Check if guild exists in database, otherwise create it const guildData = { id: guild.id }; - await Guild.findOrCreate({ + await Guilds.findOrCreate({ where: guildData, defaults: guildData }); // Register role in database - await Role.create({ + await Roles.create({ guild: guild.id, id: role.id, assign: true @@ -57,7 +57,7 @@ export async function execute(interaction) { switch (options.getSubcommand()) { case 'add': { // Search for role in database - const found = await Role.findOne({ + const found = await Roles.findOne({ where: { id: role.id } @@ -80,7 +80,7 @@ export async function execute(interaction) { } case 'remove': { // Remove role from database - const count = await Role.destroy({ + const count = await Roles.destroy({ where: { id: role.id, assign: true diff --git a/commands/admin/self_roles/context/register.js b/commands/admin/self_roles/context/register.js index 70df442..f50349f 100644 --- a/commands/admin/self_roles/context/register.js +++ b/commands/admin/self_roles/context/register.js @@ -4,7 +4,7 @@ import { PermissionFlagsBits, ContextMenuCommandInteraction } from 'discord.js'; -import { Message } from '../../../../database.js'; +import { Messages } from '../../../../database.js'; export const data = new ContextMenuCommandBuilder() .setDMPermission(false) @@ -17,7 +17,7 @@ export async function execute(interaction) { try { // Create database entry - await Message.create({ id }); + await Messages.create({ id }); // Reply successfully to acknowledge command await interaction.reply({ diff --git a/commands/admin/self_roles/slash.js b/commands/admin/self_roles/slash.js index 5a93806..2f9418a 100644 --- a/commands/admin/self_roles/slash.js +++ b/commands/admin/self_roles/slash.js @@ -1,6 +1,6 @@ import { PermissionFlagsBits, SlashCommandBuilder, ChatInputCommandInteraction } from 'discord.js'; import { addSelfRoles, removeSelfRoles } from '../../../shared.js'; -import { Guild, Message } from '../../../database.js'; +import { Guilds, Messages } from '../../../database.js'; /** * Sends a `Message` in the current channel and registers for self roles. @@ -48,11 +48,11 @@ const registerSelfRoles = async (interaction) => { await channel.messages.fetch(id); // Check if message is already registered - const found = await Message.findOne({ + const found = await Messages.findOne({ where: { id } }); - if (found) throw new Error('Message already registered!'); + if (found) throw new Error('Messages already registered!'); // Reply successfully to acknowledge command await interaction.reply({ @@ -196,13 +196,13 @@ export async function execute(interaction) { try { // Create guild if not exists const guildData = { id: interaction.guild.id }; - await Guild.findOrCreate({ + await Guilds.findOrCreate({ where: guildData, defaults: guildData }); // Create database entry - await Message.create({ + await Messages.create({ id, guild: interaction.guild.id }); diff --git a/database.js b/database.js index 77b1dc3..ef6c5bf 100644 --- a/database.js +++ b/database.js @@ -18,26 +18,26 @@ const sequelize = new Sequelize({ logging: false }); -const Response = defineResponse(sequelize); +const Responses = defineResponse(sequelize); -const Keyword = defineKeyword(sequelize); -Keyword.hasMany(Response, { foreignKey: 'keyword', onDelete: 'CASCADE' }); +const Keywords = defineKeyword(sequelize); +Keywords.hasMany(Responses, { foreignKey: 'keyword', onDelete: 'CASCADE' }); -const RoleEmojiPair = defineRoleEmojiPair(sequelize); +const RoleEmojiPairs = defineRoleEmojiPair(sequelize); -const VoiceChannel = defineVoiceChannel(sequelize); +const VoiceChannels = defineVoiceChannel(sequelize); -const Message = defineMessage(sequelize); -Message.hasMany(RoleEmojiPair, { foreignKey: 'message', onDelete: 'CASCADE' }); +const Messages = defineMessage(sequelize); +Messages.hasMany(RoleEmojiPairs, { foreignKey: 'message', onDelete: 'CASCADE' }); -const Role = defineRole(sequelize); -Role.hasMany(RoleEmojiPair, { foreignKey: 'role', onDelete: 'CASCADE' }); +const Roles = defineRole(sequelize); +Roles.hasMany(RoleEmojiPairs, { foreignKey: 'role', onDelete: 'CASCADE' }); -const Guild = defineGuild(sequelize); -Guild.hasMany(Keyword, { foreignKey: 'guild', onDelete: 'CASCADE' }); -Guild.hasMany(VoiceChannel, { foreignKey: 'guild', onDelete: 'CASCADE' }); -Guild.hasMany(Message, { foreignKey: 'guild', onDelete: 'CASCADE' }); -Guild.hasMany(Role, { foreignKey: 'guild', onDelete: 'CASCADE' }); +const Guilds = defineGuild(sequelize); +Guilds.hasMany(Keywords, { foreignKey: 'guild', onDelete: 'CASCADE' }); +Guilds.hasMany(VoiceChannels, { foreignKey: 'guild', onDelete: 'CASCADE' }); +Guilds.hasMany(Messages, { foreignKey: 'guild', onDelete: 'CASCADE' }); +Guilds.hasMany(Roles, { foreignKey: 'guild', onDelete: 'CASCADE' }); sequelize.sync(); -export { sequelize, Guild, Role, RoleEmojiPair, VoiceChannel, Message }; +export { sequelize, Guilds, Roles, Messages, VoiceChannels, RoleEmojiPairs, Keywords, Responses }; diff --git a/events/channels/channelDelete.js b/events/channels/channelDelete.js index 89eb675..006e03d 100644 --- a/events/channels/channelDelete.js +++ b/events/channels/channelDelete.js @@ -1,5 +1,5 @@ import { ChannelType, Events, GuildChannel } from 'discord.js'; -import { VoiceChannel } from '../../database.js'; +import { VoiceChannels } from '../../database.js'; export const name = Events.ChannelDelete; /** @param {GuildChannel} channel */ @@ -7,7 +7,7 @@ export async function execute(channel) { if (channel.type !== ChannelType.GuildVoice) return; // Delete channel entry once channel is deleted itself - const count = await VoiceChannel.destroy({ + const count = await VoiceChannels.destroy({ where: { id: channel.id } diff --git a/events/channels/voiceStateUpdate.js b/events/channels/voiceStateUpdate.js index 83a0590..1bbf008 100644 --- a/events/channels/voiceStateUpdate.js +++ b/events/channels/voiceStateUpdate.js @@ -7,7 +7,7 @@ import { VoiceState, PermissionsBitField } from 'discord.js'; -import { VoiceChannel } from '../../database.js'; +import { VoiceChannels } from '../../database.js'; /** * Function that either creates a new custom channel or gets an existing one registered in the database. @@ -18,7 +18,7 @@ import { VoiceChannel } from '../../database.js'; */ const getChannel = async (member, guildChs, channel) => { // Check database for existing channel - const ownCh = await VoiceChannel.findOne({ + const ownCh = await VoiceChannels.findOne({ where: { owner: member.id } @@ -35,7 +35,7 @@ const getChannel = async (member, guildChs, channel) => { }); // Save newly created channel - await VoiceChannel.create({ + await VoiceChannels.create({ id: privCh.id, owner: member.id }); @@ -58,7 +58,7 @@ const leftVoiceChat = async (state) => { if (members.length > 0) return; // Find channel by id, return if not registered as custom - const custom = await VoiceChannel.findOne({ + const custom = await VoiceChannels.findOne({ where: { id: channel.id, create: false @@ -84,7 +84,7 @@ export async function execute(oldState, newState) { if (!channel) return; // Find channel by id, return if not registered for customs - const createCh = await VoiceChannel.findOne({ + const createCh = await VoiceChannels.findOne({ where: { id: channel.id, create: true diff --git a/events/members/guildMemberAdd.js b/events/members/guildMemberAdd.js index 55722c0..d6287a1 100644 --- a/events/members/guildMemberAdd.js +++ b/events/members/guildMemberAdd.js @@ -1,11 +1,11 @@ import { Events, GuildMember } from 'discord.js'; -import { Role } from '../../database.js'; +import { Roles } from '../../database.js'; export const name = Events.GuildMemberAdd; /** @param {GuildMember} member */ export async function execute(member) { // Find roles to be assigned in guild from database - const roles = await Role.findAll({ + const roles = await Roles.findAll({ where: { guild: member.guild.id, assign: true diff --git a/events/messages/messageDelete.js b/events/messages/messageDelete.js index 4891c01..7a8d5b7 100644 --- a/events/messages/messageDelete.js +++ b/events/messages/messageDelete.js @@ -1,11 +1,11 @@ -import { Message } from '../../database.js'; +import { Messages } from '../../database.js'; import { Events } from 'discord.js'; export const name = Events.MessageDelete; /** @param {import('discord.js').Message} message */ export async function execute(message) { // Delete message entry once message is deleted itself - const count = await Message.destroy({ + const count = await Messages.destroy({ where: { id: message.id } diff --git a/events/messages/reactionAdd.js b/events/messages/reactionAdd.js index df5b1b0..83e7647 100644 --- a/events/messages/reactionAdd.js +++ b/events/messages/reactionAdd.js @@ -1,5 +1,5 @@ import { Events, MessageReaction, User } from 'discord.js'; -import { Message, RoleEmojiPair } from '../../database.js'; +import { Messages, RoleEmojiPairs } from '../../database.js'; import { config } from 'dotenv'; config(); @@ -14,7 +14,7 @@ export async function execute(reaction, user) { // Get message const msgID = reaction.message.id; - const message = await Message.findOne({ + const message = await Messages.findOne({ where: { id: msgID } @@ -24,7 +24,7 @@ export async function execute(reaction, user) { // Get emoji const emoji = reaction.emoji.toString(); - const rep = await RoleEmojiPair.findOne({ + const rep = await RoleEmojiPairs.findOne({ where: { message: msgID, emoji diff --git a/events/messages/reactionRemove.js b/events/messages/reactionRemove.js index c17c3da..b50e285 100644 --- a/events/messages/reactionRemove.js +++ b/events/messages/reactionRemove.js @@ -1,5 +1,5 @@ import { Events, MessageReaction, User } from 'discord.js'; -import { Message, RoleEmojiPair } from '../../database.js'; +import { Messages, RoleEmojiPairs } from '../../database.js'; import { config } from 'dotenv'; config(); @@ -14,7 +14,7 @@ export async function execute(reaction, user) { // Get message const msgID = reaction.message.id; - const message = await Message.findOne({ + const message = await Messages.findOne({ where: { id: msgID } @@ -24,7 +24,7 @@ export async function execute(reaction, user) { // Get emoji const emoji = reaction.emoji.toString(); - const rep = await RoleEmojiPair.findOne({ + const rep = await RoleEmojiPairs.findOne({ where: { message: msgID, emoji diff --git a/models/guilds.js b/models/guilds.js index e598974..da08429 100644 --- a/models/guilds.js +++ b/models/guilds.js @@ -6,7 +6,7 @@ import { DataTypes, Sequelize } from 'sequelize'; */ /** - * The definition of the `Guild` table in the database. + * The definition of the `Guilds` table in the database. * @param {Sequelize} sequelize */ export default function (sequelize) { diff --git a/models/messages.js b/models/messages.js index 36bcfb7..dd6162d 100644 --- a/models/messages.js +++ b/models/messages.js @@ -7,7 +7,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize'; */ /** - * The definition of the `Message` table in the database. + * The definition of the `Messages` table in the database. * @param {Sequelize} sequelize */ export default function (sequelize) { diff --git a/models/roleEmojiPairs.js b/models/roleEmojiPairs.js index cdc6096..5566318 100644 --- a/models/roleEmojiPairs.js +++ b/models/roleEmojiPairs.js @@ -9,7 +9,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize'; */ /** - * The definition of the `RoleEmojiPair` table in the database. + * The definition of the `RoleEmojiPairs` table in the database. * @param {Sequelize} sequelize */ export default function (sequelize) { diff --git a/models/roles.js b/models/roles.js index a4c6657..fe209d7 100644 --- a/models/roles.js +++ b/models/roles.js @@ -8,7 +8,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize'; */ /** - * The definition of the `Role` table in the database. + * The definition of the `Roles` table in the database. * @param {Sequelize} sequelize */ export default function (sequelize) { diff --git a/models/voiceChannels.js b/models/voiceChannels.js index 84d4125..050cb83 100644 --- a/models/voiceChannels.js +++ b/models/voiceChannels.js @@ -9,7 +9,7 @@ import { DataTypes, Deferrable, Sequelize } from 'sequelize'; */ /** - * The definition of the `VoiceChannel` table in the database. + * The definition of the `VoiceChannels` table in the database. * @param {Sequelize} sequelize */ export default function (sequelize) { diff --git a/shared.js b/shared.js index 8f75789..f9f953b 100644 --- a/shared.js +++ b/shared.js @@ -1,5 +1,5 @@ import { ChatInputCommandInteraction, ContextMenuCommandInteraction, Role } from 'discord.js'; -import { Message, RoleEmojiPair, Guild } from './database.js'; +import { Messages, RoleEmojiPairs, Guilds } from './database.js'; import { readdir } from 'fs/promises'; import { config } from 'dotenv'; import { Op } from 'sequelize'; @@ -15,7 +15,7 @@ config(); */ export const removeSelfRoles = async (interaction, id) => { // Try deleting message from database - const count = await Message.destroy({ + const count = await Messages.destroy({ where: { id: id } @@ -35,18 +35,18 @@ export const removeSelfRoles = async (interaction, id) => { }; /** - * Function to handle saving all the corresponding data for `Message` and `RoleEmojiPair` tables. + * Function to handle saving all the corresponding data for `Messages` and `RoleEmojiPairs` tables. * @param {string} id A Discord message ID. * @param {Role} role * @param {string} emoji Either a unicode emoji or a string representation in Discord custom emoji format. */ const saveMessageData = async (id, role, emoji) => { // Try finding message - const msg = await Message.findOne({ where: { id } }); + const msg = await Messages.findOne({ where: { id } }); if (msg === null) throw new Error(`No message with ID '${id}' could be found!`); // Try finding existing entry - const rep = await RoleEmojiPair.findOne({ + const rep = await RoleEmojiPairs.findOne({ where: { [Op.or]: [ { @@ -67,13 +67,13 @@ const saveMessageData = async (id, role, emoji) => { // Create guild if not exists const guildData = { id: role.guild.id }; - await Guild.findOrCreate({ + await Guilds.findOrCreate({ where: guildData, defaults: guildData }); // Create database entry for pair - await RoleEmojiPair.create({ + await RoleEmojiPairs.create({ message: id, role: role.id, guild: guildData.id, @@ -92,7 +92,7 @@ const editMessage = async (message, role, emoji) => { // Find out whether to pad message or already present let padding = '\n'; - const reps = await RoleEmojiPair.findAll({ where: { message: message.id } }); + const reps = await RoleEmojiPairs.findAll({ where: { message: message.id } }); if (reps.length === 0) padding += '\n'; // Get old and build new content of message