feat!: Minor Update 1.11.7 to Main

.dependency-cruiser.cjs

@@ -10,7 +10,7 @@ module.exports = {
         + "and thus should not contain anything with a bearing on runtime code.",
       from: {},
       to: {
-        path: "(^|/)src/@types",
+        path: ["(^|/)src/@types", "(^|/)test/@types"],
         dependencyTypesNot: ["type-only"],
       },
     },
@@ -19,8 +19,8 @@ module.exports = {
       severity: "error",
       comment: "Files in 'enums/' and '@types/' must only use type imports.",
       from: {
-        path: ["(^|/)src/@types", "(^|/)src/enums"],
-        pathNot: ["(^|/)src/@types/phaser[.]d[.]ts"],
+        path: ["(^|/)src/@types", "(^|/)src/enums", "(^|/)test/@types"],
+        pathNot: ["(^|/)src/@types/phaser[.]d[.]ts", "(^|/)test/@types/vitest[.]d[.]ts"],
       },
       to: {
         dependencyTypesNot: ["type-only"],
@@ -172,7 +172,12 @@ module.exports = {
         + "from.pathNot re of the not-to-dev-dep rule in the dependency-cruiser configuration",
       from: {
         path: "^(src)",
-        pathNot: ["[.](?:spec|test|setup|script)[.](?:js|mjs|cjs|jsx|ts|mts|cts|tsx)$", "./test"],
+        pathNot: [
+          "[.](?:spec|test|setup|script)[.](?:js|mjs|cjs|jsx|ts|mts|cts|tsx)$",
+          "./test",
+          "(^|/)src/plugins/vite/.+[.]ts",
+          "(^|/)src/vite[.]env[.]d[.]ts",
+        ],
       },
       to: {
         dependencyTypes: ["npm-dev"],
@@ -210,7 +215,7 @@ module.exports = {
     },
   ],
   options: {
-    exclude: ["src/plugins/vite/*", "src/vite.env.d.ts"],
+    exclude: [],
     /* Which modules not to follow further when encountered */
     doNotFollow: {
       /* path: an array of regular expressions in strings to match against */

.github/pull_request_template.md

@@ -1,57 +1,73 @@
-<!-- (Once you have read these comments, you are free to remove them) -->
-<!-- Feel free to look at other PRs for examples -->
 <!--
-Make sure the title includes categorization (choose the one that best fits):
--  [Bug]: If the PR is primarily a bug fix
--  [Move]: If a move has new or changed functionality
--  [Ability]: If an ability has new or changed functionality
--  [Item]: For new or modified items
--  [Mystery]: For new or modified Mystery Encounters
--  [Test]: If the PR is primarily adding or modifying tests
--  [UI/UX]: If the PR is changing UI/UX elements
--  [Audio]: If the PR is adding or changing music/sfx (may come with an associated assets PR)
--  [Sprite]: If the PR is adding or changing sprites (may come with an associated assets PR)
--  [Balance]: If the PR is related to game balance
--  [Challenge]: If the PR is adding or modifying challenges
--  [Refactor]: If the PR is primarily rewriting existing code
--  [Dev]: If the PR is primarily changing something pertaining to development (lefthook hooks, linter rules, etc.)
--  [i18n]: If the PR is primarily adding/changing locale keys or key usage (may come with an associated locales PR)
--  [Docs]: If the PR is adding or modifying documentation (such as tsdocs/code comments)
--  [GitHub]: For changes to GitHub workflows/templates/etc
--  [Misc]: If no other category fits the PR
+Thank you for contributing to PokéRogue!
+Open-source contributions like yours help keep this project going.
+
+Note that these comment blocks are purely informative and can be removed once you're done reading them.
 -->
 
 <!--
-Make sure that this PR is not overlapping with someone else's work
-Please try to keep the PR self-contained (and small!)
+Make sure your title matches the https://www.conventionalcommits.org/en/v1.0.0/ format.
+Try to keep the title under 72 characters, as GitHub cuts off commit titles longer than this length.
+
+See https://github.com/pagefaultgames/pokerogue/blob/beta/CONTRIBUTING.md#-submitting-a-pull-request
+for more information on the allowed scopes and prefixes.
+
+Example:
+fix(move): Future Sight no longer crashes
+^   ^      ^
+|   |      |__ Subject
+|   |_________ Scope (optional)
+|_____________ Prefix
 -->
 
 ## What are the changes the user will see?
-<!-- Summarize what are the changes from a user perspective on the application -->
-
-## Why am I making these changes?
 <!--
-Explain why you decided to introduce these changes
-Does it come from an issue or another PR? Please link it
-Explain why you believe this can enhance user experience
+Summarize the changes from a user perspective on the application.
+Try to keep this section (relatively) brief as it is used to generate changelogs.
+If you need to provide additional details, you can do so below the cutoff.
+
+PRs with no user-facing changes should leave this blank or write "N/A" to be omitted from auto-generated changelogs.
 -->
+
+<!-- ## Changelog cutoff (DO NOT REMOVE/EDIT) -->
+
+## Why am I making these changes?
 <!--
-If there are existing GitHub issues related to the PR that would be fixed,
-you can add "Fixes #[issue number]" (ie: "Fixes #1234") to link an issue to your PR
-so that it will automatically be closed when the PR is merged.
+Explain why you decided to introduce these changes.
+Does it come from another issue, PR or other prior discussion? Link to them if possible.
+How can this can enhance user experience or otherwise improve the codebase?
+
+Try to keep this explanation as objective as possible — avoid referring to personal feelings or making derogatory comments about existing code.
+
+If this PR resolves an existing GitHub issue,
+you can add "Fixes #[issue number]" (e.g.: "Fixes #1234") to link the issue.
+(See https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue for more information.)
 -->
 
 ## What are the changes from a developer perspective?
 <!--
-Explicitly state what are the changes introduced by the PR
-You can make use of a comparison between what was the state before and after your PR changes
-Ex: What files have been changed? What classes/functions/variables/etc have been added or changed?
+Describe the changes this PR introduces to the codebase.
+You can make use of a comparison between the state of the code before and after your changes.
+Ex: What files have been changed? What classes/functions/variables/etc. have been added or changed?
+
+Include enough detail to convey the scope of the changes being made and the rationale behind their implementation.
+Feel free to include small code snippets if you think they will help illustrate your points.
 -->
 
 ## Screenshots/Videos
 <!--
-If your changes are changing anything on the user experience, please provide visual proofs of it
-Please take screenshots/videos before and after your changes, to show what is brought by this PR
+If you are changing anything visual (UI/UX, locales changes, etc.), please include screenshot(s) and/or video(s) showing the changes within collapsible blocks, like below:
+
+<details><summary>Before</summary>
+
+[before screenshot here]
+
+</details>
+<details><summary>After</summary>
+
+[after screenshot here]
+
+</details>
 -->
 
 ## How to test the changes?
@@ -63,21 +79,33 @@ Do the reviewers need to do something special in order to test your changes?
 -->
 
 ## Checklist
-- [ ] **I'm using `beta` as my base branch**
-- [ ] There is no overlap with another PR?
-- [ ] The PR is self-contained and cannot be split into smaller PRs?
-- [ ] Have I provided a clear explanation of the changes?
-- [ ] Have I tested the changes manually?
-- [ ] Are all unit tests still passing? (`pnpm test:silent`)
-  - [ ] Have I created new automated tests (`pnpm test:create`) or updated existing tests related to the PR's changes?
-- [ ] Have I provided screenshots/videos of the changes (if applicable)?
-  - [ ] Have I made sure that any UI change works for both UI themes (default and legacy)?
+<!--
+Please ensure the following requirements are all met before creating your PR.
+If this is not the case, consider marking the PR as a draft (https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request) until all bullets have been resolved.
+
+If an item or category isn't valid for the particular changes being made (for example, you didn't make any locales changes)
+you can strike it out with the `~` character to mark them as not applicable.
+-->
+
+- The PR content is correctly formatted:
+  - [ ] **I'm using `beta` as my base branch**
+  - [ ] **The current branch is not named `beta`, `main` or the name of another long-lived feature branch**
+  - [ ] I have provided a clear explanation of the changes within the PR description
+  - [ ] The PR title matches the Conventional Commits format (as described in [CONTRIBUTING.md](https://github.com/pagefaultgames/pokerogue/blob/beta/CONTRIBUTING.md#pr-title-format))
+- [ ] The PR is self-contained and cannot be split into smaller PRs
+- [ ] There is no overlap with another open PR
+- The PR has been confirmed to work correctly:
+  - [ ] I have tested the changes manually
+  - [ ] The full automated test suite still passes (use `pnpm test:silent` to test locally)
+  - [ ] I have created new automated tests (`pnpm test:create`) or updated existing tests related to the PR's changes if necessary
+- [ ] I have provided screenshots/videos of the changes (if applicable)
+  - [ ] I have made sure that any UI changes work for both the default and legacy UI themes (if applicable)
 
 Are there any localization additions or changes? If so:
-- [ ] Has a locales PR been created on the [locales](https://github.com/pagefaultgames/pokerogue-locales) repo?
-  - [ ] If so, please leave a link to it here: 
-- [ ] Has the translation team been contacted for proofreading/translation?
+- [ ] I have created an associated PR on the [locales](https://github.com/pagefaultgames/pokerogue-locales) repository
+  - If so, include a link to the PR here: _____
+- [ ] I have contacted the Translation Team on Discord for proofreading/translation
 
-Does this require any changes to the assets folder? If so:
-  - [ ] Has a PR been created on the [assets](https://github.com/pagefaultgames/pokerogue-assets) repo?
-    - [ ] If so, please leave a link to it here: 
+Does this require any additions or changes to in-game assets? If so:
+- [ ] I have created an associated PR on the [assets](https://github.com/pagefaultgames/pokerogue-assets) repository
+  - If so, include a link to the PR here: _____

.github/scripts/pr-title.mts

@@ -0,0 +1,132 @@
+/*
+ * SPDX-FileCopyrightText: 2024-2026 Pagefault Games
+ * SPDX-FileContributor: NightKev <https://github.com/DayKev>
+ * SPDX-FileContributor: OrangeRed <https://github.com/OrangeRed>
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only
+ */
+
+// biome-ignore-all lint/performance/noNamespaceImport: This is the intended import method for these modules
+import * as core from "@actions/core";
+import * as github from "@actions/github";
+
+const PREFIXES = [
+  "balance", // Primarily a balance change
+  "chore", // Misc project upkeep (e.g. updating submodules, updating dependencies, reverting a bad commit) not covered by other prefixes
+  "dev", // Improving the developer experience (such as by modifying lint rules or creating cli scripts)
+  "docs", // Primarily adding/updating documentation
+  "feat", // Adding a new feature (e.g. adding a new implementation of a move) or redesigning an existing feature
+  "fix", // Fixing a bug
+  "github", // Updating the CI pipeline or otherwise modifying something in the `./github/**` directory
+  "i18n", // Adding/modifying translation keys, etc
+  "misc", // A change that doesn't fit any other prefix
+  "perf", // A refactor aimed at improving performance
+  "refactor", // A change that doesn't impact functionality or fix any bugs (except incidentally)
+  "revert", // Reverting a bad commit
+  "test", // Primarily adding/updating tests or modifying the test framework
+] as const;
+
+type Prefixes = (typeof PREFIXES)[number];
+
+const ALL_SCOPES = [
+  "ability",
+  "ai",
+  "audio",
+  "battle", // Relating to the general battle engine
+  "biomes",
+  "challenge",
+  "encounter", // Mystery Encounters
+  "event", // e.g. adding a Christmas event to the game
+  "graphics", // Anything related to art/graphics (adding new sprites, fixing a sprite that isn't displaying properly, etc)
+  "item",
+  "move",
+  "ui", // UI/UX
+] as const;
+
+type AllScopes = (typeof ALL_SCOPES)[number];
+
+const PREFIX_SCOPE_MAP = {
+  balance: ["ability", "ai", "biomes", "challenge", "encounter", "event", "item", "move"],
+  chore: [],
+  dev: [],
+  docs: ALL_SCOPES,
+  feat: ALL_SCOPES,
+  fix: ALL_SCOPES,
+  github: [],
+  i18n: [],
+  misc: [],
+  perf: [],
+  refactor: ALL_SCOPES,
+  revert: [],
+  test: ALL_SCOPES,
+} as const satisfies Record<Prefixes, readonly AllScopes[]>;
+
+async function run(): Promise<void> {
+  try {
+    const authToken = core.getInput("github_token", { required: true });
+
+    const { eventName } = github.context;
+    if (eventName !== "pull_request") {
+      core.setFailed(`Invalid event: ${eventName}`);
+      return;
+    }
+
+    const client = github.getOctokit(authToken);
+    // The pull request info on the context isn't up to date.
+    // When the user updates the title and re-runs the workflow, it would be outdated.
+    // Therefore fetch the pull request via the REST API to ensure we use the current title.
+    const { data: pullRequest } = await client.rest.pulls.get({
+      owner: github.context.payload.pull_request!.base.user.login,
+      repo: github.context.payload.pull_request!.base.repo.name,
+      pull_number: github.context.payload.pull_request!.number,
+    });
+
+    const { title } = pullRequest;
+    core.info(
+      "Info on PR title formatting: https://github.com/pagefaultgames/pokerogue/blob/beta/CONTRIBUTING.md#-submitting-a-pull-request",
+    );
+    core.info(`Pull Request title: "${title}"`);
+
+    // if (title.length > 72) {
+    //   core.setFailed(`Max title length of 72 exceeded! Current length: ${title.length}`);
+    //   return;
+    // }
+
+    // Note: `!` allowed before `:` for changes including a save migrator and/or version increase
+    const info = `
+Terminology: fix(move): Future Sight no longer crashes
+             ^   ^      ^
+             |   |      |__ Subject
+             |   |_________ Scope (optional)
+             |_____________ Prefix
+`;
+
+    core.info(info.trim());
+
+    // Example usage of regex: https://regex101.com/r/FeN8jG/8
+    const regex = /^([a-z0-9]+)!?(\([a-z]+\))?: .+/;
+    if (!regex.test(title)) {
+      core.setFailed(`Pull Request title "${title}" failed to match - "Prefix(Scope): Subject"`);
+      return;
+    }
+
+    const regexResult = regex.exec(title);
+    const prefix = regexResult[1];
+    const scope = regexResult[2]?.replace(/[()]/g, "");
+
+    if (!PREFIXES.some(p => p === prefix)) {
+      core.setFailed(`Pull Request title "${title}" did not match any of the prefixes: [${PREFIXES}]`);
+      return;
+    }
+
+    // biome-ignore lint/style/useExplicitLengthCheck: doubles as a nullish check for `scope`
+    if (scope?.length && !PREFIX_SCOPE_MAP[prefix].includes(scope)) {
+      core.setFailed(`Pull Request title "${title}" has an invalid prefix (${prefix}) + scope (${scope}) combination!`);
+      return;
+    }
+  } catch (error) {
+    core.setFailed(error.message);
+  }
+}
+
+run();

.github/test-filters.yml

@@ -12,9 +12,10 @@ all:
   - ".github/workflows/test*.yml"
   - ".github/test-filters.yml"
   # top-level files
-  - "package*.json"
+  - "package.json"
+  - "pnpm-lock.yaml"
   - ".nvrmc" # Updates to node version can break tests
   - "vite*" # vite.config.ts, vite.vitest.config.ts, vitest.workspace.ts
-  - "tsconfig*.json" # tsconfig.json tweaking can impact compilation
+  - "tsconfig.json" # tsconfig.json tweaking can impact compilation
   - "global.d.ts"
-  - ".env*"
+  - ".env*"

.github/workflows/create-changelog.yml

@@ -0,0 +1,41 @@
+name: Create Changelog
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  Create-changelog:
+    if: github.repository == 'pagefaultgames/pokerogue'
+    name: Generate Changelog
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          sparse-checkout: |
+            .nvmrc
+            pnpm-lock.yaml
+            scripts
+          sparse-checkout-cone-mode: false
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version-file: ".nvmrc"
+          cache: "pnpm"
+
+      - name: Install Node.js dependencies
+        run: pnpm add chalk octokit
+
+      - name: Generate Changelog
+        run: node scripts/changelog-reader/main.mjs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_NUMBER: ${{ github.event.number }}
+          PR_BRANCH: ${{ github.event.pull_request.head.label }}