Merge pull request #69 from MobiFlight/copilot/enable-markdown-bot-messages

neilenns · web-flow · commit 76d8c151b70d · 2026-02-26T14:40:51.000-08:00
Replace rigid wiki message template with markdown content arrays
diff --git a/.gitignore b/.gitignore
@@ -129,4 +129,5 @@ dist
 .yarn/install-state.gz
 .pnp.*
 
-.env
+.env
+Docker/.env.prod
diff --git a/Docker/docker-compose.yml b/Docker/docker-compose.yml
@@ -1,18 +1,24 @@
-version: '3.8'
+version: "3.8"
 
 name: mobiflight-discord
 
 services:
   bot:
-    image: ghcr.io/neilenns/mobiflight-discord-bot:latest
-    restart: always      
+    image: ghcr.io/mobiflight/mobiflight-discord-bot:latest
+    restart: always
+    env_file:
+      - .env.prod
     environment:
-     - DISCORD_TOKEN=x # Application token
-     - DISCORD_CLIENT_ID=x # Application ID
-     - DISCORD_GUILD_ID=x # Server ID
-     - SOLVED_TAG_NAME=Solved
-     - ENABLE_COMMANDS=true
-     - WIKI_ITEMS_PATH=/config/wikiMenuItems.json
-     - YT_ITEMS_PATH=/config/ytMenuItems.json
+      - DISCORD_TOKEN=${DISCORD_TOKEN-}
+      - DISCORD_CLIENT_ID=${DISCORD_CLIENT_ID-}
+      # Mobiflight server
+      - DISCORD_GUILD_ID=${DISCORD_GUILD_ID-}
+      - SOLVED_TAG_NAME=${SOLVED_TAG:-Solved}
+      - ENABLE_COMMANDS=${ENABLE_COMMANDS:-true}
+      - WIKI_ITEMS_PATH=${WIKI_ITEMS_PATH:-/config/wikiMenuItems.json}
+      - OLD_THREAD_AGE_IN_DAYS=${OLD_THREAD_AGE_IN_DAYS:-360}
+      - LOG_LEVEL=${LOG_LEVEL:-info}
+      - LOGTAIL_TOKEN=${LOGTAIL_TOKEN-}
+      - BOT_LOG_WEBHOOK=${BOT_LOG_WEBHOOK-}
     volumes:
-     - ./config:/config
+      - ./config:/config
diff --git a/src/commands/general/wiki.js b/src/commands/general/wiki.js
@@ -4,11 +4,8 @@ const {
   StringSelectMenuOptionBuilder,
   SlashCommandBuilder,
   DiscordjsError,
-  hyperlink,
-  hideLinkEmbed,
 } = require("discord.js");
 const { replyOrEditReply } = require("../../utilities");
-const chokidar = require("chokidar");
 const fs = require("fs");
 
 const mainLogger = require("../../logger");
@@ -17,6 +14,22 @@ const logger = mainLogger.child({ service: "wiki" });
 let selectMenu;
 let menuItems;
 
+// Creates a description from the first line of content by stripping markdown formatting
+function createDescription(contentFirstLine) {
+  let description = contentFirstLine;
+
+  // Remove markdown links [text](url) -> text
+  description = description.replace(/\[([^\]]+)\]\([^)]+\)/g, "$1");
+
+  // Remove markdown formatting characters
+  description = description.replace(/[*_~`#]/g, "");
+
+  // Remove leading emojis (using common emoji ranges) and whitespace
+  description = description.replace(/^[\u{1F300}-\u{1F64F}\u{1F680}-\u{1F6FF}\u{2600}-\u{26FF}\u{2700}-\u{27BF}]+/ug, "");
+
+  return description.trim().substring(0, 100);
+}
+
 function loadMenuItems() {
   logger.debug(`Loading menu items from ${process.env.WIKI_ITEMS_PATH}`);
   try {
@@ -30,12 +43,18 @@ function loadMenuItems() {
       .setPlaceholder("Select a wiki topic");
 
     menuItems.forEach((item) => {
-      selectMenu.addOptions(
-        new StringSelectMenuOptionBuilder()
-          .setLabel(item.label)
-          .setDescription(item.description)
-          .setValue(item.value)
-      );
+      const option = new StringSelectMenuOptionBuilder()
+        .setLabel(item.label)
+        .setValue(item.value);
+
+      // Use description field if present, otherwise generate from first line of content
+      if (item.description) {
+        option.setDescription(item.description);
+      } else if (item.content && item.content.length > 0) {
+        option.setDescription(createDescription(item.content[0]));
+      }
+
+      selectMenu.addOptions(option);
     });
   } catch (err) {
     logger.error(
@@ -45,9 +64,10 @@ function loadMenuItems() {
   }
 }
 
-function watchForMenuChanges() {
+async function watchForMenuChanges() {
   // Start watching for file changes
   try {
+    const chokidar = (await import("chokidar")).default;
     chokidar
       .watch(process.env.WIKI_ITEMS_PATH, {
         awaitWriteFinish: true,
@@ -85,9 +105,9 @@ async function promptForTopic(interaction) {
 }
 
 module.exports = {
-  init: () => {
+  init: async () => {
     loadMenuItems();
-    watchForMenuChanges();
+    await watchForMenuChanges();
   },
   cooldown: 5,
   data: new SlashCommandBuilder()
@@ -120,19 +140,35 @@ module.exports = {
         return;
       }
 
-      const link = hyperlink(selectedItem.description, selectedItem.href);
-      const preamble =
-        selectedItem.preamble ??
-        "Check out the following link for more information:";
+      // Validate that the selected item has a non-empty content array
+      const isEmptyContent =
+        !selectedItem.content ||
+        !Array.isArray(selectedItem.content) ||
+        selectedItem.content.length === 0;
+
+      if (isEmptyContent) {
+        logger.error(
+          `Selected wiki item "${topic}" has invalid or empty content`,
+          { selectedItem }
+        );
+        await replyOrEditReply(interaction, {
+          content: `No wiki content available for ${topic}`,
+          ephemeral: true,
+        });
+        return;
+      }
+
+      // Build the message content from content array
+      const messageContent = selectedItem.content.join("\n");
 
       await replyOrEditReply(interaction, {
-        content: `Link sent!`,
+        content: 'Link sent!',
         components: [],
         ephemeral: true,
       });
 
       await interaction.channel.send({
-        content: `${preamble} ${link}`,
+        content: messageContent,
       });
     } catch (error) {
       // Errors from the user not responding to the dropdown in time don't log,
diff --git a/src/index.js b/src/index.js
@@ -37,7 +37,7 @@ function loadEvents() {
   }
 }
 
-function loadCommands() {
+async function loadCommands() {
   try {
     const foldersPath = path.join(__dirname, "commands");
     const commandFolders = fs.readdirSync(foldersPath);
@@ -55,7 +55,7 @@ function loadCommands() {
         // Initialize the command if it has an initializer
         if ("init" in command) {
           logger.debug(`Initializing ${filePath}`, { file: filePath });
-          command.init();
+          await command.init();
         }
 
         // Set a new item in the Collection with the key as the command name and the value as the exported module
@@ -75,7 +75,9 @@ function loadCommands() {
 }
 
 if (process.env.ENABLE_COMMANDS === "true") {
-  loadCommands();
+  loadCommands().catch((err) => {
+    logger.error(`Failed to load commands: ${err.message}`, err);
+  });
 } else {
   logger.info(`Commands disabled, skipping creating them.`);
 }
diff --git a/wikiMenuItems.json b/wikiMenuItems.json
@@ -3,56 +3,168 @@
     "label": "Honeycomb Bravo",
     "description": "Using the selector knob on a Honeycomb Bravo",
     "value": "honeycombbravo",
-    "href": "https://github.com/MobiFlight/MobiFlight-Connector/wiki/Using-the-selector-knob-on-a-Honeycomb-Bravo",
-    "preamble": "Check out this wiki page for information on using the selector knob with the Honeycomb Bravo:"
+    "content": [
+      "👉 **Check out this wiki page** for information on using the selector knob with the Honeycomb Bravo:",
+      "[Using the selector knob on a Honeycomb Bravo](<https://github.com/MobiFlight/MobiFlight-Connector/wiki/Using-the-selector-knob-on-a-Honeycomb-Bravo>)"
+    ]
   },
   {
     "label": "Multiplexers",
     "description": "Beginner's guide to input multiplexers",
     "value": "multiplexers",
-    "href": "https://github.com/MobiFlight/MobiFlight-Connector/wiki/Beginner%27s-guide-to-input-multiplexers",
-    "preamble": "Check out this wiki page for information on using multiplexers with MobiFlight:"
+    "content": [
+      "👉 **Check out this wiki page** for information on using multiplexers with MobiFlight:",
+      "[Beginner's guide to input multiplexers](<https://github.com/MobiFlight/MobiFlight-Connector/wiki/Beginner%27s-guide-to-input-multiplexers>)"
+    ]
   },
   {
     "label": "Input shifters",
     "description": "Adding lots of buttons with an input shift register",
     "value": "inputshifters",
-    "href": "https://github.com/MobiFlight/MobiFlight-Connector/wiki/Adding-lots-of-buttons-with-an-input-shift-register",
-    "preamble": "Check out this wiki page for information on using input shifters with MobiFlight:"
+    "content": [
+      "👉 **Check out this wiki page** for information on using input shifters with MobiFlight:",
+      "[Adding lots of buttons with an input shift register](<https://github.com/MobiFlight/MobiFlight-Connector/wiki/Adding-lots-of-buttons-with-an-input-shift-register>)"
+    ]
   },
   {
     "label": "Output shifters",
     "description": "Controlling LEDs with an output shift register",
     "value": "outputshifters",
-    "href": "https://github.com/MobiFlight/MobiFlight-Connector/wiki/Controlling-LEDs-with-an-output-shift-register",
-    "preamble": "Check out this wiki page for information on using output shifters with MobiFlight:"
+    "content": [
+      "👉 **Check out this wiki page** for information on using output shifters with MobiFlight:",
+      "[Controlling LEDs with an output shift register](<https://github.com/MobiFlight/MobiFlight-Connector/wiki/Controlling-LEDs-with-an-output-shift-register>)"
+    ]
   },
   {
     "label": "Logs",
     "description": "Providing logs from MobiFlight",
     "value": "logs",
-    "href": "https://github.com/MobiFlight/MobiFlight-Connector/wiki/Providing-logs-from-MobiFlight",
-    "preamble": "To help diagnose your problem we need to see your MobiFlight logs. Follow the steps in this wiki to get them:"
+    "content": [
+      "To help diagnose your problem we need to see your MobiFlight logs. Follow the steps in this wiki to get them:",
+      "[Providing logs from MobiFlight](<https://github.com/MobiFlight/MobiFlight-Connector/wiki/Providing-logs-from-MobiFlight>)"
+    ]
   },
   {
     "label": "7 Segments",
     "description": "Setting up 7 segment LED modules with SimConnect Events",
     "value": "7segments",
-    "href": "https://github.com/MobiFlight/MobiFlight-Connector/wiki/Tutorial-Setting-up-7-segment-LED-modules-with-SimConnect-Events",
-    "preamble": "Check out this wiki page for information on using 7-segment LED modules with MobiFlight:"
+    "content": [
+      "👉 **Check out this wiki page** for information on using 7-segment LED modules with MobiFlight:",
+      "[Setting up 7 segment LED modules with SimConnect Events](<https://github.com/MobiFlight/MobiFlight-Connector/wiki/Tutorial-Setting-up-7-segment-LED-modules-with-SimConnect-Events>)"
+    ]
   },
   {
     "label": "CH340",
     "description": "Arduino Nano and Mega with CH340 chips connection issues",
     "value": "ch340",
-    "href": "https://www.badcasserole.com/arduino-nano-with-ch340-chips-connection-issues/",
-    "preamble": "It sounds like your Arduino uses a counterfeit CH340 chip. You can find more information about this problem and how to fix it by visiting this blog post:"
+    "content": [
+      "It sounds like your Arduino uses a counterfeit CH340 chip. You can find more information about this problem and how to fix it by visiting this blog post:",
+      "[Arduino Nano and Mega with CH340 chips connection issues](<https://www.badcasserole.com/arduino-nano-with-ch340-chips-connection-issues/>)"
+    ]
   },
   {
     "label": "Getting started 2023",
     "description": "Getting Started 2023 - MobiFlight Tutorial",
     "value": "gettingstarted",
-    "href": "https://www.youtube.com/watch?v=pS8KGfYRNrY",
-    "preamble": "Check out this YouTube video for a good introduction on getting started with MobiFlight:"
+    "content": [
+      "👉 **Check out this YouTube video** for a good introduction on getting started with MobiFlight:",
+      "[Getting Started 2023 - MobiFlight Tutorial](<https://www.youtube.com/watch?v=pS8KGfYRNrY>)"
+    ]
+  },
+  {
+    "label": "Using potentiometers with MobiFlight",
+    "description": "Using potentiometers with MobiFlight",
+    "value": "pots",
+    "content": [
+      "👉 **Check out the documentation** for a step-by-step guide to using potentiometers with MobiFlight:",
+      "[Using potentiometers with MobiFlight](<https://docs.mobiflight.com/devices/potentiometer/>)"
+    ]
+  },
+  {
+    "label": "Finding input events (2020)",
+    "description": "Uncovering input events using the MSFS2020 behavior dialog",
+    "value": "inputevents",
+    "content": [
+      "You can use the developer tools in MSFS2020 to find the code for the input events.",
+      "See this blog post for details on how to do it:",
+      "[Uncovering input events using the MSFS2020 model behavior dialog](<https://www.badcasserole.com/uncovering-input-events-using-the-msfs2020-model-behavior-dialog/>)"
+    ]
+  },
+  {
+    "label": "Finding input events (2024)",
+    "description": "Finding input events in Microsoft Flight Simulator 2024",
+    "value": "inputevents2024",
+    "content": [
+      "👉 **Check out the documentation** for a step-by-step guide to finding input events in Microsoft Flight Simulator 2024:",
+      "[Finding input events in Microsoft Flight Simulator 2024](<https://docs.mobiflight.com/guides/input-events-2024/>)"
+    ]
+  },
+  {
+    "label": "Using three-position switches with MobiFlight",
+    "description": "Using three-position switches with MobiFlight",
+    "value": "threeposition",
+    "content": [
+      "👉 **Check out the documentation** for a step-by-step guide to using three-position switches with MobiFlight:",
+      "[Using three-position switches with MobiFlight](<https://docs.mobiflight.com/devices/button-switch/>)"
+    ]
+  },
+  {
+    "label": "Verifying the WASM module",
+    "description": "Verifying the WASM module installation",
+    "value": "wasm",
+    "content": [
+      "👉 **Check out the documentation** for a step-by-step guide to resolving WASM installation issues:",
+      "[Verifying the WASM module](<https://docs.mobiflight.com/guides/wasm-module/>)"
+    ]
+  },
+  {
+    "label": "Using WINWING devices with MobiFlight",
+    "description": "Using WINWING devices with MobiFlight",
+    "value": "ww",
+    "content": [
+      "👉 **Check out the documentation** for information on using your WINWING device with MobiFlight:",
+      "[Using WINWING devices with MobiFlight](<https://docs.mobiflight.com/game-controllers/winwing/>)"
+    ]
+  },
+  {
+    "label": "Using the WINWING PFP 3N with MobiFlight",
+    "description": "Using the WINWING PFP 3N with MobiFlight",
+    "value": "cdu",
+    "content": [
+      "👉 **Follow the step-by-step guide** to set up your PFP 3N with MobiFlight:",
+      "[Using the WINWING PFP 3N with MobiFlight](<https://docs.mobiflight.com/game-controllers/winwing/winwing-cdu>)"
+    ]
+  },
+  {
+    "label": "Solving flashing errors",
+    "description": "Solving flashing errors",
+    "value": "flashing",
+    "content": [
+      "👉 **See the following guide** to troubleshoot ⚡flashing errors:",
+      "[Solving flashing errors](<https://docs.mobiflight.com/guides/solving-flashing-errors/>)"
+    ]
+  },
+  {
+    "label": "Taking screenshots",
+    "description": "Taking screenshots using the Windows snipping tool",
+    "value": "screenshots",
+    "content": [
+      "👉 **To take a screenshot**, you can use the ✂️ **Windows snipping tool**.",
+      "",
+      "**Here's how:**",
+      "* `Win` + `Shift` + `S` to open the snipping tool, then select the area you want to capture.",
+      "* The screenshot will be copied to your clipboard, and you can paste it into your message with `Ctrl` + `V`.",
+      "",
+      "🔍 Check out the full tutorial for [Taking screenshots](<https://docs.mobiflight.com/guides/taking-screenshots/>)"
+    ]
+  },
+  {
+    "label": "MobiFlight Installation Path",
+    "description": "Finding the MobiFlight installation",
+    "value": "installpath",
+    "content": [
+      "👉 **MobiFlight installs to** 📂`%LocalAppData%\\MobiFlight\\MobiFlight Connector`",
+      "[MobiFlight Installation Path](<https://docs.mobiflight.com/guides/installation-path/>)"
+    ]
   }
 ]

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ function loadEvents() {`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`		`-function loadCommands() {`
	`40`	`+async function loadCommands() {`
`41`	`41`	`try {`
`42`	`42`	`const foldersPath = path.join(__dirname, "commands");`
`43`	`43`	`const commandFolders = fs.readdirSync(foldersPath);`
`@@ -55,7 +55,7 @@ function loadCommands() {`
`55`	`55`	`// Initialize the command if it has an initializer`
`56`	`56`	`if ("init" in command) {`
`57`	`57`	logger.debug(`Initializing ${filePath}`, { file: filePath });
`58`		`- command.init();`
	`58`	`+ await command.init();`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`// Set a new item in the Collection with the key as the command name and the value as the exported module`
`@@ -75,7 +75,9 @@ function loadCommands() {`
`75`	`75`	`}`
`76`	`76`
`77`	`77`	`if (process.env.ENABLE_COMMANDS === "true") {`
`78`		`- loadCommands();`
	`78`	`+ loadCommands().catch((err) => {`
	`79`	+ logger.error(`Failed to load commands: ${err.message}`, err);
	`80`	`+ });`
`79`	`81`	`} else {`
`80`	`82`	logger.info(`Commands disabled, skipping creating them.`);
`81`	`83`	`}`