feat: change almost every string value

Kathund · Kathund · commit bbe7b1aaf3af · 2025-06-16T11:57:39.000+08:00
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,16 @@
+{
+  "editor.tabSize": 2,
+  "prettier.useTabs": false,
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+  "editor.trimAutoWhitespace": true,
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  },
+  "typescript.format.semicolons": "insert",
+  "typescript.preferences.quoteStyle": "single"
+}
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # Spotify Manager
 
-Control spotify via a discord bot! What could go wrong? Allow anyone to queue songs, manage playback status and more
-all from a discord bot. This application uses [Discord.js v14](https://www.npmjs.com/package/discord.js) and the
+Control spotify via a discord bot! What could go wrong? Allow anyone to queue songs, manage playback status and more all
+from a discord bot. This application uses [Discord.js v14](https://www.npmjs.com/package/discord.js) and the
 [Spotify Web API](https://developer.spotify.com/documentation/web-api/).
 
 ## Table of Contents
diff --git a/messages.json b/messages.json
@@ -11,12 +11,51 @@
   "songQueued": "Song added to queue.",
   "defaultErrorMessage": "{warningEmoji} Something went wrong",
   "errorReported": "This error has been reported to the owner. Please try again later.",
-  "discordStatus": "to Music!",
+  "discordStatus": "Music!",
   "missingExecuteFunction": "Execute Method not implemented!",
   "missingRoutesFunction": "Routes Method not implemented!",
   "noSearchResults": "No Search Results Found",
   "tokenGenerated": "Token generated successfully",
   "errorFetchingData": "An error occurred while fetching data",
   "itemPreview": "Preview an Item",
-  "upcomingQueue": "Upcoming Queue\n**{warningEmoji} Warning:** This dose not show local files"
+  "upcomingQueue": "Upcoming Queue\n**{warningEmoji} Warning:** This dose not show local files",
+  "missingEmoji": "Missing Emoji",
+  "playbackEmbed": {
+    "nothingPlayingDescription": "User has nothing playing on spotify",
+    "description": "Currently {playbackState}",
+    "playbackStatePlaying": "Playing",
+    "playbackStatePaused": "Paused",
+    "progressBar": {
+      "enabled": true,
+      "title": "Progress",
+      "value": "{progressBar}"
+    },
+    "volumeBar": {
+      "enabled": true,
+      "title": "Volume",
+      "value": "{volumeBar}"
+    }
+  },
+  "trackEmbed": {
+    "title": "Track Information",
+    "description": "[{name}]({spotifyUrl}) {emojis}\n\n[{albumName}](<{albumSpotifyUrl}>) | [{artistName}](<{artistSpotifyUrl}>)"
+  },
+  "fallBackEmojis": {
+    "warning": "⚠️",
+    "spotify": "🟢",
+    "shuffle": "🔀",
+    "repeatOne": "🔂",
+    "repeat": "🔁",
+    "refresh": "🔄",
+    "queue": "🎶",
+    "play": "⏯️",
+    "pause": "⏸️",
+    "local": "🇱",
+    "info": "🇮",
+    "forwardOne": "▶️",
+    "forward": "⏩",
+    "explicit": "🇪",
+    "backOne": "◀️",
+    "back": "⏪"
+  }
 }
diff --git a/src/Discord/Buttons/Info.ts b/src/Discord/Buttons/Info.ts
@@ -15,7 +15,7 @@ class InfoButton extends Button {
     if (command === undefined) {
       await interaction.reply({
         content: ReplaceVariables(this.discord.Application.messages.buttonNotFound, {
-          warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+          warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
         }),
         flags: MessageFlags.Ephemeral
       });
diff --git a/src/Discord/Buttons/Pause.ts b/src/Discord/Buttons/Pause.ts
@@ -15,7 +15,7 @@ class PauseButton extends Button {
     if (command === undefined) {
       await interaction.reply({
         content: ReplaceVariables(this.discord.Application.messages.buttonNotFound, {
-          warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+          warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
         }),
         flags: MessageFlags.Ephemeral
       });
diff --git a/src/Discord/Buttons/Play.ts b/src/Discord/Buttons/Play.ts
@@ -15,7 +15,7 @@ class PlayButton extends Button {
     if (command === undefined) {
       await interaction.reply({
         content: ReplaceVariables(this.discord.Application.messages.buttonNotFound, {
-          warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+          warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
         }),
         flags: MessageFlags.Ephemeral
       });
diff --git a/src/Discord/Buttons/Previous.ts b/src/Discord/Buttons/Previous.ts
@@ -15,7 +15,7 @@ class PreviousButton extends Button {
     if (command === undefined) {
       await interaction.reply({
         content: ReplaceVariables(this.discord.Application.messages.buttonNotFound, {
-          warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+          warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
         }),
         flags: MessageFlags.Ephemeral
       });
diff --git a/src/Discord/Buttons/Queue.ts b/src/Discord/Buttons/Queue.ts
@@ -15,7 +15,7 @@ class QueueButton extends Button {
     if (command === undefined) {
       await interaction.reply({
         content: ReplaceVariables(this.discord.Application.messages.buttonNotFound, {
-          warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+          warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
         }),
         flags: MessageFlags.Ephemeral
       });
diff --git a/src/Discord/Buttons/Shuffle.ts b/src/Discord/Buttons/Shuffle.ts
@@ -15,7 +15,7 @@ class ShuffleButton extends Button {
     if (command === undefined) {
       await interaction.reply({
         content: ReplaceVariables(this.discord.Application.messages.buttonNotFound, {
-          warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+          warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
         }),
         flags: MessageFlags.Ephemeral
       });
diff --git a/src/Discord/Buttons/Skip.ts b/src/Discord/Buttons/Skip.ts
@@ -15,7 +15,7 @@ class SkipButton extends Button {
     if (command === undefined) {
       await interaction.reply({
         content: ReplaceVariables(this.discord.Application.messages.buttonNotFound, {
-          warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+          warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
         }),
         flags: MessageFlags.Ephemeral
       });
diff --git a/src/Discord/DiscordManager.ts b/src/Discord/DiscordManager.ts
@@ -4,7 +4,7 @@ import CommandHandler from './Handlers/CommandHandler';
 import DiscordUtils from './Private/DiscordUtils';
 import InteractionHandler from './Handlers/InteractionHandler';
 import StateHandler from './Handlers/StateHandler';
-import { Client, Collection, GatewayIntentBits } from 'discord.js';
+import { Client, Collection, Events, GatewayIntentBits } from 'discord.js';
 
 class DiscordManager {
   readonly Application: Application;
@@ -27,8 +27,8 @@ class DiscordManager {
   connect(): void {
     this.client = new Client({ intents: [GatewayIntentBits.Guilds] });
     this.commandHandler.deployCommands();
-    this.client.on('ready', () => this.stateHandler.onReady());
-    this.client.on('interactionCreate', (interaction) => this.interactionHandler.onInteraction(interaction));
+    this.client.on(Events.ClientReady, () => this.stateHandler.onReady());
+    this.client.on(Events.InteractionCreate, (interaction) => this.interactionHandler.onInteraction(interaction));
     this.client.login(this.Application.config.token).catch((e) => this.Application.Logger.error(e));
   }
 }
diff --git a/src/Discord/Handlers/InteractionHandler.ts b/src/Discord/Handlers/InteractionHandler.ts
@@ -31,7 +31,7 @@ class InteractionHandler {
       if (!ids.includes(interaction.customId)) {
         await interaction.reply({
           content: ReplaceVariables(this.discord.Application.messages.menuNotFound, {
-            warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+            warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
           }),
           flags: MessageFlags.Ephemeral
         });
diff --git a/src/Discord/Private/DiscordUtils.ts b/src/Discord/Private/DiscordUtils.ts
@@ -15,7 +15,7 @@ class DiscordUtils {
     const embed = new Embed(
       {
         title: ReplaceVariables(this.discord.Application.messages.defaultErrorMessage, {
-          warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+          warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
         }),
         description: this.discord.Application.messages.errorReported
       },
@@ -29,7 +29,7 @@ class DiscordUtils {
           new Embed({
             title: 'Error',
             description: `${ReplaceVariables(this.discord.Application.messages.defaultErrorMessage, {
-              warningEmoji: this.discord.emojis.get('warning') || 'Missing Emoji'
+              warningEmoji: this.discord.emojis.get('warning') || this.discord.Application.messages.missingEmoji
             })}\n\n\`\`\`${error.message}\n${error.stack}\n\`\`\``
           })
         ]
diff --git a/src/Spotify/Private/API/Playback.ts b/src/Spotify/Private/API/Playback.ts
@@ -1,7 +1,10 @@
+import * as messages from '../../../../messages.json';
 import Device from './Devices';
 import Embed from '../../../Discord/Private/Embed';
+import ReplaceVariables from '../../../Private/ReplaceVariables';
 import Track from './Track';
 import { ActionRowBuilder, ButtonBuilder, ButtonStyle, Collection, EmbedBuilder } from 'discord.js';
+
 export type RepeatState = 'off' | 'track' | 'context';
 
 class Playback {
@@ -52,13 +55,32 @@ class Playback {
 
   toEmbed(emojis: Collection<string, string>): EmbedBuilder {
     if (!this.item) {
-      return new Embed({ title: 'Nothing is playing.', description: 'User has nothing playing on spotify' });
+      return new Embed({
+        title: messages.nothingPlaying,
+        description: messages.playbackEmbed.nothingPlayingDescription
+      });
+    }
+
+    const embed = this.item.toEmbed(emojis).setTitle(
+      ReplaceVariables(messages.playbackEmbed.description, {
+        playbackState: this.playing ? messages.playbackEmbed.playbackStatePlaying : messages.playbackPaused
+      })
+    );
+
+    if (messages.playbackEmbed.progressBar.enabled) {
+      embed.addFields({
+        name: messages.playbackEmbed.progressBar.title,
+        value: ReplaceVariables(messages.playbackEmbed.progressBar.value, { progressBar: this.getProgressBar() })
+      });
     }
-    const embed = this.item
-      .toEmbed(emojis)
-      .setTitle(`Currently ${this.playing ? 'Playing' : 'Paused'}`)
-      .addFields({ name: 'Progress', value: this.getProgressBar() });
-    if (this.device?.supportsVolume) embed.addFields({ name: 'Volume', value: this.getVolumeBar() });
+
+    if (messages.playbackEmbed.volumeBar.enabled && this.device?.supportsVolume) {
+      embed.addFields({
+        name: messages.playbackEmbed.volumeBar.title,
+        value: ReplaceVariables(messages.playbackEmbed.volumeBar.value, { volumeBar: this.getProgressBar() })
+      });
+    }
+
     return embed;
   }
 
@@ -67,7 +89,7 @@ class Playback {
       return [
         new ActionRowBuilder<ButtonBuilder>().addComponents(
           new ButtonBuilder()
-            .setEmoji(emojis.get('spotify') || '')
+            .setEmoji(emojis.get('spotify') || messages.fallBackEmojis.spotify)
             .setStyle(ButtonStyle.Link)
             .setURL('https://open.spotify.com')
         )
@@ -76,41 +98,49 @@ class Playback {
     return [
       new ActionRowBuilder<ButtonBuilder>().addComponents(
         new ButtonBuilder()
-          .setEmoji(emojis.get('shuffle') || '')
+          .setEmoji(emojis.get('shuffle') || messages.fallBackEmojis.shuffle)
           .setStyle(this.shuffleState ? ButtonStyle.Success : ButtonStyle.Danger)
           .setCustomId('shuffle'),
         new ButtonBuilder()
-          .setEmoji(emojis.get('back') || '')
+          .setEmoji(emojis.get('back') || messages.fallBackEmojis.back)
           .setStyle(ButtonStyle.Secondary)
           .setCustomId('previous'),
         new ButtonBuilder()
-          .setEmoji(this.playing ? emojis.get('pause') || '' : emojis.get('play') || '')
+          .setEmoji(
+            this.playing
+              ? emojis.get('pause') || messages.fallBackEmojis.pause
+              : emojis.get('play') || messages.fallBackEmojis.play
+          )
           .setStyle(this.playing ? ButtonStyle.Success : ButtonStyle.Danger)
           .setCustomId(this.playing ? 'pause' : 'play'),
         new ButtonBuilder()
-          .setEmoji(emojis.get('forward') || '')
+          .setEmoji(emojis.get('forward') || messages.fallBackEmojis.forward)
           .setStyle(ButtonStyle.Secondary)
           .setCustomId('skip'),
         new ButtonBuilder()
-          .setEmoji('track' === this.repeatState ? emojis.get('repeatOne') || '' : emojis.get('repeat') || '')
+          .setEmoji(
+            'track' === this.repeatState
+              ? emojis.get('repeatOne') || messages.fallBackEmojis.repeatOne
+              : emojis.get('repeat') || messages.fallBackEmojis.repeat
+          )
           .setStyle('off' === this.repeatState ? ButtonStyle.Danger : ButtonStyle.Success)
           .setCustomId('repeat')
       ),
       new ActionRowBuilder<ButtonBuilder>().addComponents(
         new ButtonBuilder()
-          .setEmoji(emojis.get('refresh') || '')
+          .setEmoji(emojis.get('refresh') || messages.fallBackEmojis.refresh)
           .setStyle(ButtonStyle.Secondary)
           .setCustomId('refresh'),
         new ButtonBuilder()
-          .setEmoji(emojis.get('queue') || '')
+          .setEmoji(emojis.get('queue') || messages.fallBackEmojis.queue)
           .setStyle(ButtonStyle.Secondary)
           .setCustomId('queue'),
         new ButtonBuilder()
-          .setEmoji(emojis.get('spotify') || '')
+          .setEmoji(emojis.get('spotify') || messages.fallBackEmojis.spotify)
           .setStyle(ButtonStyle.Link)
           .setURL(this.item.spotifyUrl || 'https://open.spotify.com'),
         new ButtonBuilder()
-          .setEmoji(emojis.get('info') || '')
+          .setEmoji(emojis.get('info') || messages.fallBackEmojis.info)
           .setStyle(ButtonStyle.Primary)
           .setCustomId('info')
       )
diff --git a/src/Spotify/Private/API/Queue.ts b/src/Spotify/Private/API/Queue.ts
@@ -19,14 +19,18 @@ class Queue {
   toEmbed(emojis: Collection<string, string>): EmbedBuilder {
     const embed = new Embed({
       title: 'Queue',
-      description: ReplaceVariables(messages.upcomingQueue, { warningEmoji: emojis.get('warning') || 'Missing Emoji' })
+      description: ReplaceVariables(messages.upcomingQueue, {
+        warningEmoji: emojis.get('warning') || messages.missingEmoji
+      })
     });
+
     this.queue.map((track) => {
       embed.addFields({
         name: `${track.name} ${track.toEmojis(emojis)}`,
         value: `[${track.album.name}](<${track.album.spotifyUrl || 'https://open.spotify.com/'}>) | [${track.artists[0].name}](<${track.artists[0].spotifyUrl || 'https://open.spotify.com/'}>)`
       });
     });
+
     return embed;
   }
 }
diff --git a/src/Spotify/Private/API/Search/Search.ts b/src/Spotify/Private/API/Search/Search.ts
@@ -38,11 +38,11 @@ class Search {
       new ButtonBuilder()
         .setStyle(ButtonStyle.Secondary)
         .setCustomId('search.Start')
-        .setEmoji(emojis.get('back') || ''),
+        .setEmoji(emojis.get('back') || messages.fallBackEmojis.back),
       new ButtonBuilder()
         .setStyle(ButtonStyle.Secondary)
         .setCustomId('search.Back')
-        .setEmoji(emojis.get('backOne') || ''),
+        .setEmoji(emojis.get('backOne') || messages.fallBackEmojis.backOne),
       new ButtonBuilder()
         .setCustomId('MEOW')
         .setStyle(ButtonStyle.Secondary)
@@ -51,11 +51,11 @@ class Search {
       new ButtonBuilder()
         .setStyle(ButtonStyle.Secondary)
         .setCustomId('search.Forward')
-        .setEmoji(emojis.get('forwardOne') || ''),
+        .setEmoji(emojis.get('forwardOne') || messages.fallBackEmojis.forwardOne),
       new ButtonBuilder()
         .setStyle(ButtonStyle.Secondary)
         .setCustomId('search.End')
-        .setEmoji(emojis.get('forward') || '')
+        .setEmoji(emojis.get('forward') || messages.fallBackEmojis.forward)
     ];
     if (1 === this.getPages() || 0 === this.getPages()) {
       buttons[0].setDisabled(true);
diff --git a/src/Spotify/Private/API/Track.ts b/src/Spotify/Private/API/Track.ts
@@ -1,6 +1,8 @@
+import * as messages from '../../../../messages.json';
 import Album from './Album';
 import Artist from './Artist';
 import Embed from '../../../Discord/Private/Embed';
+import ReplaceVariables from '../../../Private/ReplaceVariables';
 import { ButtonBuilder, ButtonStyle, Collection, EmbedBuilder } from 'discord.js';
 
 class Track {
@@ -48,8 +50,16 @@ class Track {
   toEmbed(emojis: Collection<string, string>): EmbedBuilder {
     const embed = new Embed({
       author: `ID: ${this.id || 'Unknown'}`,
-      title: 'Track Information',
-      description: `[${this.name}](${this.spotifyUrl || 'https://open.spotify.com'}) ${this.toEmojis(emojis)}\n\n[${this.album.name}](<${this.album.spotifyUrl || 'https://open.spotify.com/'}>) | [${this.artists[0].name}](<${this.artists[0].spotifyUrl || 'https://open.spotify.com/'}>)`
+      title: messages.trackEmbed.title,
+      description: ReplaceVariables(messages.trackEmbed.description, {
+        name: this.name,
+        spotifyUrl: this.spotifyUrl || 'https://open.spotify.com',
+        emojis: this.toEmojis(emojis),
+        albumName: this.album.name,
+        albumSpotifyUrl: this.album.spotifyUrl || 'https://open.spotify.com',
+        artistName: this.artists[0].name,
+        artistSpotifyUrl: this.artists[0].spotifyUrl || 'https://open.spotify.com'
+      })
     });
     if (this.album.images[0]) embed.setThumbnail(this.album.images[0].url);
     return embed;
