Bugfix/schiltz3/deepsource (#88)

# Attempt to fix all open deepsource problems

## Needs testing

Fixed various discouraged patterns in code. 
The code worked but was considered bad practice

# Changes
* Remove unnecessary escape characters
* Ignore issue: no return from map
* Use object literal shorthand when returning dummy text channel
* Avoid improper shadowing
* use === instead of ==
* Remove unused arg
* Update tests to correspond to this branch's function. One should still
fail

Author: schiltz3

__tests__/utils/channels.tests.ts

@@ -1,33 +1,33 @@
-import { cleanChannelString } from "../../utils/channels";
-import { test, expect, describe, it } from "@jest/globals";
-
-//cleanChannelString
-
-describe("cleanChannelString", () => {
-  it("should lowercase the string", () => {
-    expect(cleanChannelString("ABCD")).toEqual("abcd");
-  });
-
-  it("should remove special characters", () => {
-    expect(cleanChannelString("a!b@c#d$")).toEqual("abcd");
-  });
-
-  it('should replace "compsci " with "cs"', () => {
-    expect(cleanChannelString("compsci")).toEqual("cs");
-  });
-
-  it("should replace spaces and parentheses with hyphens", () => {
-    expect(cleanChannelString("a b (c)")).toEqual("a-b-c");
-  });
-  it("should return an empty string for an empty input", () => {
-    expect(cleanChannelString("")).toBe("");
-  });
-
-  it("cleanChannelString should return an empty string for a string with only special characters", () => {
-    expect(cleanChannelString("!@#$%^&*")).toBe("");
-  });
-
-  it("should handle a mix of all transformations", () => {
-    expect(cleanChannelString("Compsci 123!")).toEqual("cs-123");
-  });
-});
+import { cleanChannelString } from "../../utils/channels";
+import { expect, describe, it } from "@jest/globals";
+
+//cleanChannelString
+
+describe("cleanChannelString", () => {
+  it("should lowercase the string", () => {
+    expect(cleanChannelString("ABCD")).toEqual("abcd");
+  });
+
+  it("should remove special characters", () => {
+    expect(cleanChannelString("a!b@c#d$")).toEqual("abcd");
+  });
+
+  it('should replace "compsci " with "cs"', () => {
+    expect(cleanChannelString("compsci ")).toEqual("cs");
+  });
+
+  it("should replace spaces and parentheses with hyphens", () => {
+    expect(cleanChannelString("a b (c)")).toEqual("a-b-c");
+  });
+  it("should return an empty string for an empty input", () => {
+    expect(cleanChannelString("")).toBe("");
+  });
+
+  it("cleanChannelString should return an empty string for a string with only special characters", () => {
+    expect(cleanChannelString("!@#$%^&*")).toBe("");
+  });
+
+  it("should handle a mix of all transformations", () => {
+    expect(cleanChannelString("Compsci a%$ 123!")).toEqual("csa-123");
+  });
+});

commands/owner/createRoles.ts

@@ -15,7 +15,7 @@ export default {
   requiredPermissions: ["MANAGE_GUILD", "MANAGE_ROLES"],
   ownerOnly: true,
 
-  callback: async ({ client, interaction: msgInt }) => {
+  callback: async ({ interaction: msgInt }) => {
     console.log(chalk.green("Creating roles..."));
     console.log(
       chalk.red("------------------------------------------------------")

commands/owner/csCreateChannels.ts

@@ -36,7 +36,7 @@ function create_default_embed(
 function cleanRoleString(role_name: string): string {
   const clean_role_name: string = role_name
     .toLowerCase()
-    .replace(/[`~!@#$%^&*))|+=?;:'",.<>\{\}\[\]\\\/]/gi, "")
+    .replace(/[`~!@#$%^&*))|+=?;:'",.<>{}[\]\\/]/gi, "")
     .replace(/[ (]/gi, "-");
   return clean_role_name;
 }
@@ -163,15 +163,17 @@ export default {
         courses[index].save();
 
         // Ping members who have this role
-        const role = msgInt.guild.roles.cache.find((role) => {
+        const found_role = msgInt.guild.roles.cache.find((role) => {
           return (
             cleanRoleString(role.name) ==
             cleanChannelString(courses[index].CODE)
           );
         });
-        if (role !== undefined) {
+        if (found_role !== undefined) {
           //Ping member
-          new_channel.send(`Hey! <@&${role.id}> here is a channel for you!`);
+          new_channel.send(
+            `Hey! <@&${found_role.id}> here is a channel for you!`
+          );
         }
       } else if (
         channel.parent !== null &&
@@ -194,15 +196,17 @@ export default {
         courses[index].CHANNEL_ID = channel.id;
         courses[index].save();
         // Ping members who have this role
-        const role = msgInt.guild.roles.cache.find((role) => {
+        const found_role = msgInt.guild.roles.cache.find((role) => {
           return (
             cleanRoleString(role.name) ==
             cleanChannelString(courses[index].CODE)
           );
         });
-        if (role !== undefined) {
+        if (found_role !== undefined) {
           //Ping member
-          channel.send(`Hey! <@&${role.id}> here is the channel for you!`);
+          channel.send(
+            `Hey! <@&${found_role.id}> here is the channel for you!`
+          );
         }
       } else if (
         channel.parent !== null &&

index.ts

@@ -38,7 +38,7 @@ client.on("ready", async () => {
 
     await Promise.all(
       client.guilds.cache.map((guild) => {
-        checkForRoles(guild);
+        checkForRoles(guild); // skipcq JS-0042
       })
     );
   }

utils/channels.ts

@@ -4,7 +4,7 @@ import chalk from "chalk";
 export function cleanChannelString(s: string): string {
   return s
     .toLowerCase()
-    .replace(/[`~!@#$%^&*))|+=?;:'",.<>\{\}\[\]\\\/]/gi, "")
+    .replace(/[`~!@#$%^&*))|+=?;:'",.<>{}[\]\\/]/gi, "")
     .replace("compsci ", "cs")
     .replace(/[ (]/gi, "-");
 }
@@ -16,17 +16,20 @@ export function checkForChannel(guild: Guild, channel_name: string) {
 }
 
 export async function findCategory(guild: Guild, category_name: string) {
-  let category = guild.channels.cache.find((category) => {
-    return category.name == category_name;
+  let found_category = guild.channels.cache.find((category) => {
+    return category.name === category_name;
   });
 
-  if (category === undefined || category.type !== "GUILD_CATEGORY") {
-    category = await guild.channels.create(category_name, {
+  if (
+    found_category === undefined ||
+    found_category.type !== "GUILD_CATEGORY"
+  ) {
+    found_category = await guild.channels.create(category_name, {
       type: "GUILD_CATEGORY",
     });
   }
 
-  return category;
+  return found_category;
 }
 export async function createTextChannel(
   guild: Guild,
@@ -36,11 +39,11 @@ export async function createTextChannel(
   category_name?: string
 ) {
   //Determine which arg to use
-  let channel_parent: CategoryChannel | undefined;
+  let parent: CategoryChannel | undefined;
   if (category !== undefined) {
-    channel_parent = category;
+    parent = category;
   } else if (category_name !== undefined) {
-    channel_parent = await findCategory(guild, category_name);
+    parent = await findCategory(guild, category_name);
   } else {
     throw Error(
       "Must specify either channel_category or channel_category_name"
@@ -49,8 +52,8 @@ export async function createTextChannel(
 
   return guild.channels.create(cleanChannelString(name), {
     type: "GUILD_TEXT",
-    topic: topic,
-    parent: channel_parent,
+    topic,
+    parent,
   });
 }
 
@@ -62,7 +65,7 @@ export async function moveChannel(
   if (
     channel.parent === null ||
     channel.parent === undefined ||
-    channel.parent?.name != category_name
+    channel.parent?.name !== category_name
   ) {
     const category = await findCategory(guild, category_name);
     channel.setParent(category);
@@ -81,7 +84,7 @@ export function concatCategoryName(
   category_name: string,
   category_number: number
 ) {
-  return category_number == 0
+  return category_number === 0
     ? category_name
     : `${category_name} ${category_number}`;
 }

utils/roles.ts

@@ -128,7 +128,7 @@ export async function checkForRoles(guild: Guild): Promise<boolean> {
       const name = guild.roles.cache.find((r) => r.name === element.ROLE_NAME);
       const id = guild.roles.cache.find((r) => r.id === element.ROLE_ID);
 
-      if (name == undefined && id == undefined) {
+      if (name === undefined && id === undefined) {
         console.log(
           chalk.red.bold(
             `Role ${element.ROLE_NAME} does not exist in ${guild.name}, Please run the /createRoles command in that server.`