Merge branch 'beta' into more-catching-tests

.github/workflows/github-pages.yml

@@ -23,7 +23,9 @@ jobs:
     timeout-minutes: 10
     runs-on: ubuntu-latest
     env:
-      api-dir: ./
+      docs-dir: ./pokerogue_docs
+      # Only push docs when running on pushes to main/beta
+      DRY_RUN: ${{github.event_name != 'push' || (github.ref_name != 'beta' && github.ref_name != 'main')}}
 
     strategy:
       fail-fast: false
@@ -45,7 +47,7 @@ jobs:
         with:
           version: 10
 
-      - name: Setup Node 22.14.1
+      - name: Setup Node
         uses: actions/setup-node@v4
         with:
           node-version-file: "pokerogue_docs/.nvmrc"
@@ -58,26 +60,26 @@ jobs:
           ref: gh-pages
 
       - name: Install Node.js dependencies
-        working-directory: ${{env.api-dir}}
+        working-directory: ${{env.docs-dir}}
-        run: |
+        run: pnpm i
-          cd pokerogue_docs
-          pnpm i
 
       - name: Generate Typedoc docs
-        working-directory: ${{env.api-dir}}
+        working-directory: ${{env.docs-dir}}
-        run: |
+        env:
-          cd pokerogue_docs
+          REF_NAME: ${{github.ref_name}}
-          pnpm exec typedoc --out /tmp/docs --githubPages false --entryPoints ./src/
+          DRY_RUN: ${{env.DRY_RUN}}
+        run: pnpm typedoc
 
       - name: Commit & Push docs
-        if: github.event_name == 'push' && (github.ref_name == 'beta' || github.ref_name == 'main')
+        # env vars are stored as strings instead of booleans (hence why an explicit check is required)
+        if: ${{ env.DRY_RUN == 'false'}}
         run: |
           cd pokerogue_gh
           git config user.email "github-actions[bot]@users.noreply.github.com"
           git config user.name "github-actions[bot]"
           mkdir -p $GITHUB_REF_NAME
           rm -rf $GITHUB_REF_NAME/*
-          cp -r /tmp/docs/. $GITHUB_REF_NAME
+          cp -r /tmp/docs $GITHUB_REF_NAME
           git add $GITHUB_REF_NAME
-          git commit --allow-empty -m "[skip ci] Deploy docs"
+          git commit -m "[skip ci] Deploy docs"
-          git push
+          git push

README.md

@@ -1,5 +1,10 @@
 <picture><img src="./public/images/logo.png" width="300" alt="PokéRogue"></picture>
 
+![Discord Static Badge](https://img.shields.io/badge/Community_Discord-blurple?style=flat&logo=discord&logoSize=auto&labelColor=white&color=5865F2&link=https://discord.gg/pokerogue)
+[![Docs Coverage Static Badge](https://pagefaultgames.github.io/pokerogue/beta/coverage.svg)](https://pagefaultgames.github.io/pokerogue/beta)
+[![Testing Badge](https://github.com/pagefaultgames/pokerogue/actions/workflows/tests.yml/badge.svg)](https://github.com/pagefaultgames/pokerogue/actions/workflows/tests.yml)
+[![License: GNU AGPL v3](https://img.shields.io/badge/License-AGPL_v3-blue.svg)](https://www.gnu.org/licenses/agpl-3.0)
+
 PokéRogue is a browser based Pokémon fangame heavily inspired by the roguelite genre. Battle endlessly while gathering stacking items, exploring many different biomes, fighting trainers, bosses, and more!
 
 # Contributing
@@ -7,7 +12,7 @@ PokéRogue is a browser based Pokémon fangame heavily inspired by the roguelite
 See [CONTRIBUTING.md](./CONTRIBUTING.md), this includes instructions on how to set up the game locally.
 
 # 📝 Credits
->
+
 > If this project contains assets you have produced and you do not see your name, **please** reach out, either [here on GitHub](https://github.com/pagefaultgames/pokerogue/issues/new) or via [Discord](https://discord.gg/pokerogue).
 
 Thank you to all the wonderful people that have contributed to the PokéRogue project! You can find the credits [here](./CREDITS.md).

global.d.ts

@@ -18,3 +18,14 @@ declare global {
     call<T extends AnyFn>(this: T, thisArg: ThisParameterType<T>, ...argArray: Parameters<T>): ReturnType<T>;
   }
 }
+
+// Global augments for `typedoc` to prevent TS from erroring when editing the config JS file
+declare module "typedoc" {
+  export interface TypeDocOptionMap {
+    coverageLabel: string;
+    coverageColor: string;
+    coverageOutputPath: string;
+    coverageOutputType: "svg" | "json" | "all";
+    coverageSvgWidth: number;
+  }
+}

package.json

@@ -1,10 +1,11 @@
 {
   "name": "pokemon-rogue-battle",
   "private": true,
-  "version": "1.10.4",
+  "version": "1.10.6",
   "type": "module",
   "scripts": {
-    "start": "vite",
+    "start:prod": "vite --mode production",
+    "start:beta": "vite --mode beta",
     "start:dev": "vite --mode development",
     "build": "vite build",
     "build:beta": "vite build --mode beta",
@@ -18,7 +19,7 @@
     "typecheck": "tsc --noEmit",
     "biome": "biome check --write --changed --no-errors-on-unmatched --diagnostic-level=error",
     "biome-ci": "biome ci --diagnostic-level=error --reporter=github --no-errors-on-unmatched",
-    "docs": "typedoc",
+    "typedoc": "typedoc",
     "depcruise": "depcruise src test",
     "postinstall": "lefthook install; git submodule update --init --recursive",
     "update-version:patch": "pnpm version patch --force --no-git-tag-version",
@@ -41,6 +42,9 @@
     "msw": "^2.10.4",
     "phaser3spectorjs": "^0.0.8",
     "typedoc": "^0.28.8",
+    "typedoc-github-theme": "^0.3.1",
+    "typedoc-plugin-coverage": "^4.0.1",
+    "typedoc-plugin-mdn-links": "^5.0.9",
     "typescript": "^5.8.3",
     "vite": "^7.0.6",
     "vite-tsconfig-paths": "^5.1.4",

pnpm-lock.yaml

@@ -87,6 +87,15 @@ importers:
       typedoc:
         specifier: ^0.28.8
         version: 0.28.8(typescript@5.8.3)
+      typedoc-github-theme:
+        specifier: ^0.3.1
+        version: 0.3.1(typedoc@0.28.8(typescript@5.8.3))
+      typedoc-plugin-coverage:
+        specifier: ^4.0.1
+        version: 4.0.1(typedoc@0.28.8(typescript@5.8.3))
+      typedoc-plugin-mdn-links:
+        specifier: ^5.0.9
+        version: 5.0.9(typedoc@0.28.8(typescript@5.8.3))
       typescript:
         specifier: ^5.8.3
         version: 5.8.3
@@ -1789,6 +1798,23 @@ packages:
     resolution: {integrity: sha512-TeTSQ6H5YHvpqVwBRcnLDCBnDOHWYu7IvGbHT6N8AOymcr9PJGjc1GTtiWZTYg0NCgYwvnYWEkVChQAr9bjfwA==}
     engines: {node: '>=16'}
 
+  typedoc-github-theme@0.3.1:
+    resolution: {integrity: sha512-j6PmkAGmf/MGCzYjQcUH6jS9djPsNl/IoTXooxC+MoeMkBhbmPyKJlpR6Lw12BLoe2OYpYA2J1KMktUJXp/8Sw==}
+    engines: {node: '>=18.0.0'}
+    peerDependencies:
+      typedoc: ~0.28.0
+
+  typedoc-plugin-coverage@4.0.1:
+    resolution: {integrity: sha512-P1QBR5GJSfW3fDrpz4Vkd8z8lzWaBYjaHebRLk0u2Uga0oSFlPaqrCyiHzItBXxZX28aMlNlZwrUnsLgUgqA7g==}
+    engines: {node: '>= 18'}
+    peerDependencies:
+      typedoc: 0.28.x
+
+  typedoc-plugin-mdn-links@5.0.9:
+    resolution: {integrity: sha512-kXssRKBhUd0JeHzFmxWVsGWVFR9WXafe70Y8Ed+MYH2Nu2647cqfGQN1OBKgvXpmAT8MTpACmUIQ7GnQnh1/iw==}
+    peerDependencies:
+      typedoc: 0.27.x || 0.28.x
+
   typedoc@0.28.8:
     resolution: {integrity: sha512-16GfLopc8icHfdvqZDqdGBoS2AieIRP2rpf9mU+MgN+gGLyEQvAO0QgOa6NJ5QNmQi0LFrDY9in4F2fUNKgJKA==}
     engines: {node: '>= 18', pnpm: '>= 10'}
@@ -3634,6 +3660,18 @@ snapshots:
 
   type-fest@4.41.0: {}
 
+  typedoc-github-theme@0.3.1(typedoc@0.28.8(typescript@5.8.3)):
+    dependencies:
+      typedoc: 0.28.8(typescript@5.8.3)
+
+  typedoc-plugin-coverage@4.0.1(typedoc@0.28.8(typescript@5.8.3)):
+    dependencies:
+      typedoc: 0.28.8(typescript@5.8.3)
+
+  typedoc-plugin-mdn-links@5.0.9(typedoc@0.28.8(typescript@5.8.3)):
+    dependencies:
+      typedoc: 0.28.8(typescript@5.8.3)
+
   typedoc@0.28.8(typescript@5.8.3):
     dependencies:
       '@gerrit0/mini-shiki': 3.8.1