Merge pull request #25 from tresabhi/1.12.2

docs/.vitepress/config.ts

@@ -1,4 +1,7 @@
-import { DefaultTheme, defineConfig } from 'vitepress';
+import { compareVersions } from 'compare-versions';
+import { readdirSync } from 'fs';
+import { parse } from 'path';
+import { defineConfig } from 'vitepress';
 import { getSidebar } from 'vitepress-plugin-auto-sidebar';
 
 export default defineConfig({
@@ -9,17 +12,27 @@ export default defineConfig({
   themeConfig: {
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' },
+      { text: 'Guide', link: '/guide/about' },
     ],
 
-    sidebar: getSidebar({
+    sidebar: [
-      collapsed: false,
+      ...getSidebar({
-      contentDirs: ['guide', 'legal', 'changelogs'],
+        collapsed: false,
-      contentRoot: '/docs/',
+        contentDirs: ['guide', 'legal'],
-    }) as DefaultTheme.Sidebar,
+        contentRoot: '/docs/',
+      }),
+
+      {
+        text: 'Changelogs',
+        items: readdirSync('./docs/changelogs')
+          .map((file) => parse(file).name)
+          .sort(compareVersions)
+          .map((name) => ({ text: name, link: `/changelogs/${name}.html` })),
+      },
+    ],
 
     socialLinks: [
-      { icon: 'github', link: 'https://github.com/vuejs/vitepress' },
+      { icon: 'github', link: 'https://github.com/tresabhi/blitzkrieg' },
     ],
   },
 });

docs/changelogs/1.12.2.md

@@ -0,0 +1,29 @@
+# Blitzkrieg 1.12.2
+
+A much needed room service is here!
+
+## Changes
+
+- Tier selection is now easier
+  - Tier options across all commands have been unified to a single style
+  - Tiers are now sorted from `10` to `1`
+  - Tiers now show up in the format `Tier {tier_number} - {tier_roman_numeral}` (example: `Tier 8 - VIII`)
+- Removed powered by footer as links are provided regardless
+- Changed invite instructions to instead use application directory
+
+## Fixes
+
+- Guide link on the website is now fixed
+- Versions now show up in the correct order in the navigation bar
+- Added Blitzkrieg's GitHub link instead of the default Vitepress
+- Changed examples to guide in the navigation bar
+- Clan name and icon now show up with multi-tank filters
+- Removed a random `console.log`
+
+## Technical Changes
+
+- Added `knip`
+  - Removed a lot of unused files and dependencies
+- Updated all dependencies to their latest
+- Code split `bot.ts`
+  - `client` and `octokit` now reside separately

docs/guide/invite.md

@@ -1,10 +1,3 @@
 # Inviting the Bot
 
-It's quite simple really. Just follow the steps below:
+Go to [application directory for Blitzkrieg](https://discord.com/application-directory/1097673957865443370) and click "Add to Server." Voila! You're ready to go.
-
-1. Join a Discord server that already has Blitzkrieg installed or [the official Discord Server](https://discord.gg/nDt7AjGJQH).
-2. Click on the bot's profile.
-3. Click the "Add to Server" button under the bot's name and ID.
-4. Select what server you want it in and see what permissions you seem fit for the bot.
-
-Voila! You're ready to go.

docs/index.md

@@ -15,7 +15,7 @@ hero:
       link: guide/install
     - theme: alt
       text: Guide
-      link: /guide
+      link: /guide/about
 
 features:
   - title: Clean and Efficient UI

package.json

@@ -19,37 +19,39 @@
     "publish:ratingsleaderboard": "vite-node --script scripts/buildRatingsLeaderboard --publish",
     "zip": "zip -r dist.zip dist",
     "lint": "npx tsc",
-    "format": "prettier --write \"**/*.@(json|js|jsx|css|md|ts|tsx|html|xml|yml|gltf)\""
+    "format": "prettier --write \"**/*.@(json|js|jsx|css|md|ts|tsx|html|xml|yml|gltf)\"",
+    "knip": "knip",
+    "update": "yarn upgrade --latest"
   },
   "license": "MIT",
   "dependencies": {
     "@octokit/rest": "^20.0.1",
-    "@radix-ui/colors": "^0.1.8",
+    "@radix-ui/colors": "^2.1.0",
     "@resvg/resvg-js": "^2.4.1",
     "bepaint": "^0.1.0-beta.3",
-    "discord.js": "^14.12.0",
+    "discord.js": "^14.13.0",
-    "esbuild": "^0.18.10",
+    "esbuild": "^0.19.2",
-    "escape-html": "^1.0.3",
     "express": "^4.18.2",
-    "false": "^0.0.4",
     "fuzzysort": "^2.0.4",
     "lodash": "^4.17.21",
     "markdown-escape": "^2.0.0",
     "react": "^18.2.0",
-    "satori": "^0.9.1",
+    "satori": "^0.10.3",
-    "vite-node": "^0.33.0",
+    "vite-node": "^0.34.2",
     "vitepress-plugin-auto-sidebar": "^1.1.0"
   },
   "devDependencies": {
-    "@total-typescript/ts-reset": "^0.4.2",
+    "@total-typescript/ts-reset": "^0.5.1",
     "@types/escape-html": "^1.0.2",
     "@types/express": "^4.17.17",
-    "@types/lodash": "^4.14.195",
+    "@types/lodash": "^4.14.197",
     "@types/markdown-escape": "^1.1.0",
-    "@types/node": "^20.2.1",
+    "@types/node": "^20.5.3",
-    "@types/react": "^18.2.7",
+    "@types/react": "^18.2.21",
-    "prettier": "^3.0.0",
+    "compare-versions": "^6.1.0",
+    "knip": "^2.19.9",
+    "prettier": "^3.0.2",
     "typescript": "^5.0.4",
-    "vitepress": "^1.0.0-beta.3"
+    "vitepress": "^1.0.0-rc.4"
   }
 }

src/bot.ts

@@ -1,19 +1,6 @@
-import { Octokit } from '@octokit/rest';
+import { client } from './core/discord/client';
-import { Client, GatewayIntentBits } from 'discord.js';
 import { secrets } from './core/node/secrets';
 import { registerErrorHandlers } from './events/error';
-import guildMemberAdd from './events/guildMemberAdd';
-import interactionCreate from './events/interactionCreate';
-import ready from './events/ready';
-
-export const client = new Client({
-  intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMembers],
-})
-  .on('ready', ready)
-  .on('guildMemberAdd', guildMemberAdd)
-  .on('interactionCreate', interactionCreate);
-
-export const octokit = new Octokit({ auth: secrets.GH_TOKEN });
 
 registerErrorHandlers();
 client.login(secrets.DISCORD_TOKEN);

src/commands/debug.ts

@@ -1,8 +1,8 @@
 import { SlashCommandBuilder } from 'discord.js';
 import packageJSON from '../../package.json' assert { type: 'json' };
-import { client } from '../bot';
 import { tankopedia } from '../core/blitz/tankopedia';
 import { tankAverages } from '../core/blitzstars/tankAverages';
+import { client } from '../core/discord/client';
 import embedInfo from '../core/discord/embedInfo';
 import markdownTable from '../core/discord/markdownTable';
 import getClientId from '../core/node/getClientId';

src/commands/fullStats.tsx

@@ -62,6 +62,8 @@ export const fullStatsCommand = new Promise<CommandRegistryRaw>(
           )
         )[player.id];
 
+        const tierOption = interaction.options.getString('tier');
+
         return [
           await fullStats(
             commandGroup,
@@ -74,7 +76,7 @@ export const fullStatsCommand = new Promise<CommandRegistryRaw>(
                   'tank-type':
                     interaction.options.getString('tank-type') ?? undefined,
                   nation: interaction.options.getString('nation') ?? undefined,
-                  tier: interaction.options.getInteger('tier') ?? undefined,
+                  tier: tierOption ? parseInt(tierOption) : undefined,
                   'tree-type': (interaction.options.getString('tree-type') ??
                     undefined) as TreeTypeString | undefined,
                 } satisfies Partial<MultiTankFilters>)

src/commands/inactive.tsx

@@ -1,7 +1,6 @@
 import { SlashCommandBuilder } from 'discord.js';
 import GenericStats from '../components/GenericStats';
 import NoData, { NoDataType } from '../components/NoData';
-import PoweredBy, { PoweredByType } from '../components/PoweredBy';
 import TitleBar from '../components/TitleBar';
 import Wrapper from '../components/Wrapper';
 import getBlitzClan from '../core/blitz/getBlitzClan';
@@ -74,8 +73,6 @@ export const inactiveCommand: CommandRegistry = {
 
         {!hasInactiveMembers && <NoData type={NoDataType.PlayersInPeriod} />}
         {hasInactiveMembers && <GenericStats stats={inactive} />}
-
-        <PoweredBy type={PoweredByType.Wargaming} />
       </Wrapper>
     );
   },

src/commands/ownedTanks.tsx

@@ -1,6 +1,5 @@
 import { SlashCommandBuilder } from 'discord.js';
 import NoData, { NoDataType } from '../components/NoData';
-import PoweredBy, { PoweredByType } from '../components/PoweredBy';
 import * as Tanks from '../components/Tanks';
 import TitleBar from '../components/TitleBar';
 import Wrapper from '../components/Wrapper';
@@ -15,6 +14,7 @@ import {
   tankopedia,
   tankopediaInfo,
 } from '../core/blitz/tankopedia';
+import addTierChoices from '../core/discord/addTierChoices';
 import addUsernameChoices from '../core/discord/addUsernameChoices';
 import autocompleteUsername from '../core/discord/autocompleteUsername';
 import resolvePlayerFromCommand from '../core/discord/resolvePlayerFromCommand';
@@ -52,24 +52,7 @@ export const ownedTanksCommand: CommandRegistry = {
   command: new SlashCommandBuilder()
     .setName('owned-tanks')
     .setDescription("Shows a player's owned tanks")
-    .addStringOption((option) =>
+    .addStringOption(addTierChoices)
-      option
-        .setName('tier')
-        .setDescription('The tier you want to see')
-        .setChoices(
-          { name: 'Tier I (1)', value: '1' },
-          { name: 'Tier II (2)', value: '2' },
-          { name: 'Tier III (3)', value: '3' },
-          { name: 'Tier IV (4)', value: '4' },
-          { name: 'Tier V (5)', value: '5' },
-          { name: 'Tier VI (6)', value: '6' },
-          { name: 'Tier VII (7)', value: '7' },
-          { name: 'Tier VIII (8)', value: '8' },
-          { name: 'Tier IX (9)', value: '9' },
-          { name: 'Tier X (10)', value: '10' },
-        )
-        .setRequired(true),
-    )
     .addStringOption(addUsernameChoices),
 
   async handler(interaction) {
@@ -170,8 +153,6 @@ export const ownedTanksCommand: CommandRegistry = {
               );
             }),
           ))}
-
-        <PoweredBy type={PoweredByType.Wargaming} />
       </Wrapper>
     );
   },

src/commands/stats.tsx

@@ -60,6 +60,8 @@ export const statsCommand = new Promise<CommandRegistryRaw>(async (resolve) => {
         )
       )[player.id];
 
+      const tierOption = interaction.options.getString('tier');
+
       return [
         await stats(
           commandGroup,
@@ -72,7 +74,7 @@ export const statsCommand = new Promise<CommandRegistryRaw>(async (resolve) => {
                 'tank-type':
                   interaction.options.getString('tank-type') ?? undefined,
                 nation: interaction.options.getString('nation') ?? undefined,
-                tier: interaction.options.getInteger('tier') ?? undefined,
+                tier: tierOption ? parseInt(tierOption) : undefined,
                 'tree-type': (interaction.options.getString('tree-type') ??
                   undefined) as TreeTypeString | undefined,
               } satisfies Partial<MultiTankFilters>)

src/components/PoweredBy.tsx

@@ -1,43 +0,0 @@
-import { ReactNode } from 'react';
-import { theme } from '../stitches.config';
-
-export enum PoweredByType {
-  BlitzStars,
-  Wargaming,
-}
-
-export interface PoweredByProps {
-  type: PoweredByType;
-  footer?: ReactNode;
-}
-
-const POWERED_BY_IMAGES: Record<PoweredByType, string> = {
-  [PoweredByType.BlitzStars]:
-    'https://www.blitzstars.com/assets/images/4b4cb591.TankyMcPewpew.png',
-  [PoweredByType.Wargaming]: 'https://i.imgur.com/jADGWm0.png',
-};
-
-const POWERED_BY_NAMES: Record<PoweredByType, string> = {
-  [PoweredByType.BlitzStars]: 'BlitzStars',
-  [PoweredByType.Wargaming]: 'Wargaming',
-};
-
-export default function PoweredBy({ type, footer }: PoweredByProps) {
-  return (
-    <div
-      style={{
-        display: 'flex',
-        justifyContent: footer === undefined ? 'space-around' : 'space-between',
-      }}
-    >
-      {footer !== undefined && <div style={{ display: 'flex' }}>{footer}</div>}
-
-      <div style={{ display: 'flex', gap: 4 }}>
-        <img src={POWERED_BY_IMAGES[type]} style={{ height: 16, width: 16 }} />
-        <span style={{ color: theme.colors.textLowContrast, fontSize: 16 }}>
-          Powered by {POWERED_BY_NAMES[type]}
-        </span>
-      </div>
-    </div>
-  );
-}

src/core/blitz/diffStats.ts

@@ -1,30 +0,0 @@
-import { AllStats } from '../../types/accountInfo';
-
-export default function diffStats(stats1: AllStats, stats2: AllStats) {
-  function diff(value: (allStats: AllStats) => number) {
-    return value(stats2) - value(stats1);
-  }
-  function max(value: (allStats: AllStats) => number) {
-    return Math.max(value(stats1), value(stats2));
-  }
-
-  return {
-    battles: diff((a) => a.battles),
-    wins: diff((a) => a.wins),
-    capture_points: diff((a) => a.capture_points),
-    damage_dealt: diff((a) => a.damage_dealt),
-    damage_received: diff((a) => a.damage_received),
-    dropped_capture_points: diff((a) => a.dropped_capture_points),
-    frags: diff((a) => a.frags),
-    frags8p: diff((a) => a.frags8p),
-    hits: diff((a) => a.hits),
-    losses: diff((a) => a.losses),
-    max_frags: max((a) => a.max_frags),
-    max_xp: max((a) => a.max_xp),
-    shots: diff((a) => a.shots),
-    spotted: diff((a) => a.spotted),
-    survived_battles: diff((a) => a.survived_battles),
-    win_and_survived: diff((a) => a.win_and_survived),
-    xp: diff((a) => a.xp),
-  } satisfies AllStats;
-}

src/core/blitz/numberToRomanNumeral.ts

@@ -0,0 +1,32 @@
+/**
+ * Thanks, August!
+ * https://stackoverflow.com/a/41358305/12294756
+ */
+const ROMAN = {
+  M: 1000,
+  CM: 900,
+  D: 500,
+  CD: 400,
+  C: 100,
+  XC: 90,
+  L: 50,
+  XL: 40,
+  X: 10,
+  IX: 9,
+  V: 5,
+  IV: 4,
+  I: 1,
+};
+const ROMAN_KEYS = Object.keys(ROMAN) as (keyof typeof ROMAN)[];
+
+export default function numberToRomanNumeral(value: number) {
+  let string = '';
+
+  ROMAN_KEYS.forEach((index) => {
+    const part = Math.floor(value / ROMAN[index]);
+    value -= part * ROMAN[index];
+    string += index.repeat(part);
+  });
+
+  return string;
+}

src/core/blitzstars/playerAverage.ts

@@ -1,12 +0,0 @@
-import sumStats from '../blitz/sumStats';
-import { emptyAllStats } from './getDiffedTankStats';
-import { tankAverages } from './tankAverages';
-
-console.log('Calculating player average...');
-export const playerAverage = Object.entries(await tankAverages).reduce(
-  (accumulator, [, tankAverage]) => {
-    return sumStats([accumulator, tankAverage.all]);
-  },
-  emptyAllStats,
-);
-console.log('Calculated player average');

src/core/database/getMidnightLeaderboard.ts

@@ -1,6 +1,6 @@
 import { BlitzkriegRatingsLeaderboard } from '../../../scripts/buildRatingsLeaderboard';
-import { octokit } from '../../bot';
 import { Region } from '../../constants/regions';
+import { octokit } from '../express/octokit';
 
 export const DATABASE_REPO = { owner: 'tresabhi', repo: 'blitzkrieg-db' };
 

src/core/discord/addStatTypeSubCommandGroups.ts

@@ -4,6 +4,7 @@ import { StatType } from '../../renderers/stats';
 import { tankopediaInfo } from '../blitz/tankopedia';
 import addPeriodSubCommands from './addPeriodSubCommands';
 import addTankChoices from './addTankChoices';
+import addTierChoices from './addTierChoices';
 import addUsernameChoices from './addUsernameChoices';
 
 export default async function addStatTypeSubCommandGroups(
@@ -61,13 +62,8 @@ export default async function addStatTypeSubCommandGroups(
               )
               .setRequired(false),
           )
-          .addIntegerOption((option) =>
+          .addStringOption((option) =>
-            option
+            addTierChoices(option).setRequired(false),
-              .setName('tier')
-              .setDescription('Tier')
-              .setMinValue(1)
-              .setMaxValue(10)
-              .setRequired(false),
           )
           .addStringOption((option) =>
             option

src/core/discord/addTierChoices.ts

@@ -0,0 +1,16 @@
+import { SlashCommandStringOption } from 'discord.js';
+import { range } from 'lodash';
+import numberToRomanNumeral from '../blitz/numberToRomanNumeral';
+
+export default function addTierChoices(option: SlashCommandStringOption) {
+  return option
+    .setName('tier')
+    .setDescription('The tier you want to see')
+    .setChoices(
+      ...range(10, 0).map((tier) => ({
+        name: `Tier ${tier} - ${numberToRomanNumeral(tier)}`,
+        value: `${tier}`,
+      })),
+    )
+    .setRequired(true);
+}

src/core/discord/client.ts

@@ -0,0 +1,11 @@
+import { Client, GatewayIntentBits } from 'discord.js';
+import guildMemberAdd from '../../events/guildMemberAdd';
+import interactionCreate from '../../events/interactionCreate';
+import ready from '../../events/ready';
+
+export const client = new Client({
+  intents: [GatewayIntentBits.Guilds, GatewayIntentBits.GuildMembers],
+})
+  .on('ready', ready)
+  .on('guildMemberAdd', guildMemberAdd)
+  .on('interactionCreate', interactionCreate);

src/core/discord/supportBlitzStars.ts

@@ -1,7 +0,0 @@
-import { ButtonBuilder, ButtonStyle } from 'discord.js';
-
-// TODO: ADD THIS AGAIN IMMEDIATELY
-export const supportBlitzStars = new ButtonBuilder()
-  .setLabel('Support BlitzStars')
-  .setURL('https://www.blitzstars.com/supporters')
-  .setStyle(ButtonStyle.Link);

src/core/express/octokit.ts

@@ -0,0 +1,4 @@
+import { Octokit } from '@octokit/rest';
+import { secrets } from '../node/secrets';
+
+export const octokit = new Octokit({ auth: secrets.GH_TOKEN });

src/events/error.ts

@@ -1,7 +1,7 @@
 import { EmbedBuilder, TextChannel } from 'discord.js';
 import discord from '../../discord.json' assert { type: 'json' };
-import { client } from '../bot';
 import { NEGATIVE_COLOR } from '../constants/colors';
+import { client } from '../core/discord/client';
 import isDev from '../core/node/isDev';
 
 const PROCESS_ERROR_EVENTS = ['uncaughtException'];

src/renderers/evolution.tsx

@@ -1,6 +1,5 @@
 import * as Graph from '../components/Graph';
 import NoData, { NoDataType } from '../components/NoData';
-import PoweredBy, { PoweredByType } from '../components/PoweredBy';
 import TitleBar from '../components/TitleBar';
 import Wrapper from '../components/Wrapper';
 import getWargamingResponse from '../core/blitz/getWargamingResponse';
@@ -118,8 +117,6 @@ export default async function evolution<Type extends StatType>(
       )}
 
       {plot.length === 0 && <NoData type={NoDataType.BattlesInPeriod} />}
-
-      <PoweredBy type={PoweredByType.BlitzStars} />
     </Wrapper>
   );
 }

src/renderers/fullStats.tsx

@@ -1,6 +1,5 @@
 import GenericAllStats from '../components/GenericAllStats';
 import NoData, { NoDataType } from '../components/NoData';
-import PoweredBy, { PoweredByType } from '../components/PoweredBy';
 import TierWeights, { TierWeightsRecord } from '../components/TierWeights';
 import TitleBar from '../components/TitleBar';
 import Wrapper from '../components/Wrapper';
@@ -35,7 +34,7 @@ export default async function fullStats<Type extends StatType>(
   let nameDiscriminator: string | undefined;
   let image: string | undefined;
 
-  if (type === 'player') {
+  if (type === 'player' || type === 'multi-tank') {
     const clan = (
       await getWargamingResponse<PlayerClanData>(
         `https://api.wotblitz.${server}/wotb/clans/accountinfo/?application_id=${secrets.WARGAMING_APPLICATION_ID}&account_id=${id}&extra=clan`,
@@ -49,7 +48,6 @@ export default async function fullStats<Type extends StatType>(
   } else if (type === 'tank') {
     nameDiscriminator = `(${await resolveTankName(filters as number)})`;
     image = (await tankopedia)[filters as number]?.images.normal;
-  } else {
   }
 
   const { diffed, order } = await getDiffedTankStats(server, id, start, end);
@@ -165,8 +163,6 @@ export default async function fullStats<Type extends StatType>(
           supplementaryStats={supplementaryStats}
         />
       )}
-
-      <PoweredBy type={PoweredByType.BlitzStars} />
     </Wrapper>
   );
 }

src/renderers/stats.tsx

@@ -1,6 +1,5 @@
 import AllStatsOverview from '../components/AllStatsOverview';
 import NoData, { NoDataType } from '../components/NoData';
-import PoweredBy, { PoweredByType } from '../components/PoweredBy';
 import { TreeTypeString } from '../components/Tanks';
 import TitleBar from '../components/TitleBar';
 import Wrapper from '../components/Wrapper';
@@ -45,7 +44,7 @@ export default async function stats<Type extends StatType>(
   let nameDiscriminator: string | undefined;
   let image: string | undefined;
 
-  if (type === 'player') {
+  if (type === 'player' || type === 'multi-tank') {
     const clan = (
       await getWargamingResponse<PlayerClanData>(
         `https://api.wotblitz.${server}/wotb/clans/accountinfo/?application_id=${secrets.WARGAMING_APPLICATION_ID}&account_id=${id}&extra=clan`,
@@ -168,8 +167,6 @@ export default async function stats<Type extends StatType>(
 
       {!stats?.battles && <NoData type={NoDataType.BattlesInPeriod} />}
       {stats?.battles > 0 && overview}
-
-      <PoweredBy type={PoweredByType.BlitzStars} footer={footer} />
     </Wrapper>
   );
 }

src/renderers/today.tsx

@@ -1,6 +1,5 @@
 import * as Breakdown from '../components/Breakdown';
 import NoData, { NoDataType } from '../components/NoData';
-import PoweredBy, { PoweredByType } from '../components/PoweredBy';
 import TitleBar from '../components/TitleBar';
 import Wrapper from '../components/Wrapper';
 import calculateWN8 from '../core/blitz/calculateWN8';
@@ -27,8 +26,6 @@ export default async function today(
   showTotal = true,
   naked?: boolean,
 ) {
-  console.log(maximized);
-
   const { diffed, order } = await getDiffedTankStats(
     server,
     id,
@@ -174,8 +171,6 @@ export default async function today(
 
       {rows.length === 0 && <NoData type={NoDataType.BattlesInPeriod} />}
       {rows.length > 0 && <Breakdown.Root>{rows}</Breakdown.Root>}
-
-      <PoweredBy type={PoweredByType.BlitzStars} />
     </Wrapper>
   );
 }