Issue 109 request to fix title duplication in the help command of zumito bot

[chemokita13]

I have solved that issue in 2 parts:

Title duplication bug

• For start, we have to get some context in help command file:

  • There was a for iteration in lines 86 to 91:

  for (let i = 0; i < commands.length; i++) {
      if (i % 4 == 0) {
          categoryEmbed
              .addFields([
                  {
                      name:
                          "📖" +
                          " " +
                          framework.translations.get(
                              "command.help.commands",
                              guildSettings.lang
                          ),
                      value:
                          "`" +
                          (commands[i]?.name || "") +
                          " " +
                          (commands[i + 1]?.name || "") +
                          " " +
                          (commands[i + 2]?.name || "") +
                          " " +
                          (commands[i + 3]?.name || "") +
                          "```",
                  },
              ])
  
              .setColor(config.global.embeds.color);
      }
  }

  • That bucle when the help argument is configuration, only runs 1 time (i==0) and because 0 % 4 == 0 it executes categoryEmbed.addField once.

  • But in the other hand, when help argument is information it runs 8 times (i == 0,1,2,3,4,5,6,7) but only executes categoryEmbed.addField 2 times (i==0,4) because 0 % 4 == 0 and 4 % 4 == 0. So, that 2 times it executes:

  categoryEmbed.addFields([
      {
          name:
              "📖" +
              " " +
              framework.translations.get(
                  "command.help.commands",
                  guildSettings.lang
              ),
          value:
              "`" +
              (commands[i]?.name || "") +
              " " +
              (commands[i + 1]?.name || "") +
              " " +
              (commands[i + 2]?.name || "") +
              " " +
              (commands[i + 3]?.name || "") +
              "```",
      },
  ]);

  But we do not want to have two names and two values, we have to have only one name, and 2 values, when i==0 && i==4 So, when i==0 and help argument is configuration we have to execute categoryEmbed.addField [...] but when is information we have to save the following string:

  "`" +
      (commands[i]?.name || "") +
      " " +
      (commands[i + 1]?.name || "") +
      " " +
      (commands[i + 2]?.name || "") +
      " " +
      (commands[i + 3]?.name || "") +
      "```";

  So I have created a new array before the bucle:

  let valuesToPush: string[] = [];

  And in the bucle we check if interaction.values[0] === "information" or interaction.values[0] === "configuration". The bucle will be like that:

  for (let i = 0; i < commands.length; i++) {
      if (interaction.values[0] === "information" && i % 4 == 0) {
          i == 4 && // when i==4 we have to push the values of the previous iteration
              categoryEmbed
                  .addFields([
                      {
                          name:
                              "📖" +
                              " " +
                              framework.translations.get(
                                  "command.help.commands",
                                  guildSettings.lang
                              ),
                          value:
                              "```" +
                              (commands[i]?.name || "") +
                              "       " +
                              (commands[i + 1]?.name || "") +
                              "       " +
                              (commands[i + 2]?.name || "") +
                              "       " +
                              (commands[i + 3]?.name || "") +
                              "       " +
                              valuesToPush.join("") + // Values of the previous iteration
                              "```",
                      },
                  ])
  
                  .setColor(config.global.embeds.color);
          i == 0 && // Only save the value, do not push it to .addFields()
              valuesToPush.push(
                  (commands[i]?.name || "") +
                      "       " +
                      (commands[i + 1]?.name || "") +
                      "       " +
                      (commands[i + 2]?.name || "") +
                      "       " +
                      (commands[i + 3]?.name || "")
              );
      } else {
          // If interaction.values[0] === "configuration" do it normally
          if (i % 4 == 0) {
              categoryEmbed
                  .addFields([
                      {
                          name:
                              "📖" +
                              " " +
                              framework.translations.get(
                                  "command.help.commands",
                                  guildSettings.lang
                              ),
                          value:
                              "```" +
                              (commands[i]?.name || "") +
                              "       " +
                              (commands[i + 1]?.name || "") +
                              "       " +
                              (commands[i + 2]?.name || "") +
                              "       " +
                              (commands[i + 3]?.name || "") +
                              "       " +
                              "```",
                      },
                  ])
                  .setColor(config.global.embeds.color);
          } // End if i%4==0
      } // End else's if interaction.values[0] === "information" && i % 4 == 0
  } // End for

  
  
  

  ---

  Emojis in help command

  • The emojis in the help command were not added. It was so easy, I only had to add the following code in the label of the menu:

  framework.translations.get(
      `global.category.${category}.emoji`,
      guildSettings.lang
  ) + " "; // Space to separate the emoji from the text

  But when the languaje was changed to spanish it didn't show the information's emoji, so I had to add the emoji in the translation file.

---

• For extra, I've formatted the code with Prettier and I changed information emoji: ℹ️ => 🏳️

[reviewpad[bot]]

AI-Generated Summary: This pull request includes updates to multiple files with the major changes being an upgrade to the zumito-framework from version 1.1.69 to 1.1.71. There were also modifications to the src/config/Global.ts, src/modules/global/translations/en.json, src/modules/global/translations/es.json, and src/modules/info/commands/help.ts files. In the config file, the bot name has been changed from 'Zumito Team Bot' to 'Zumito'. The en.json and es.json files have updated translations with the emoji for "information" changing to "🏳️". Lastly, the help.ts file has several updates improving the layout arrangement, changing the array methods, and expanding the execute method among other changes. All file endings have newline characters added at the end.

[reviewpad[bot]]

Thank you @chemokita13 for this first contribution!

[reviewpad[bot]]

Reviewpad Report

:warning: Warnings

• Please link an issue to the pull request

:bangbang: Errors

• Unconventional commit detected: 'update links' (16e1dedcb9455bf780ae207ad930e5f18c7a6714)
• Unconventional commit detected: 'Update Framewrok' (ed1ad9614931a8d910a2a8db7d18cd3c35383a14)
• Unconventional commit detected: 'code format by prettier' (fff113ccea1001e970768a8b542f7b0551b796c0)
• Unconventional commit detected: 'bug solved' (6555c10cb32f6964be1664f3832f3fc114fa5f37)
• Unconventional commit detected: 'changed information emojis' (dd5adb8114dae6c03f8fdea2ae769df17573ab2d)
• Unconventional commit detected: 'added emojis with each category' (11b0c9be36807dc64883c951f527043cbb75efbc)
• Unconventional commit detected: 'help info commands style added' (45f9fcf2df547378b92ab8675d4df1f7ae19891f)
• Unconventional commit detected: 'Merge branch 'main' into issue-109-Request_to_Fix_Title_Duplication_in_the_Help_Command_of_Zumito_Bot' (b59d21c72e10cb6e04080881d02e55513d146a66)
• Unconventional title detected: 'Issue 109 request to fix title duplication in the help command of zumito bot' illegal 'I' character in commit message type: col=00

[reviewpad[bot]]

AI-Generated Summary: This pull request updates various parts of the code. It includes changes to 'package-lock.json' and 'package.json' to bump the version of 'zumito-framework' from 1.1.69 to 1.1.71. The name of the bot is also changed from 'Zumito Team Bot' to 'Zumito' in 'Global.ts'. Changes are applied to the English and Spanish translations in 'en.json' and 'es.json' respectively, where the emoji for the information command category is changed, and the emoji for the Spanish information command category is added. Significant refactoring and additions are made to 'help.ts' file in the modules, improving the handling of commands and the interaction of the bot with Discord users. Also, the code structure has been cleaned up for readability.