refactor: lint and styling overhaul

.editorconfig

@@ -1,8 +1,19 @@
+root = true
+
 [*]
 charset = utf-8
 indent_size = 4
 indent_style = space
 insert_final_newline = true
-max_line_length = 120
 tab_width = 4
-trim_trailing_whitespace = true
+
+[*.{js,jsx,ts,tsx}]
+indent_size = 2
+insert_final_newline = true
+tab_width = 2
+
+# YAML is usually 2 spaces
+# Markdown will cause weird formating with 4 spaces
+[*.{md,yml,yaml}]
+indent_size = 2
+tab_width = 2

.github/CHANGELOG.md

@@ -1,24 +1,24 @@
 ## Changelog
 
-Update <small>_ October 2024</small>
+Update <small>\_ October 2024</small>
 
 - feat: Prefix Command Management (28/10/2024)
 - fix: role assignment typo for server announcements (22/10/2024)
 
-Update <small>_ August 2024</small>
+Update <small>\_ August 2024</small>
 
 - feat: add runway information to simbriefdata (08/08/2024)
 - chore: add vscode editor settings (08/08/2024)
 - fix: temporarily pin typescript version to v5.4.x (see https://github.com/flybywiresim/discord-bot-utils/issues/78) (07/10/2024)
 
-Update <small>_ July 2024</small>
+Update <small>\_ July 2024</small>
 
 - fix: resolve security vulnerabilities in 3rd-party packages (27/07/2024)
 - fix: corrected typo in the embed for simbrief-data support-request (27/07/2024)
 - docs: updated the Ground Rules on the Contributing guide page (27/07/2024)
 - feat: add optional description to `/locate` panels. (27/07/2024)
 
-Update <small>_ May 2024</small>
+Update <small>\_ May 2024</small>
 
 - fix: keep footer on embed expire (29/05/2024)
 - feat: /clear-messages command (29/05/2024)
@@ -34,20 +34,20 @@ Update <small>_ May 2024</small>
 - fix: lint workflow failing silently (18/05/2024)
 - chore: fix eol issues on Windows (17/05/2024)
 
-Update <small>_ April 2024</small>
+Update <small>\_ April 2024</small>
 
 - fix: clarify errors in timeout command (30/04/2024)
 - fix: adds mod alerts to the config requirements (30/04/2024)
 
-Update <small>_ March 2024</small>
+Update <small>\_ March 2024</small>
 
 - fix: birthday handler user caching issue (23/03/2024)
 - feat: adds github issue command (18/03/2024)
 - fix: content change in welcome command (18/03/2024)
 - fix: multiple plus symbols in zulu command (18/03/2024)
 - feat: add infractions counts to buttons in list infractions command (18/03/2024)
 
-Update <small>_ February 2024</small>
+Update <small>\_ February 2024</small>
 
 - fix: report message logging bug (18/02/2024)
 - feat: command to list users in a role (18/02/2024)
@@ -58,7 +58,7 @@ Update <small>_ February 2024</small>
 - fix: message edit and delete crash (01/02/2024)
 - feat: add heartbeat mechanism for monitoring (01/02/2024)
 
-Update <small>_ January 2024</small>
+Update <small>\_ January 2024</small>
 
 - fix: defer interaction for cache update (28/01/2024)
 - fix: defer interaction on birthday list command (28/01/2024)
@@ -68,7 +68,7 @@ Update <small>_ January 2024</small>
 - fix: ScamLog - Ignore messages entirely unless it has everyone (28/01/2024)
 - fix: command names (28/01/2024)
 - fix: ignore Dyno bot (27/01/2024)
-- fix: use - instead of _ in command names (27/01/2024)
+- fix: use - instead of \_ in command names (27/01/2024)
 - feat: auto-generation of the command table (24/01/2024)
 - feat: migrate reportedIssues command (22/01/2024)
 - feat: docSearch command (22/01/2024)

.github/CONTRIBUTING.md

@@ -183,7 +183,7 @@ Some commands may require additional tokens. If you would like to test them out
 
 ## Adding a New Command
 
->Please note, this will only show the basics of adding a command.
+> Please note, this will only show the basics of adding a command.
 
 1. Create a new file in the relevant folder within `src/commands/` and name it appropriately. `yourcommand.ts`.
 2. Create your command.
@@ -224,42 +224,49 @@ import { ApplicationCommandOptionType, ApplicationCommandType } from 'discord.js
 import { slashCommand, slashCommandStructure, AutocompleteCallback, makeEmbed } from '../../lib';
 
 const data = slashCommandStructure({
-    name: 'ping',
-    description: 'Ping the bot for a response.',
-    type: ApplicationCommandType.ChatInput,
-    default_member_permissions: constantsConfig.commandPermission.MANAGE_SERVER, //Optional command permission - always use MANAGE_SERVER and add a comment to specify overrides needed (roles, channels etc.)
-    dm_permission: false, // Optional, this sets if commands can be run in DMs (global commands only)
-    options: [{ // Optional, this is where you can add options to your command
-        name: 'message',
-        description: 'Provide some text to send back.',
-        type: ApplicationCommandOptionType.String,
-        max_length: 100,
-        required: false,
-        autocomplete: true, // Optional - This is only required if you plan on using autocomplete for your command.
-    }],
+  name: 'ping',
+  description: 'Ping the bot for a response.',
+  type: ApplicationCommandType.ChatInput,
+  default_member_permissions: constantsConfig.commandPermission.MANAGE_SERVER, //Optional command permission - always use MANAGE_SERVER and add a comment to specify overrides needed (roles, channels etc.)
+  dm_permission: false, // Optional, this sets if commands can be run in DMs (global commands only)
+  options: [
+    {
+      // Optional, this is where you can add options to your command
+      name: 'message',
+      description: 'Provide some text to send back.',
+      type: ApplicationCommandOptionType.String,
+      max_length: 100,
+      required: false,
+      autocomplete: true, // Optional - This is only required if you plan on using autocomplete for your command.
+    },
+  ],
 });
 
 // Optional - This is only required if you plan on using autocomplete for your command.
 const autocompleteCallback: AutocompleteCallback = ({ interaction }) => {
-    // Autocomplete logic goes here
-    const choices = [
-        {
-            name: 'Display Name',
-            value: 'Value that is actually sent to your bot.'
-        },
-    ];
-
-    // If you can't autocomplete anything respond with an empty array.
-    return interaction.respond(choices);
+  // Autocomplete logic goes here
+  const choices = [
+    {
+      name: 'Display Name',
+      value: 'Value that is actually sent to your bot.',
+    },
+  ];
+
+  // If you can't autocomplete anything respond with an empty array.
+  return interaction.respond(choices);
 };
 
-export default slashCommand(data, async ({ interaction }) => {
+export default slashCommand(
+  data,
+  async ({ interaction }) => {
     const msg = interaction.options.getString('message') ?? 'Pong 🏓';
 
     const pongEmbed = makeEmbed({ description: msg });
 
     return interaction.reply({ embeds: [pongEmbed] });
-}, autocompleteCallback); // Optional - This is only required if you plan on using autocomplete for your command.
+  },
+  autocompleteCallback,
+); // Optional - This is only required if you plan on using autocomplete for your command.
 ```
 
 ## Command Permissions

.github/ISSUE_TEMPLATE/bug_report_beta.yaml

@@ -4,7 +4,7 @@ labels: [Bug]
 body:
   - type: markdown
     attributes:
-      value: "# FlyByWire Discord bot Bug Report Form"
+      value: '# FlyByWire Discord bot Bug Report Form'
   - type: dropdown
     id: type
     attributes:

.github/ISSUE_TEMPLATE/feature_request_beta.yaml

@@ -4,7 +4,7 @@ labels: [Request]
 body:
   - type: markdown
     attributes:
-      value: "# FBW Discord Bot Feature Request Form"
+      value: '# FBW Discord Bot Feature Request Form'
   - type: dropdown
     id: type
     attributes:

.github/dependabot.yml

@@ -1,15 +1,15 @@
 version: 2
 
 updates:
-    - package-ecosystem: npm
-      directory: /
-      schedule:
-          interval: monthly
-      commit-message:
-          prefix: "chore"
-          include: scope
-      ignore:
-          - dependency-name: "*"
-            update-types: ["version-update:semver-minor", "version-update:semver-patch"]
-      open-pull-requests-limit: 10
-      target-branch: staging
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: monthly
+    commit-message:
+      prefix: 'chore'
+      include: scope
+    ignore:
+      - dependency-name: '*'
+        update-types: ['version-update:semver-minor', 'version-update:semver-patch']
+    open-pull-requests-limit: 10
+    target-branch: staging

.github/workflows/cdn-upload-production.yaml

@@ -1,25 +1,25 @@
 name: CDN Upload - Production
 
 on:
-    workflow_dispatch:
-    push:
-        branches:
-            - production
-        paths:
-            - 'assets/images**'
+  workflow_dispatch:
+  push:
+    branches:
+      - production
+    paths:
+      - 'assets/images**'
 
 jobs:
-    cdn_upload:
-        if: github.repository_owner == 'flybywiresim' # Prevent running this on forks
-        runs-on: ubuntu-latest
-        steps:
-            - name: checkout
-              uses: actions/checkout@v3
-              with:
-                  fetch-depth: 0
-            - name: Upload to CloudFlare CDN
-              env:
-                  CLOUDFLARE_CDN_URL: ${{ secrets.CLOUDFLARE_CDN_URL_PRODUCTION }}
-                  CLOUDFLARE_ACCESS_KEY: ${{ secrets.CLOUDFLARE_ACCESS_KEY_PRODUCTION }}
-              run: |
-                  ./.github/workflow_scripts/cf-cdn.sh
+  cdn_upload:
+    if: github.repository_owner == 'flybywiresim' # Prevent running this on forks
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Upload to CloudFlare CDN
+        env:
+          CLOUDFLARE_CDN_URL: ${{ secrets.CLOUDFLARE_CDN_URL_PRODUCTION }}
+          CLOUDFLARE_ACCESS_KEY: ${{ secrets.CLOUDFLARE_ACCESS_KEY_PRODUCTION }}
+        run: |
+          ./.github/workflow_scripts/cf-cdn.sh

.github/workflows/cdn-upload-staging.yaml

@@ -1,25 +1,25 @@
 name: CDN Upload - Staging
 
 on:
-    workflow_dispatch:
-    push:
-        branches:
-            - staging
-        paths:
-            - 'assets/images**'
+  workflow_dispatch:
+  push:
+    branches:
+      - staging
+    paths:
+      - 'assets/images**'
 
 jobs:
-    cdn_upload:
-        if: github.repository_owner == 'flybywiresim' # Prevent running this on forks
-        runs-on: ubuntu-latest
-        steps:
-            - name: checkout
-              uses: actions/checkout@v3
-              with:
-                  fetch-depth: 0
-            - name: Upload to CloudFlare CDN
-              env:
-                  CLOUDFLARE_CDN_URL: ${{ secrets.CLOUDFLARE_CDN_URL_STAGING }}
-                  CLOUDFLARE_ACCESS_KEY: ${{ secrets.CLOUDFLARE_ACCESS_KEY_STAGING }}
-              run: |
-                  ./.github/workflow_scripts/cf-cdn.sh
+  cdn_upload:
+    if: github.repository_owner == 'flybywiresim' # Prevent running this on forks
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Upload to CloudFlare CDN
+        env:
+          CLOUDFLARE_CDN_URL: ${{ secrets.CLOUDFLARE_CDN_URL_STAGING }}
+          CLOUDFLARE_ACCESS_KEY: ${{ secrets.CLOUDFLARE_ACCESS_KEY_STAGING }}
+        run: |
+          ./.github/workflow_scripts/cf-cdn.sh