feat!: v6.0.0

Author: mariusbegby

.env.example

@@ -1,32 +1,15 @@
-# This file contains all the environment variables that are used by the bot.
+# This file contains all the environment variables used by the application.
+# Copy this to a new file named ".env" in the same location, and fill in the values for the variables.
 
-# For production use, set NODE_ENV to production
-# For development use, set NODE_ENV to development
+# Required: For production use, set NODE_ENV to production, for local development, set it to development
 NODE_ENV=development
 
 # Required: Login credentials for the bot
 # Retrieve your bot token and application id from https://discordapp.com/developers/applications/me
+# Do NOT share your bot token with anyone, as it can be used to control your bot.
 DISCORD_BOT_TOKEN=YOUR_DISCORD_BOT_TOKEN
 DISCORD_APPLICATION_ID=YOUR_DISCORD_BOT_APPLICATION_ID
 
-# Follow steps in README.md here to get authentication string: https://github.com/retrouser955/discord-player-youtubei
+# Run `npx --no discord-player-youtubei` to get authentication string
+# Follow steps in README.md here for more details: https://github.com/retrouser955/discord-player-youtubei#readme
 YT_EXTRACTOR_AUTH=
-
-# Optional: Authentication tokens for botlist websites to automatically update server count, etc.
-# See /src/utils/postBotStats.js for more information
-BOTLIST_TOP_GG_API_TOKEN=
-BOTLIST_DISCORD_BOT_LIST_COM_API_TOKEN=
-BOTLIST_DISCORDS_COM_API_TOKEN=
-BOTLIST_DISCORD_BOTS_GG_API_TOKEN=
-BOTLIST_BOTLIST_ME_API_TOKEN=
-BOTLIST_DISCORDLIST_GG_API_TOKEN=
-BOTLIST_DISCORD_BOTLIST_EU_API_TOKEN=
-
-# Optional: Only change this if you know what you are doing
-NODE_OPTIONS=
-UV_THREADPOOL_SIZE=
-
-# Optional: Password/token for pushing logs to Loki
-LOKI_HOST=
-LOKI_AUTH_USERNAME=
-LOKI_AUTH_PASSWORD=

.prettierignore

@@ -4,57 +4,37 @@
 
 ARG NODE_VERSION=20.12
 
-# Stage 1: Build and transpile TypeScript
-FROM node:${NODE_VERSION}-bookworm-slim as builder
+# Use Node.js image as the base image
+FROM node:${NODE_VERSION}-bookworm-slim
 
 # Set working directory
 WORKDIR /app
 
 # Install build dependencies necessary for native modules and clean up in one layer
-RUN apt-get update && apt-get install -y python3 make build-essential \
+RUN apt-get update && apt-get install -y python3 make build-essential ffmpeg ca-certificates \
     && apt-get clean && rm -rf /var/lib/apt/lists/*
 
+# Install pnpm globally
+RUN npm install -g pnpm
+
 # Copy only necessary source files
-COPY package*.json ./
-COPY tsconfig.json ./
-COPY src/ ./src/
-COPY config/ ./config/
-COPY locales/ ./locales/
+COPY package*.json ./ 
+COPY tsconfig.json ./ 
+COPY src/ ./src/ 
+COPY config/ ./config/ 
+COPY locales/ ./locales/ 
 
 # Install node dependencies
-RUN npm ci
-
-# Build the application
-RUN npm run build
-
-# Remove development dependencies
-RUN npm prune --omit=dev
-
-# Stage 2: Production environment
-FROM node:${NODE_VERSION}-bookworm-slim as production
-
-# Set working directory
-WORKDIR /app
-
-# Install runtime dependencies necessary for the application
-RUN apt-get update && apt-get install -y ffmpeg ca-certificates \
-    && apt-get clean && rm -rf /var/lib/apt/lists/*
-
-# Copy built artifacts from builder stage
-COPY --from=builder /app/node_modules ./node_modules
-COPY --from=builder /app/package.json ./package.json
-COPY --from=builder /app/dist ./dist
-COPY --from=builder /app/config ./config
-COPY --from=builder /app/locales ./locales
-
-# Rebuild native dependencies
-RUN npm rebuild && npm cache clean --force
+RUN pnpm install
 
 # Install mediaplex
-RUN npm install mediaplex
+RUN pnpm install mediaplex
+
+# Build the application
+RUN pnpm build
 
 # Cleanup unnecessary packages to minimize image size
 RUN apt-get purge -y python3 && apt-get autoremove -y
 
 # Start the application
-CMD /bin/sh -c "npm run deploy && npm run start"
+CMD ["/bin/sh", "-c", "pnpm run deploy && pnpm start"]

.prettierrc

@@ -53,20 +53,20 @@ Cadence offers an enriching audio experience on Discord with features such as:
 **Self-Hosting Steps**:
 
 1. Install [Node.js](https://nodejs.org/en/download/) v20.x LTS and latest version of [FFmpeg](https://ffmpeg.org/download.html).
-2. Clone this repository and run `npm install` (use `npm install --legacy-peer-deps` if errors occur).
-3. Build the project with `npm run build`.
-4. Configure `.env` file in the root directory with your bot token and client id (details in `.env.example`).
-5. Deploy slash commands using `npm run deploy`.
-6. Start the bot with `npm start`, the bot should now appear online and be operational.
+2. Install `pnpm` using `npm install -g pnpm`.
+3. Clone this repository and run `pnpm install`.
+4. Build the project with `pnpm build`.
+5. Create a `.env` file in with your bot token and client id (see details in `.env.example`).
+6. Deploy slash commands using `pnpm run deploy`.
+7. Start the bot with `pnpm start`, the bot should now appear online and be operational.
 
 **Note:** Refer to [Adding your bot to servers](https://discordjs.guide/preparations/adding-your-bot-to-servers.html#bot-invite-links) for help on inviting the bot to your server.
 
 ### Configuration and Logging:
 
--   Override default configuration by creating `/config/local.js`.
--   Install [pino-pretty](https://www.npmjs.com/package/pino-pretty) for formatted, colorized console output, this is included in optional dependencies.
+-   Override default configuration by creating `/config/local.ts`, copy over settings from `/config/default.ts`.
+-   Have [pino-pretty](https://www.npmjs.com/package/pino-pretty) installed for formatted, colorized console output.
 -   Logs are stored in `/logs` folder. Configure the logging level in the config file.
--   For production, usage of `pm2` or similar to manage the bot process is recommended.
 
 <br>
 

Dockerfile

@@ -0,0 +1,83 @@
+{
+    "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json",
+    "files": {
+        "ignore": ["**/dist/", "**/coverage/*", "**/node_modules/", "**/dist/**/*.js"]
+    },
+    "formatter": {
+        "enabled": true,
+        "formatWithErrors": false,
+        "indentStyle": "space",
+        "indentWidth": 4,
+        "lineEnding": "crlf",
+        "lineWidth": 120,
+        "attributePosition": "auto"
+    },
+    "organizeImports": {
+        "enabled": true
+    },
+    "linter": {
+        "enabled": true,
+        "rules": {
+            "recommended": true,
+            "correctness": {
+                "noUnusedImports": {
+                    "level": "error",
+                    "fix": "safe"
+                }
+            },
+            "nursery": {
+                "noConsole": "warn",
+                "noDuplicateJsonKeys": "warn",
+                "noUselessStringConcat": "warn",
+                "noUnusedFunctionParameters": "warn",
+                "noUselessUndefinedInitialization": "warn",
+                "useDateNow": "warn",
+                "useDefaultSwitchClause": "warn",
+                "useErrorMessage": "warn",
+                "useExplicitLengthCheck": "warn",
+                "useNumberToFixedDigitsArgument": "warn",
+                "useThrowNewError": "warn",
+                "useThrowOnlyError": "warn",
+                "useTopLevelRegex": "warn"
+            },
+            "performance": {
+                "noBarrelFile": "warn",
+                "noReExportAll": "warn"
+            },
+            "style": {
+                "noDefaultExport": "off",
+                "noNegationElse": "warn",
+                "useBlockStatements": "error",
+                "useCollapsedElseIf": "error",
+                "useConsistentArrayType": "warn",
+                "useForOf": "warn",
+                "useNamingConvention": {
+                    "level": "warn",
+                    "options": {
+                        "strictCase": false,
+                        "enumMemberCase": "PascalCase"
+                    },
+                    "fix": "safe"
+                },
+                "noNonNullAssertion": "off"
+            },
+            "suspicious": {
+                "noConfusingVoidType": "off"
+            }
+        },
+        "ignore": ["**/locales/**/*.d.ts", "**/src/common/services/logger.ts"]
+    },
+    "javascript": {
+        "formatter": {
+            "arrowParentheses": "always",
+            "attributePosition": "auto",
+            "bracketSameLine": false,
+            "bracketSpacing": true,
+            "jsxQuoteStyle": "double",
+            "quoteProperties": "asNeeded",
+            "quoteStyle": "single",
+            "semicolons": "always",
+            "trailingCommas": "none"
+        }
+    }
+}

README.md

@@ -1,46 +1,34 @@
 // Import Discord.js types for TypeScript support.
-const { ActivityType, PresenceUpdateStatus } = require('discord.js');
+import { ActivityType, PresenceUpdateStatus } from 'discord.js';
 
-// Description: Config file for Cadence Discord bot.
-
-// General metadata about the bot displayed in certain embeds.
-module.exports.botOptions = {
+export const botOptions = {
     name: 'Cadence',
     botInviteUrl: '',
     serverInviteUrl: '',
     openSourceUrl: ''
 };
 
-// Configuration for bot sharding. Refers to splitting a Discord bot into multiple processes.
-// For more information, refer to Discord.js sharding documentation: https://discordjs.guide/sharding/
-module.exports.shardingOptions = {
+export const shardingOptions = {
     totalShards: 'auto',
     shardList: 'auto',
     mode: 'process',
     respawn: true
 };
 
-// Configuration for logging bot actions.
-// You can set logging level to file and console separately.
-module.exports.loggerOptions = {
-    minimumLogLevel: 'debug',
+export const loggerOptions = {
+    minimumLogLevel: 'info',
     minimumLogLevelConsole: 'info',
     discordPlayerDebug: false
 };
 
-// Options for identifying specific system command.
-module.exports.systemOptions = {
-    // List of guild IDs where system commands can be executed. e.g. ['123456789012345678', '123456789012345678']
-    systemGuildIds: [],
+export const systemOptions = {
     // Channel for sending system messages, such as bot errors and disconnect events. e.g. '123456789012345678'
     systemMessageChannelId: '',
     // Bot administrator user ID for specific notifications through mentions in system channel. e.g. '123456789012345678'
     systemUserId: ''
 };
 
-// Configuration for the bot's presence and activity status.
-// Incude const { ActivityType, PresenceUpdateStatus } = require('discord.js'); at the top of config file.
-module.exports.presenceStatusOptions = {
+export const presenceStatusOptions = {
     status: PresenceUpdateStatus.Online,
     activities: [
         {
@@ -50,10 +38,7 @@ module.exports.presenceStatusOptions = {
     ]
 };
 
-// Configurations for visual embed messages.
-// Includes design elements like colors and custom emojis/symbols.
-// Also includes behavior options like button labels and player start messages.
-module.exports.embedOptions = {
+export const embedOptions = {
     info: {
         fallbackThumbnailUrl:
             'https://raw.githubusercontent.com/mariusbegby/cadence-discord-bot/main/assets/logo-rounded-128px.png',
@@ -122,8 +107,7 @@ module.exports.embedOptions = {
     }
 };
 
-// Configuration for the audio player. Includes behavior upon various events and UI components.
-module.exports.playerOptions = {
+export const playerOptions = {
     leaveOnEmpty: true,
     leaveOnEmptyCooldown: 600_000,
     leaveOnEnd: false,
@@ -145,15 +129,13 @@ module.exports.playerOptions = {
     }
 };
 
-// Configuration for ip rotation. Used for avoiding rate limits on certain APIs.
-module.exports.ipRotationConfig = {
+export const ipRotationConfig = {
     blocks: [],
     exclude: [],
     maxRetries: 3
 };
 
-// Configuration for ffmpeg filters for audio processing.
-module.exports.ffmpegFilterOptions = {
+export const ffmpegFilterOptions = {
     threadAmount: '2',
     forceNormalizerByBassBoost: true,
     maxFilters: 10,
@@ -227,7 +209,7 @@ module.exports.ffmpegFilterOptions = {
     ]
 };
 
-module.exports.biquadFilterOptions = {
+export const biquadFilterOptions = {
     availableFilters: [
         {
             label: 'Basic low pass (approx.)',
@@ -292,7 +274,7 @@ module.exports.biquadFilterOptions = {
     ]
 };
 
-module.exports.equalizerFilterOptions = {
+export const equalizerFilterOptions = {
     availableFilters: [
         {
             label: 'Flat',
@@ -405,9 +387,7 @@ module.exports.equalizerFilterOptions = {
     ]
 };
 
-// Configuration for load testing. Enables the bot to simulate certain behaviors for testing purposes.
-// If enabled, the bot will join the specified channels and play specified track.
-module.exports.loadTestOptions = {
+export const loadTestOptions = {
     enabled: false,
     trackUrl: 'https://www.youtube.com/watch?v=tTR4D9h3zAE',
     channelIdsToJoin: []