Merge pull request #12 from BenjammingKirby/master

Display bot info on bot ping

Author: ItsAzaria

README.md

@@ -5,6 +5,7 @@ A Discord bot to display documentation
 ## Currently supported docs
 
 * discord.js (includes main/stable branch, includes djs-voice, djs-builders and djs-collection documentations)
+* Javascript ([mdn](https://developer.mozilla.org/))
 
 ## Docker
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "tph_docs_bot",
   "version": "1.0.0",
-  "description": "A bot made for TPH (The Programmers Hangout - discord.gg/programming) ",
+  "description": "A Discord bot to display documentation ",
   "main": "dist/bot.js",
   "scripts": {
     "tsc": "tsc",

src/bot.ts

@@ -1,29 +1,47 @@
 import "dotenv/config";
-import { Client, Collection } from "discord.js";
+import { Client, Collection, LimitedCollection } from "discord.js";
 import { MyContext } from "./interfaces";
 import { loadCommands, commandHandler } from "./handlers/CommandHandler";
+import { messageHandler } from "./handlers/MessageHandler";
 
 (async function () {
     const context: MyContext = {
         client: new Client({
-            intents: ["GUILDS"],
+            intents: ["GUILDS", "GUILD_MESSAGES"],
             presence: {
-                activities: [{ type: "WATCHING", name: "Discord.JS channel" }],
+                activities: [{ type: "PLAYING", name: "Read the docs" }],
                 status: "online",
             },
-            // For DMs, a partial channel object is received, in order to receive dms, CHANNEL partials must be activated  
+            // For DMs, a partial channel object is received, in order to receive dms, CHANNEL partials must be activated
             partials: ["CHANNEL"],
+            makeCache: (manager) => {
+                //! Disabling these caches will break djs funcitonality
+                const unsupportedCaches = [
+                    "GuildManager",
+                    "ChannelManager",
+                    "GuildChannelManager",
+                    "RoleManager",
+                    "PermissionOverwriteManager",
+                ];
+                if (unsupportedCaches.includes(manager.name)) return new Collection();
+                // Disable every supported cache
+                return new LimitedCollection({ maxSize: 0 });
+            },
         }),
         commands: new Collection(),
         cooldownCounter: new Collection(),
     };
     const docsBot = context.client;
     await loadCommands(context);
+
     docsBot.on("error", console.error);
     docsBot.on("warn", console.warn);
-    docsBot.on("ready", (client) => {
+
+    docsBot.once("ready", (client) => {
         console.info(`Logged in as ${client.user.tag} (${client.user.id})`);
     });
+
+    docsBot.on("messageCreate", messageHandler);
     docsBot.on("interactionCreate", commandHandler.bind(null, context));
 
     docsBot.login(process.env.TOKEN);

src/commands/docs/djs.ts

@@ -2,7 +2,7 @@
 import { Command } from "../../interfaces";
 import { SlashCommandBuilder } from "@discordjs/builders";
 import Doc, { sources } from "discord.js-docs";
-import { checkEmbedLimits } from "../../utils/embedUtils";
+import { checkEmbedLimits } from "../../utils/EmbedUtils";
 
 const supportedBranches = Object.keys(sources).map(
     (branch) => [capitalize(branch), branch] as [string, string]

src/handlers/MessageHandler.ts

@@ -0,0 +1,44 @@
+import { Formatters, MessageEmbed } from "discord.js";
+import type { Message } from "discord.js";
+import { intervalToDuration, intervalObjToStr } from "../utils/DateUtils";
+
+export async function messageHandler(message: Message<true>) {
+    try {
+        const clientUser = message.client.user;
+        // The regex for the bot's mention
+        const mentionRegex = new RegExp(`^<@!?${clientUser.id}>$`);
+
+        if (message.content.trim().match(mentionRegex)) {
+            const pkgJSONPath = "../../package.json";
+            const pkgJSON = await import(pkgJSONPath);
+            const { version, description, dependencies } = pkgJSON;
+
+            const uptime = intervalToDuration(Date.now() - message.client.uptime, Date.now());
+            const statusEmbed = new MessageEmbed()
+                .setTitle(`${clientUser.username} (v${version})`)
+                .setURL("https://github.com/the-programmers-hangout/tph-docs-bot/")
+                .setColor(0xd250c7)
+                .setDescription(description)
+                .setThumbnail(clientUser.displayAvatarURL({ dynamic: true, format: "png", size: 256 }))
+                .addField(
+                    "Currently Supported Docs",
+                    ["discord.js", "Javascript (mdn)"].map((str) => `\`${str}\``).join(", "),
+                )
+                .addField("Dependencies", Formatters.codeBlock("json", JSON.stringify(dependencies, undefined, 4)))
+                .addField("Uptime", `${intervalObjToStr(uptime)}` || "Just turned on")
+                .addField("Ping", message.client.ws.ping + "ms", true)
+                .addField("Source", "[Github](https://github.com/the-programmers-hangout/tph-docs-bot/)", true)
+                .addField(
+                    "Contributors",
+                    "[Link](https://github.com/the-programmers-hangout/tph-docs-bot/graphs/contributors)",
+                    true,
+                );
+
+            await message.reply({ embeds: [statusEmbed] });
+        }
+    } catch (e) {
+        console.error(e);
+    }
+
+    return;
+}

src/handlers/RegisterCommands.ts

@@ -39,7 +39,7 @@ const rest = new REST({ version: "9" }).setToken(token);
                 ? "Resetting"
                 : "Reloading"
         } application (/) commands for ${applicationId} ${
-            guildId ? `on guild ${guildId}` : ""
+            ["GUILD", "RESET_GUILD"].includes(registerMode)  ? `on guild ${guildId}` : ""
         }: \n\t${commands
             .map((cmd) => cmd.name)
             .join("\n\t")}\nOn mode: "${registerMode}"`

src/utils/DateUtils.ts

@@ -0,0 +1,51 @@
+const toSecondsConverterConstant = {
+    month: 30 * 24 * 60 * 60,
+    day: 24 * 60 * 60,
+    hour: 60 * 60,
+    minute: 60,
+    second: 1,
+};
+type formats = keyof typeof toSecondsConverterConstant;
+export function intervalToDuration(start: number | Date, end: number | Date = Date.now()) {
+    const intervalObj = {
+        month: 0,
+        day: 0,
+        hour: 0,
+        minute: 0,
+        second: 0,
+    };
+    const startDate = new Date(start).getTime() / 1000;
+    const endDate = new Date(end).getTime() / 1000;
+    const interval = Math.round(endDate - startDate);
+    // Months
+    const remainingDays = intervalToFormat(interval, "month", intervalObj);
+    // Days
+    const remainingHours = intervalToFormat(remainingDays, "day", intervalObj);
+    // Hours
+    const remainingMinutes = intervalToFormat(remainingHours, "hour", intervalObj);
+    // Minutes
+    const remainingSeconds = intervalToFormat(remainingMinutes, "minute", intervalObj);
+    // Seconds
+    intervalToFormat(remainingSeconds, "second", intervalObj);
+
+    return intervalObj;
+}
+function intervalToFormat(int: number, format: formats, intervalObj: Record<formats, number>): number {
+    const value = Math.floor(int / toSecondsConverterConstant[format]);
+    const remaining = value === 0 ? int : int - value * toSecondsConverterConstant[format];
+    intervalObj[format] = value;
+    return remaining;
+}
+export function intervalObjToStr(int: Record<formats, number> | number | Date) {
+    if (typeof int === "number" || int instanceof Date) int = intervalToDuration(int);
+
+    const formatStr = (format: formats) => {
+        const amount = int[format];
+        return amount ? `${amount} ${format}${amount === 1 ? "" : "s"}` : "";
+    };
+    return (["month", "day", "hour", "minute", "second"] as formats[]).reduce((acc, format) => {
+        const formatted = formatStr(format);
+        if (!acc) return formatted;
+        return formatted ? acc + ", " + formatted : acc;
+    }, "");
+}