2.0.0 (#147)

* 2.0.0

Removed the installer and all required packages.
Removed the `loadCommand` and `unloadCommand` functions.
Removed the `wait` function, was no longer used.
Removed the `owners` functionality as the concept was too advanced for an example bot.
Required the `logger` file where it was needed instead of binding it to `client`.
Required the `settings` database and `config` file where needed.
Moved the `clean` function into the `eval` command.
Updated all of the code to reflect these changes.
Moved the discord bot token into an `.env` file for better security.
Added `owner` to the `.env` file.

To-do;
Change `levelCache` into a function to pull it off the `client` property.

* Missed one

whoops, missed one.

* Fixed events

Removed `client` from `getSettings()` as it expects one variable, not two.

* Clean up

Removed an unused prototype pollutant, fixed a padding mistake and cleaned up the client object.

* Further clean up

Found some stray `client.awaitReply` functions, updated the reload command to work with aliases.

* Final draft of simplification.

Significantly reduced the `client` pollution by including a single `container` to the client and attaching every thing else, such as the `commands`, `aliases`, etc collections to that instead.

Updated the code to reflect these changes.

* Dependency update

Replaced the dead `moment`, and `moment-duration-format` dependencies with `@sapphire/time-utilities`.

Replaced `chalk` with `colorette`.

* Formatting consistency.

Updated the timestamp for the logger to be consistent with previous versions.

* Whoopsy

I forgot to revert a testing change.

* Removed default params

Both `stat` commands included redundant parameters, they have been removed.

* Fixing error logging

* Fixed Issues in Commands (#150)

* removed token lines from config.js (#151)

* removed token lines from config.js

* Update .gitignore

I'm making an executive decision to merge this without full testing from multiple sources;

It works for me and two other individuals.

Author: YorkAARGH

.env-example

@@ -0,0 +1,2 @@
+DISCORD_TOKEN=
+OWNER=

.gitignore

@@ -61,4 +61,4 @@ typings/
 # dotenv environment variables file
 .env
 
-/.vscode/
+/.vscode/

README.md

@@ -26,12 +26,11 @@ Need support? Join the [Idiot's Guide Community](https://discord.gg/vXVxsAjSMF)!
 - The node-gyp build tools. This is a pre-requisite for Enmap, but also for a **lot** of other modules. See [The Enmap Guide](https://enmap.evie.codes/install#pre-requisites) for details and requirements for your OS. Just follow what's in the tabbed block only, then come back here!
 
 You also need your bot's token. This is obtained by creating an application in
-the Developer section of discord.com. Check the [first section of this page](https://anidiots.guide/getting-started/the-long-version.html)
+the Developer section of discord.com. Check the [first section of this page](https://anidiots.guide/getting-started/getting-started-long-version)
 for more info.
 
 ## Intents
 
-Guidebot uses intents which are required as of October 7, 2020.
 You can enable privileged intents in your bot page
 (the one you got your token from) under `Privileged Gateway Intents`.
 
@@ -46,16 +45,16 @@ For more info about intents checkout the [official Discord.js guide page](https:
 
 ## Downloading
 
-Create a folder within your projects directory and run the following:
+Create a folder within your projects directory and run the following inside it:
 
 `git clone https://github.com/anidiotsguide/guidebot.git .`
 
 Once finished:
 
-- In the folder from where you ran the git command, run `npm install`, which will install the required packages,
-and it will then run the installer, make sure you have your token at hand to paste into the console.
+- In the folder from where you ran the git command, run `npm install`, which will install the required packages.
 - **If you get any error about python or msibuild.exe or binding, read the requirements section again!**
-- The installer will create the `config.js` file for you, if it doesn't work we have supplied an example config file.
+- Rename `config.js.example` to `config.js`, and give it the required intents and any partials you may require.
+- Rename `.env-example` to `.env` and put in your bot token in it and save.
 
 ## Starting the bot
 

commands/conf.js

@@ -7,12 +7,15 @@ your bot. The `del` action removes the key also from every guild, and loses its
 */
 
 const { codeBlock } = require("@discordjs/builders");
+const config = require("../config.js");
+const { awaitReply } = require("../modules/functions.js");
+const { settings } = require("../modules/settings.js");
 
 exports.run = async (client, message, [action, key, ...value], level) => { // eslint-disable-line no-unused-vars
 
   // Retrieve Default Values from the default settings in the bot.
-  const defaults = client.settings.get("default");
-  const replying = client.settings.ensure(message.guild.id, client.config.defaultSettings).commandReply;
+  const defaults = settings.get("default");
+  const replying = settings.ensure(message.guild.id, config.defaultSettings).commandReply;
 
   // Adding a new key adds it to every guild (it will be visible to all of them)
   if (action === "add") {
@@ -24,7 +27,7 @@ exports.run = async (client, message, [action, key, ...value], level) => { // es
     defaults[key] = value.join(" ");
 
     // One the settings is modified, we write it back to the collection
-    client.settings.set("default", defaults);
+    settings.set("default", defaults);
     message.reply({ content: `${key} successfully added with the value of ${value.join(" ")}`, allowedMentions: { repliedUser: (replying === "true") }});
   } else
 
@@ -36,7 +39,7 @@ exports.run = async (client, message, [action, key, ...value], level) => { // es
 
     defaults[key] = value.join(" ");
 
-    client.settings.set("default", defaults);
+    settings.set("default", defaults);
     message.reply({ content: `${key} successfully edited to ${value.join(" ")}`, allowedMentions: { repliedUser: (replying === "true") }});
   } else
 
@@ -47,20 +50,20 @@ exports.run = async (client, message, [action, key, ...value], level) => { // es
     if (!defaults[key]) return message.reply({ content: "This key does not exist in the settings", allowedMentions: { repliedUser: (replying === "true") }});
 
     // Throw the 'are you sure?' text at them.
-    const response = await client.awaitReply(message, `Are you sure you want to permanently delete ${key} from all guilds? This **CANNOT** be undone.`);
+    const response = await awaitReply(message, `Are you sure you want to permanently delete ${key} from all guilds? This **CANNOT** be undone.`);
 
     // If they respond with y or yes, continue.
     if (["y", "yes"].includes(response)) {
 
       // We delete the default `key` here.
       delete defaults[key];
-      client.settings.set("default", defaults);
+      settings.set("default", defaults);
 
       // then we loop on all the guilds and remove this key if it exists.
       // "if it exists" is done with the filter (if the key is present and it's not the default config!)
-      for (const [guildId, conf] of client.settings.filter((setting, id) => setting[key] && id !== "default")) {
+      for (const [guildId, conf] of settings.filter((setting, id) => setting[key] && id !== "default")) {
         delete conf[key];
-        client.settings.set(guildId, conf);
+        settings.set(guildId, conf);
       }
 
       message.reply({ content: `${key} was successfully deleted.`, allowedMentions: { repliedUser: (replying === "true") }});
@@ -80,7 +83,7 @@ exports.run = async (client, message, [action, key, ...value], level) => { // es
   // Display all default settings.
   } else {
     const array = [];
-    Object.entries(client.settings.get("default")).forEach(([key, value]) => {
+    Object.entries(settings.get("default")).forEach(([key, value]) => {
       array.push(`${key}${" ".repeat(20 - key.length)}::  ${value}`); 
     });
     await message.channel.send(codeBlock("asciidoc", `= Bot Default Settings =

commands/deploy.js

@@ -1,9 +1,9 @@
 exports.run = async (client, message, args, level) => { // eslint-disable-line no-unused-vars
 // Filter the slash commands to find guild only ones.
-  const guildCmds = client.slashcmds.filter(c => c.guildOnly).map(c => c.commandData);
+  const guildCmds = client.container.slashcmds.filter(c => c.guildOnly).map(c => c.commandData);
 
   // Now we filter out global commands by inverting the filter.
-  const globalCmds = client.slashcmds.filter(c => !c.guildOnly).map(c => c.commandData);
+  const globalCmds = client.container.slashcmds.filter(c => !c.guildOnly).map(c => c.commandData);
 
   // Give the user a notification the commands are deploying.
   await message.channel.send("Deploying commands!");

commands/eval.js

@@ -5,17 +5,36 @@
 
 const { codeBlock } = require("@discordjs/builders");
 
+/*
+  MESSAGE CLEAN FUNCTION
+
+  "Clean" removes @everyone pings, as well as tokens, and makes code blocks
+  escaped so they're shown more easily. As a bonus it resolves promises
+  and stringifies objects!
+  This is mostly only used by the Eval and Exec commands.
+*/
+async function clean(client, text) {
+  if (text && text.constructor.name == "Promise")
+    text = await text;
+  if (typeof text !== "string")
+    text = require("util").inspect(text, {depth: 1});
+
+  text = text
+    .replace(/`/g, "`" + String.fromCharCode(8203))
+    .replace(/@/g, "@" + String.fromCharCode(8203));
+
+  text = text.replaceAll(client.token, "[REDACTED]");
+
+  return text;
+}
+
 // However it's, like, super ultra useful for troubleshooting and doing stuff
 // you don't want to put in a command.
 exports.run = async (client, message, args, level) => { // eslint-disable-line no-unused-vars
   const code = args.join(" ");
-  try {
-    const evaled = eval(code);
-    const clean = await client.clean(client, evaled);
-    message.channel.send(codeBlock("js", clean));
-  } catch (err) {
-    message.channel.send(codeBlock("xl", `ERROR ${await client.clean(client, err)}`));
-  }
+  const evaled = eval(code);
+  const cleaned = await clean(client, evaled);
+  message.channel.send(codeBlock("js", cleaned));
 };
 
 exports.conf = {

commands/help.js

@@ -8,14 +8,16 @@ help command, its extended help is shown.
 const { codeBlock } = require("@discordjs/builders");
 
 exports.run = (client, message, args, level) => {
+  // Grab the container from the client to reduce line length.
+  const { container } = client;
   // If no specific command is called, show all filtered commands.
   if (!args[0]) {
     // Load guild settings (for prefixes and eventually per-guild tweaks)
     const settings = message.settings;
 
     // Filter all commands by which are available for the user's level, using the <Collection>.filter() method.
-    const myCommands = message.guild ? client.commands.filter(cmd => client.levelCache[cmd.conf.permLevel] <= level) :
-      client.commands.filter(cmd => client.levelCache[cmd.conf.permLevel] <= level && cmd.conf.guildOnly !== true);
+    const myCommands = message.guild ? container.commands.filter(cmd => container.levelCache[cmd.conf.permLevel] <= level) :
+      container.commands.filter(cmd => container.levelCache[cmd.conf.permLevel] <= level && cmd.conf.guildOnly !== true);
 
     // Then we will filter the myCommands collection again to get the enabled commands.
     const enabledCommands = myCommands.filter(cmd => cmd.conf.enabled);
@@ -44,9 +46,9 @@ exports.run = (client, message, args, level) => {
   } else {
     // Show individual command's help.
     let command = args[0];
-    if (client.commands.has(command)) {
-      command = client.commands.get(command);
-      if (level < client.levelCache[command.conf.permLevel]) return;
+    if (container.commands.has(command)) {
+      command = container.commands.get(command);
+      if (level < container.levelCache[command.conf.permLevel]) return;
       message.channel.send(codeBlock("asciidoc", `= ${command.help.name} = \n${command.help.description}\nusage:: ${command.help.usage}\naliases:: ${command.conf.aliases.join(", ")}`));
     }
   }};

commands/mylevel.js

@@ -1,6 +1,8 @@
+const config = require("../config.js");
+const { settings } = require("../modules/settings.js");
 exports.run = async (client, message, args, level) => {
-  const friendly = client.config.permLevels.find(l => l.level === level).name;
-  const replying = client.settings.ensure(message.guild.id, client.config.defaultSettings).commandReply;
+  const friendly = config.permLevels.find(l => l.level === level).name;
+  const replying = settings.ensure(message.guild.id, config.defaultSettings).commandReply;
   message.reply({ content: `Your permission level is: ${level} - ${friendly}`, allowedMentions: { repliedUser: (replying === "true") }});
 };
 

commands/reboot.js

@@ -1,9 +1,14 @@
+const config = require("../config.js");
+const { settings } = require("../modules/settings.js");
 exports.run = async (client, message, args, level) => { // eslint-disable-line no-unused-vars
-  const replying = client.settings.ensure(message.guild.id, client.config.defaultSettings).commandReply;
+  const replying = settings.ensure(message.guild.id, config.defaultSettings).commandReply;
   await message.reply({ content: "Bot is shutting down.", allowedMentions: { repliedUser: (replying === "true") }});
-  await Promise.all(client.commands.map(cmd =>
-    client.unloadCommand(cmd)
-  ));
+  await Promise.all(client.container.commands.map(cmd => {
+    // the path is relative to the *current folder*, so just ./filename.js
+    delete require.cache[require.resolve(`./${cmd.help.name}.js`)];
+    // We also need to delete and reload the command from the container.commands Enmap
+    client.container.commands.delete(cmd.help.name);
+  }));
   process.exit(0);
 };
 

commands/reload.js

@@ -1,12 +1,21 @@
+const config = require("../config.js");
+const { settings } = require("../modules/settings.js");
 exports.run = async (client, message, args, level) => { // eslint-disable-line no-unused-vars
-  const replying = client.settings.ensure(message.guild.id, client.config.defaultSettings).commandReply;
-  if (!args || args.length < 1) return message.reply({ content: "Must provide a command to reload. Derp.", allowedMentions: { repliedUser: (replying === "true") }});
-  const command = client.commands.get(args[0]) || client.commands.get(client.aliases.get(args[0]));
-  let response = await client.unloadCommand(args[0]);
-  if (response) return message.reply({ content: `Error Unloading: ${response}`, allowedMentions: { repliedUser: (replying === "true") }});
-
-  response = client.loadCommand(command.help.name);
-  if (response) return message.reply({ content: `Error Loading: ${response}`, allowedMentions: { repliedUser: (replying === "true") }});
+  // Grab the container from the client to reduce line length.
+  const { container } = client;
+  const replying = settings.ensure(message.guild.id, config.defaultSettings).commandReply;
+  if (!args || args.length < 1) return message.reply("Must provide a command name to reload.");
+  const command = container.commands.get(args[0]) || container.commands.get(container.aliases.get(args[0]));
+  // Check if the command exists and is valid
+  if (!command) {
+    return message.reply("That command does not exist");
+  }
+  // the path is relative to the *current folder*, so just ./filename.js
+  delete require.cache[require.resolve(`./${command.help.name}.js`)];
+  // We also need to delete and reload the command from the container.commands Enmap
+  container.commands.delete(command.help.name);
+  const props = require(`./${command.help.name}.js`);
+  container.commands.set(command.help.name, props);
 
   message.reply({ content: `The command \`${command.help.name}\` has been reloaded`, allowedMentions: { repliedUser: (replying === "true") }});
 };

commands/set.js

@@ -11,15 +11,17 @@
 // OR the same as:
 // const [action, key, ...value] = args;
 const { codeBlock } = require("@discordjs/builders");
+const { settings } = require("../modules/settings.js");
+const { awaitReply } = require("../modules/functions.js");
 
 exports.run = async (client, message, [action, key, ...value], level) => { // eslint-disable-line no-unused-vars
 
   // Retrieve current guild settings (merged) and overrides only.
-  const settings = message.settings;
-  const defaults = client.settings.get("default");
-  const overrides = client.settings.get(message.guild.id);
-  const replying = settings.commandReply;
-  if (!client.settings.has(message.guild.id)) client.settings.set(message.guild.id, {});
+  const serverSettings = message.settings;
+  const defaults = settings.get("default");
+  const overrides = settings.get(message.guild.id);
+  const replying = serverSettings.commandReply;
+  if (!settings.has(message.guild.id)) settings.set(message.guild.id, {});
 
   // Edit an existing key value
   if (action === "edit") {
@@ -31,13 +33,13 @@ exports.run = async (client, message, [action, key, ...value], level) => { // es
     // User must specify a value to change.
     if (joinedValue.length < 1) return message.reply({ content: "Please specify a new value", allowedMentions: { repliedUser: (replying === "true") }});
     // User must specify a different value than the current one.
-    if (joinedValue === settings[key]) return message.reply({ content: "This setting already has that value!", allowedMentions: { repliedUser: (replying === "true") }});
+    if (joinedValue === serverSettings[key]) return message.reply({ content: "This setting already has that value!", allowedMentions: { repliedUser: (replying === "true") }});
 
     // If the guild does not have any overrides, initialize it.
-    if (!client.settings.has(message.guild.id)) client.settings.set(message.guild.id, {});
+    if (!settings.has(message.guild.id)) settings.set(message.guild.id, {});
 
     // Modify the guild overrides directly.
-    client.settings.set(message.guild.id, joinedValue, key);
+    settings.set(message.guild.id, joinedValue, key);
 
     // Confirm everything is fine!
     message.reply({ content: `${key} successfully edited to ${joinedValue}`, allowedMentions: { repliedUser: (replying === "true") }});
@@ -50,29 +52,29 @@ exports.run = async (client, message, [action, key, ...value], level) => { // es
     if (!overrides[key]) return message.reply({ content: "This key does not have an override and is already using defaults.", allowedMentions: { repliedUser: (replying === "true") }});
 
     // Good demonstration of the custom awaitReply method in `./modules/functions.js` !
-    const response = await client.awaitReply(message, `Are you sure you want to reset ${key} to the default value?`);
+    const response = await awaitReply(message, `Are you sure you want to reset ${key} to the default value?`);
 
     // If they respond with y or yes, continue.
     if (["y", "yes"].includes(response.toLowerCase())) {
       // We delete the `key` here.
-      client.settings.delete(message.guild.id, key);
+      settings.delete(message.guild.id, key);
       message.reply({ content: `${key} was successfully reset to default.`, allowedMentions: { repliedUser: (replying === "true") }});
     } else
     // If they respond with n or no, we inform them that the action has been cancelled.
     if (["n","no","cancel"].includes(response)) {
-      message.reply({ content: `Your setting for \`${key}\` remains at \`${settings[key]}\``, allowedMentions: { repliedUser: (replying === "true") }});
+      message.reply({ content: `Your setting for \`${key}\` remains at \`${serverSettings[key]}\``, allowedMentions: { repliedUser: (replying === "true") }});
     }
   } else
 
   if (action === "get") {
     if (!key) return message.reply({ content: "Please specify a key to view", allowedMentions: { repliedUser: (replying === "true") }});
     if (!defaults[key]) return message.reply({ content: "This key does not exist in the settings", allowedMentions: { repliedUser: (replying === "true") }});
     const isDefault = !overrides[key] ? "\nThis is the default global default value." : "";
-    message.reply({ content: `The value of ${key} is currently ${settings[key]}${isDefault}`, allowedMentions: { repliedUser: (replying === "true") }});
+    message.reply({ content: `The value of ${key} is currently ${serverSettings[key]}${isDefault}`, allowedMentions: { repliedUser: (replying === "true") }});
   } else {
     // Otherwise, the default action is to return the whole configuration;
     const array = [];
-    Object.entries(settings).forEach(([key, value]) => {
+    Object.entries(serverSettings).forEach(([key, value]) => {
       array.push(`${key}${" ".repeat(20 - key.length)}::  ${value}`); 
     });
     await message.channel.send(codeBlock("asciidoc", `= Current Guild Settings =

commands/stats.js

@@ -1,15 +1,14 @@
 const { version } = require("discord.js");
 const { codeBlock } = require("@discordjs/builders");
-const moment = require("moment");
-require("moment-duration-format");
-
+const { DurationFormatter } = require("@sapphire/time-utilities");
+const durationFormatter = new DurationFormatter();
 
 exports.run = (client, message, args, level) => { // eslint-disable-line no-unused-vars
-  const duration = moment.duration(client.uptime).format(" D [days], H [hrs], m [mins], s [secs]");
+  const duration = durationFormatter.format(client.uptime);
   const stats = codeBlock("asciidoc", `= STATISTICS =
   • Mem Usage  :: ${(process.memoryUsage().heapUsed / 1024 / 1024).toFixed(2)} MB
   • Uptime     :: ${duration}
-  • Users      :: ${client.users.cache.size.toLocaleString()}
+  • Users      :: ${client.guilds.cache.map(g => g.memberCount).reduce((a, b) => a + b).toLocaleString()}
   • Servers    :: ${client.guilds.cache.size.toLocaleString()}
   • Channels   :: ${client.channels.cache.size.toLocaleString()}
   • Discord.js :: v${version}