remove unneeded utils, rename lib directory to util

Signed-off-by: RedGuy12 <paul@reid-family.org>

README.md

@@ -56,6 +56,6 @@ This directory contains files each exporting a [Command object](/common/types/co
 
 This directory contains functions used for a feature (like potatoboard) that are used across multiple files. The `audio` subdirectory contains audio files used in some commands. The `types` subdirectory contins types used across the codebase.
 
-#### `lib`
+#### `util`
 
 This directory contains utility functions used across the codebase. It is different from `common` as its functions are not specific to this bot but could be useful in other apps as well. Each file in this directory contains multiple utility commands that each deal with the same type of data.

client.ts

@@ -4,7 +4,7 @@ import path from "path";
 import url from "url";
 import type { ClientEvent } from "./common/types/event";
 import type Event from "./common/types/event";
-import { importScripts, sanitizePath } from "./lib/files.js";
+import { importScripts, sanitizePath } from "./util/files.js";
 import pkg from "./package.json" assert { type: "json" };
 
 const Handler = new Client({
@@ -88,7 +88,7 @@ for (const [event, execute] of events.entries()) {
 				await execute()
 			)(...args);
 		} catch (error) {
-			const { default: logError } = await import("./lib/logError.js");
+			const { default: logError } = await import("./util/logError.js");
 			logError(error, event);
 		}
 	});

commands/addon.ts

@@ -2,10 +2,10 @@ import { SlashCommandBuilder, EmbedBuilder, escapeMarkdown, hyperlink } from "di
 import Fuse from "fuse.js";
 import CONSTANTS from "../common/CONSTANTS.js";
 import { manifest, addons } from "../common/extension.js";
-import { getBaseChannel } from "../lib/discord.js";
+import { getBaseChannel } from "../util/discord.js";
 
-import { escapeMessage, escapeLinks, generateTooltip } from "../lib/markdown.js";
-import { joinWithAnd } from "../lib/text.js";
+import { escapeMessage, escapeLinks, generateTooltip } from "../util/markdown.js";
+import { joinWithAnd } from "../util/text.js";
 import type { ChatInputCommand } from "../common/types/command";
 
 const fuse = new Fuse(addons, {

commands/explore-potatoes.ts

@@ -16,9 +16,9 @@ import {
 	boardReactionCount,
 } from "../common/board.js";
 import CONSTANTS from "../common/CONSTANTS.js";
-import { asyncFilter, firstTrueyPromise } from "../lib/promises.js";
-import { generateHash } from "../lib/text.js";
-import { disableComponents } from "../lib/discord.js";
+import { asyncFilter, firstTrueyPromise } from "../util/promises.js";
+import { generateHash } from "../util/text.js";
+import { disableComponents } from "../util/discord.js";
 import { guild } from "../client.js";
 import { MessageActionRowBuilder } from "../common/types/ActionRowBuilder.js";
 import type { ChatInputCommand } from "../common/types/command.js";

commands/guess-addon.ts

@@ -16,17 +16,16 @@ import {
 	MessageComponentType,
 	ModalSubmitInteraction,
 	Snowflake,
+	ActionRowBuilder,
+	ModalActionRowComponentBuilder,
 } from "discord.js";
 import Fuse from "fuse.js";
 import CONSTANTS from "../common/CONSTANTS.js";
 import { CURRENTLY_PLAYING, checkIfUserPlaying } from "../common/games.js";
 import { manifest, addons } from "../common/extension.js";
-import { generateHash, trimPatchVersion } from "../lib/text.js";
-import {
-	MessageActionRowBuilder,
-	ModalActionRowBuilder,
-} from "../common/types/ActionRowBuilder.js";
-import { disableComponents } from "../lib/discord.js";
+import { generateHash, trimPatchVersion } from "../util/text.js";
+import { MessageActionRowBuilder } from "../common/types/ActionRowBuilder.js";
+import { disableComponents } from "../util/discord.js";
 import client from "../client.js";
 import type AddonManifest from "../common/types/addonManifest";
 import type { ChatInputCommand } from "../common/types/command";
@@ -1605,7 +1604,7 @@ const info: ChatInputCommand = {
 									.setTitle("Guess the addon!")
 									.setCustomId(generateHash("guessModal"))
 									.addComponents(
-										new ModalActionRowBuilder().addComponents(
+										new ActionRowBuilder<ModalActionRowComponentBuilder>().addComponents(
 											new TextInputBuilder()
 												.setCustomId("addon")
 												.setLabel("Which addon do you think it is?")

commands/info.ts

@@ -1,7 +1,7 @@
 import { SlashCommandBuilder, time, Snowflake, EmbedBuilder, Role } from "discord.js";
 
-import { escapeMessage, replaceBackticks } from "../lib/markdown.js";
-import { joinWithAnd } from "../lib/text.js";
+import { escapeMessage } from "../util/markdown.js";
+import { joinWithAnd } from "../util/text.js";
 import CONSTANTS from "../common/CONSTANTS.js";
 import pkg from "../package.json" assert { type: "json" };
 import type { ChatInputCommand } from "../common/types/command.js";
@@ -170,9 +170,7 @@ const info: ChatInputCommand = {
 									value: joinWithAnd(
 										Object.entries(pkg.dependencies),
 										([dependency, version]) =>
-											`\`${replaceBackticks(
-												escapeMessage(dependency + "@" + version),
-											)}\``,
+											`\`${escapeMessage(dependency + "@" + version)}\``,
 									),
 									inline: true,
 								},

commands/is-bad-word.ts

@@ -2,7 +2,7 @@ import { SlashCommandBuilder, escapeMarkdown } from "discord.js";
 import CONSTANTS from "../common/CONSTANTS.js";
 import { censor } from "../common/moderation/automod.js";
 import type { ChatInputCommand } from "../common/types/command.js";
-import { joinWithAnd } from "../lib/text.js";
+import { joinWithAnd } from "../util/text.js";
 
 const info: ChatInputCommand = {
 	data: new SlashCommandBuilder()

commands/kill.ts

@@ -2,7 +2,7 @@ import { PermissionsBitField, SlashCommandBuilder } from "discord.js";
 import { AbortError } from "node-fetch";
 import { cleanDatabaseListeners } from "../common/database.js";
 import type { ChatInputCommand } from "../common/types/command.js";
-import logError from "../lib/logError.js";
+import logError from "../util/logError.js";
 
 const info: ChatInputCommand = {
 	data: new SlashCommandBuilder()

commands/suggestion.ts

@@ -12,9 +12,9 @@ import {
 import client, { guild } from "../client.js";
 import CONSTANTS from "../common/CONSTANTS.js";
 import giveXp from "../common/xp.js";
-import { escapeLinks } from "../lib/markdown.js";
-import { getAllMessages, paginate, reactAll } from "../lib/discord.js";
-import { truncateText } from "../lib/text.js";
+import { escapeLinks } from "../util/markdown.js";
+import { getAllMessages, paginate, reactAll } from "../util/discord.js";
+import { truncateText } from "../util/text.js";
 import type { ChatInputCommand } from "../common/types/command.js";
 
 export const SUGGESTION_EMOJIS: [string, string][] = [

commands/view-warns.js

@@ -17,7 +17,7 @@ import {
 	warnLog,
 	WARN_INFO_BASE,
 } from "../common/moderation/warns.js";
-import { convertBase } from "../lib/numbers.js";
+import { convertBase } from "../util/numbers.js";
 import { MessageActionRowBuilder } from "../common/types/ActionRowBuilder.js";
 
 /** @type {import("../common/types/command").ChatInputCommand} */

commands/warn.js

@@ -1,7 +1,7 @@
 import { PermissionsBitField, SlashCommandBuilder } from "discord.js";
 import CONSTANTS from "../common/CONSTANTS.js";
 import warn, { MUTE_LENGTHS, WARNS_PER_MUTE } from "../common/moderation/warns.js";
-import { stripMarkdown } from "../lib/markdown.js";
+import { stripMarkdown } from "../util/markdown.js";
 
 const DEFAULT_STRIKES = 1;
 

commands/xp.js

@@ -2,8 +2,8 @@ import { SlashCommandBuilder, EmbedBuilder } from "discord.js";
 import { guild } from "../client.js";
 import CONSTANTS from "../common/CONSTANTS.js";
 import { getLevelForXp, getXpForLevel, xpDatabase as database } from "../common/xp.js";
-import { paginate } from "../lib/discord.js";
-import { makeProgressBar } from "../lib/numbers.js";
+import { paginate } from "../util/discord.js";
+import { makeProgressBar } from "../util/numbers.js";
 
 /** @type {import("../common/types/command").ChatInputCommand} */
 export default {

common/board.js

@@ -7,7 +7,7 @@ import {
 	Message,
 } from "discord.js";
 import { guild } from "../client.js";
-import { extractMessageExtremities, getBaseChannel, messageToText } from "../lib/discord.js";
+import { extractMessageExtremities, getBaseChannel, messageToText } from "../util/discord.js";
 import { MessageActionRowBuilder } from "./types/ActionRowBuilder.js";
 import CONSTANTS from "./CONSTANTS.js";
 import Database from "./database.js";

common/extension.js

@@ -9,20 +9,19 @@ export const manifest = await fetch(`${CONSTANTS.urls.saSource}/manifest.json`).
 const addonIds = await fetch(`${CONSTANTS.urls.saSource}/addons/addons.json`).then(
 	async (response) => await /** @type {Promise<string[]>} */ (response.json()),
 );
-const addonPromises = [];
 
-for (const addonId of addonIds.filter((item) => !item.startsWith("//"))) {
-	addonPromises.push(
-		fetch(`${CONSTANTS.urls.saSource}/addons/${encodeURI(addonId)}/addon.json`).then(
-			async (response) => ({
-				...(await /** @type {Promise<import("./types/addonManifest").default>} */ (
-					response.json()
-				)),
+export const addons = await Promise.all(
+	addonIds
+		.filter((item) => !item.startsWith("//"))
+		.map((addonId) =>
+			fetch(`${CONSTANTS.urls.saSource}/addons/${encodeURI(addonId)}/addon.json`).then(
+				async (response) => ({
+					...(await /** @type {Promise<import("./types/addonManifest").default>} */ (
+						response.json()
+					)),
 
-				id: addonId,
-			}),
+					id: addonId,
+				}),
+			),
 		),
-	);
-}
-
-export const addons = await Promise.all(addonPromises);
+);

common/moderation/automod.js

@@ -2,10 +2,10 @@ import { Invite, cleanContent, FormattingPatterns } from "discord.js";
 import CONSTANTS from "../CONSTANTS.js";
 import fetch from "node-fetch";
 import warn from "./warns.js";
-import { stripMarkdown } from "../../lib/markdown.js";
-import { caesar, joinWithAnd, pingablify, normalize } from "../../lib/text.js";
+import { stripMarkdown } from "../../util/markdown.js";
+import { caesar, joinWithAnd, pingablify, normalize } from "../../util/text.js";
 import client, { guild } from "../../client.js";
-import { getBaseChannel } from "../../lib/discord.js";
+import { getBaseChannel } from "../../util/discord.js";
 /**
  * The index of each array determines how many strikes the word gives.
  *

common/modmail.js

@@ -8,11 +8,11 @@ import {
 	ButtonStyle,
 	User,
 } from "discord.js";
-import { generateHash } from "../lib/text.js";
+import { generateHash } from "../util/text.js";
 
-import { escapeMessage } from "../lib/markdown.js";
-import { asyncFilter } from "../lib/promises.js";
-import { disableComponents, extractMessageExtremities, messageToText } from "../lib/discord.js";
+import { escapeMessage } from "../util/markdown.js";
+import { asyncFilter } from "../util/promises.js";
+import { disableComponents, extractMessageExtremities, messageToText } from "../util/discord.js";
 
 import CONSTANTS from "./CONSTANTS.js";
 import { MessageActionRowBuilder } from "./types/ActionRowBuilder.js";

common/types/ActionRowBuilder.js

@@ -6,10 +6,3 @@ export class MessageActionRowBuilder extends ActionRowBuilder {
 		super();
 	}
 }
-
-/** @extends {ActionRowBuilder<import("discord.js").TextInputBuilder>} */
-export class ModalActionRowBuilder extends ActionRowBuilder {
-	constructor() {
-		super();
-	}
-}

common/types/addonManifest.d.ts

@@ -423,11 +423,3 @@ type AddonManifest = {
 };
 
 export default AddonManifest;
-
-export type WebsiteData = {
-	id: string;
-	name: AddonManifest["name"];
-	description: AddonManifest["description"];
-	tags: AddonManifest["tags"];
-	credits: AddonManifest["credits"];
-}[];

common/xp.js

@@ -1,7 +1,7 @@
 import { EmbedBuilder, GuildMember, User } from "discord.js";
 import { guild } from "../client.js";
 import { userSettingsDatabase } from "../commands/settings.js";
-import { nth } from "../lib/numbers.js";
+import { nth } from "../util/numbers.js";
 import CONSTANTS from "./CONSTANTS.js";
 import Database from "./database.js";
 

events/guild/member/add.js

@@ -3,7 +3,7 @@ import { guild } from "../../../client.js";
 import CONSTANTS from "../../../common/CONSTANTS.js";
 import { changeNickname } from "../../../common/moderation/automod.js";
 import log from "../../../common/moderation/logging.js";
-import { nth } from "../../../lib/numbers.js";
+import { nth } from "../../../util/numbers.js";
 import fileSystem from "fs/promises";
 import url from "url";
 import path from "path";

events/interactionCreate.js

@@ -3,9 +3,9 @@ import warn from "../common/moderation/warns.js";
 import { censor, badWordsAllowed } from "../common/moderation/automod.js";
 import { getWarns } from "../commands/view-warns.js";
 import CONSTANTS from "../common/CONSTANTS.js";
-import logError from "../lib/logError.js";
+import logError from "../util/logError.js";
 
-import { importScripts } from "../lib/files.js";
+import { importScripts } from "../util/files.js";
 import path from "path";
 import url from "url";
 import { guessAddon } from "../commands/guess-addon.js";

events/invalidated.js

@@ -1,4 +1,4 @@
-import logError from "../lib/logError.js";
+import logError from "../util/logError.js";
 
 /** @type {import("../common/types/event").default<"invalidated">} */
 export default async function event() {

events/message/create.js

@@ -20,14 +20,14 @@ import {
 	MODMAIL_UNSUPPORTED,
 } from "../../common/modmail.js";
 
-import { escapeMessage, stripMarkdown } from "../../lib/markdown.js";
-import { getBaseChannel, reactAll } from "../../lib/discord.js";
+import { escapeMessage, stripMarkdown } from "../../util/markdown.js";
+import { getBaseChannel, reactAll } from "../../util/discord.js";
 import giveXp, { NORMAL_XP_PER_MESSAGE } from "../../common/xp.js";
-import { normalize, truncateText } from "../../lib/text.js";
+import { normalize, truncateText } from "../../util/text.js";
 import client, { guild } from "../../client.js";
-import { asyncFilter } from "../../lib/promises.js";
+import { asyncFilter } from "../../util/promises.js";
 import { userSettingsDatabase } from "../../commands/settings.js";
-import logError from "../../lib/logError.js";
+import logError from "../../util/logError.js";
 
 const { GUILD_ID } = process.env;
 

events/message/delete.js

@@ -1,7 +1,7 @@
 import { AttachmentBuilder, ButtonBuilder, ButtonStyle } from "discord.js";
 import CONSTANTS from "../../common/CONSTANTS.js";
 import log from "../../common/moderation/logging.js";
-import { extractMessageExtremities, getBaseChannel, messageToText } from "../../lib/discord.js";
+import { extractMessageExtremities, getBaseChannel, messageToText } from "../../util/discord.js";
 import { MessageActionRowBuilder } from "../../common/types/ActionRowBuilder.js";
 
 /** @type {import("../../common/types/event").default<"messageDelete">} */

events/message/deleteBulk.js

@@ -1,6 +1,6 @@
 import { AttachmentBuilder, ButtonBuilder, ButtonStyle } from "discord.js";
 import log from "../../common/moderation/logging.js";
-import { getBaseChannel, messageToText } from "../../lib/discord.js";
+import { getBaseChannel, messageToText } from "../../util/discord.js";
 import { MessageActionRowBuilder } from "../../common/types/ActionRowBuilder.js";
 import CONSTANTS from "../../common/CONSTANTS.js";
 

events/message/update.js

@@ -1,6 +1,6 @@
 import { automodMessage } from "../../common/moderation/automod.js";
 import log, { getLoggingThread } from "../../common/moderation/logging.js";
-import { extractMessageExtremities, getBaseChannel } from "../../lib/discord.js";
+import { extractMessageExtremities, getBaseChannel } from "../../util/discord.js";
 import jsonDiff from "json-diff";
 import { AttachmentBuilder, ButtonBuilder, ButtonStyle, EmbedBuilder } from "discord.js";
 import diffLib from "difflib";

index.ts

@@ -4,10 +4,10 @@ import url from "url";
 
 import dotenv from "dotenv";
 
-import { importScripts } from "./lib/files.js";
+import { importScripts } from "./util/files.js";
 import pkg from "./package.json" assert { type: "json" };
 import fetch from "node-fetch";
-import { asyncFilter } from "./lib/promises.js";
+import { asyncFilter } from "./util/promises.js";
 import type { RESTPostAPIApplicationCommandsJSONBody } from "discord.js";
 import type Command from "./common/types/command";
 import http from "node:http";
@@ -27,7 +27,7 @@ declare global {
 dotenv.config();
 
 const { default: client, guild } = await import("./client.js");
-const { default: logError } = await import("./lib/logError.js");
+const { default: logError } = await import("./util/logError.js");
 const { cleanDatabaseListeners } = await import("./common/database.js");
 
 process

lib/markdown.js → util/markdown.js

@@ -10,16 +10,6 @@ import { escapeMarkdown, hyperlink } from "discord.js";
 export function escapeMessage(text) {
 	return escapeLinks(escapeMarkdown(text));
 }
-/**
- * Escape text for use inside inline code strings.
- *
- * @param {string} text - The text to escape.
- *
- * @returns {string} The escaped text.
- */
-export function replaceBackticks(text) {
-	return text.replaceAll("`", "'");
-}
 
 /**
  * Escape text for use in a link’s display or in a message sent by a webhook.