Merge pull request #4730 from pagefaultgames/beta

1.1.0 - The Halloween Update

.env.beta

@@ -1,6 +1,6 @@
 VITE_BYPASS_LOGIN=0
 VITE_BYPASS_TUTORIAL=0
-VITE_SERVER_URL=https://api.beta.pokerogue.net
+VITE_SERVER_URL=https://apibeta.pokerogue.net
 VITE_DISCORD_CLIENT_ID=1248062921129459756
 VITE_GOOGLE_CLIENT_ID=955345393540-2k6lfftf0fdnb0krqmpthjnqavfvvf73.apps.googleusercontent.com
-VITE_I18N_DEBUG=1
+VITE_I18N_DEBUG=0

.env.development

@@ -3,5 +3,5 @@ VITE_BYPASS_TUTORIAL=0
 VITE_SERVER_URL=http://localhost:8001
 VITE_DISCORD_CLIENT_ID=1234567890
 VITE_GOOGLE_CLIENT_ID=1234567890
-VITE_I18N_DEBUG=1
+VITE_I18N_DEBUG=0
 VITE_PORT=8000

.github/CODEOWNERS

@@ -5,41 +5,3 @@
 
 # github actions/templates etc. - Dev Leads
 /.github @pagefaultgames/dev-leads
-
-# --- Translations ---
-
-# all translations - Translation Leads
-/src/locales @pagefaultgames/translation-leads
-
-# Catalan (Spain/Spanish)
-/src/locales/ca_ES @pagefaultgames/catalan-translation-team
-
-# German
-/src/locales/de @pagefaultgames/german-translation-team
-
-# English
-/src/locales/en @pagefaultgames/english-translation-team
-
-# Spanish
-/src/locales/es @pagefaultgames/spanish-translation-team
-
-# French
-/src/locales/fr @pagefaultgames/french-translation-team
-
-# Italian
-/src/locales/it @pagefaultgames/italian-translation-team
-
-# Japenese
-/src/locales/ja @pagefaultgames/japanese-translation-team
-
-# Korean
-/src/locales/ko @pagefaultgames/korean-translation-team
-
-# Brasilian (Brasil/Portuguese)
-/src/locales/pt_BR @pagefaultgames/portuguese_br-translation-team
-
-# Chinese (simplified)
-/src/locales/zh_CN @pagefaultgames/chinese_simplified-translation-team
-
-# Chinese (traditional)
-/src/locales/zh_TW @pagefaultgames/chinese_traditional-translation-team 

.github/workflows/deploy-beta.yml

@@ -11,6 +11,8 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
       - uses: actions/setup-node@v4
         with:
           node-version: "20"

.github/workflows/deploy.yml

@@ -1,15 +1,21 @@
-name: Deploy
+name: Deploy Main
 
 on:
-  push: {}
-  pull_request: {}
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
   deploy:
     if: github.repository == 'pagefaultgames/pokerogue'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
       - uses: actions/setup-node@v4
         with:
           node-version: "20"
@@ -20,20 +26,20 @@ jobs:
         env:
           NODE_ENV: production
       - name: Set up SSH
-        if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+        if: github.event_name == 'push' && github.ref_name == 'main'
         run: |
           mkdir ~/.ssh
           echo "${{ secrets.SSH_PUBLIC_KEY }}" > ~/.ssh/id_ed25519.pub
           echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_ed25519
           chmod 600 ~/.ssh/*
           ssh-keyscan -H ${{ secrets.SSH_HOST }} >> ~/.ssh/known_hosts
       - name: Deploy build on server
-        if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+        if: github.event_name == 'push' && github.ref_name == 'main'
         run: | 
           rsync --del --no-times --checksum -vrm dist/* ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}:${{ secrets.DESTINATION_DIR }}
           ssh -t ${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }} "~/prmanifest --inpath ${{ secrets.DESTINATION_DIR }} --outpath ${{ secrets.DESTINATION_DIR }}/manifest.json"
       - name: Purge Cloudflare Cache
-        if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
+        if: github.event_name == 'push' && github.ref_name == 'main'
         id: purge-cache
         uses: NathanVaughn/[email protected]
         with:

.github/workflows/eslint.yml

@@ -22,6 +22,8 @@ jobs:
     steps:
       - name: Check out Git repository  # Step to check out the repository
         uses: actions/checkout@v4  # Use the checkout action version 4
+        with:
+          submodules: 'recursive'
 
       - name: Set up Node.js  # Step to set up Node.js environment
         uses: actions/setup-node@v4  # Use the setup-node action version 4

.github/workflows/github-pages.yml

@@ -26,6 +26,7 @@ jobs:
       - name: Checkout repository for Typedoc
         uses: actions/checkout@v3
         with:
+          submodules: 'recursive'
           path: pokerogue_docs
 
       - name: Install OS package

.github/workflows/test-shard-template.yml

@@ -20,6 +20,8 @@ jobs:
     steps:
       - name: Check out Git repository
         uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:

.github/workflows/tests.yml

@@ -22,6 +22,7 @@ jobs:
       - name: Check out Git repository
         uses: actions/checkout@v4
         with:
+          submodules: 'recursive'
           path: tests-action
       - name: Set up Node.js
         uses: actions/setup-node@v4

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "public/locales"]
+	path = public/locales
+	url = https://github.com/pagefaultgames/pokerogue-locales

README.md

@@ -17,13 +17,21 @@ If you have the motivation and experience with Typescript/Javascript (or are wil
 2. Run `npm run start:dev` to locally run the project in `localhost:8000`
 
 #### Linting
-We're using ESLint as our common linter and formatter. It will run automatically during the pre-commit hook but if you would like to manually run it, use the `npm run eslint` script.
+We're using ESLint as our common linter and formatter. It will run automatically during the pre-commit hook but if you would like to manually run it, use the `npm run eslint` script. To view the complete rules, check out the [eslint.config.js](./eslint.config.js) file.
+
+### 📚 Documentation
+You can find the auto-generated documentation [here](https://pagefaultgames.github.io/pokerogue/main/index.html).
+For information on enemy AI, check out the [enemy-ai.md](./docs/enemy-ai.md) file.
+For detailed guidelines on documenting your code, refer to the [comments.md](./docs/comments.md) file.
 
 ### ❔ FAQ
 
 **How do I test a new _______?**
 - In the `src/overrides.ts` file there are overrides for most values you'll need to change for testing
 
+**How do I retrieve the translations?**
+- The translations were moved to the [dedicated translation repository](https://github.com/pagefaultgames/pokerogue-locales) and are now applied as a submodule in this project.
+- The command to retrieve the translations is `git submodule update --init --recursive`. If you still struggle to get it working, please reach out to #dev-corner channel in Discord.
 
 ## 🪧 To Do
 Check out [Github Issues](https://github.com/pagefaultgames/pokerogue/issues) to see how can you help us!

create-test-boilerplate.js

@@ -1,9 +1,7 @@
 /**
- * This script creates a test boilerplate file for a move or ability.
- * @param {string} type - The type of test to create. Either "move", "ability",
- * or "item".
- * @param {string} fileName - The name of the file to create.
- * @example npm run create-test move tackle
+ * This script creates a test boilerplate file in the appropriate 
+ * directory based on the type selected.
+ * @example npm run create-test
  */
 
 import fs from "fs";
@@ -34,7 +32,7 @@ async function promptTestType() {
     console.log("Exiting...");
     return process.exit();
   } else if (!typeChoices.includes(typeAnswer.selectedOption)) {
-    console.error('Please provide a valid type ("move", "ability", or "item")!');
+    console.error(`Please provide a valid type (${typeChoices.join(", ")})!`);
     return await promptTestType();
   }
 
@@ -51,7 +49,7 @@ async function promptFileName(selectedType) {
     {
       type: "input",
       name: "userInput",
-      message: `Please provide a file name for the ${selectedType} test:`,
+      message: `Please provide the name of the ${selectedType}:`,
     },
   ]);
 
@@ -102,7 +100,7 @@ async function runInteractive() {
       description = `Mystery Encounter - ${formattedName}`;
       break;
     default:
-      console.error('Invalid type. Please use "move", "ability", or "item".');
+      console.error(`Invalid type. Please use one of the following: ${typeChoices.join(", ")}.`);
       process.exit(1);
   }
 
@@ -112,7 +110,7 @@ import { Moves } from "#enums/moves";
 import { Species } from "#enums/species";
 import GameManager from "#test/utils/gameManager";
 import Phaser from "phaser";
-import { afterEach, beforeAll, beforeEach, describe, it, expect } from "vitest";
+import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest";
 
 describe("${description}", () => {
   let phaserGame: Phaser.Game;
@@ -131,15 +129,22 @@ describe("${description}", () => {
   beforeEach(() => {
     game = new GameManager(phaserGame);
     game.override
-      .moveset([Moves.SPLASH])
+      .moveset([ Moves.SPLASH ])
+      .ability(Abilities.BALL_FETCH)
       .battleType("single")
+      .disableCrits()
+      .enemySpecies(Species.MAGIKARP)
       .enemyAbility(Abilities.BALL_FETCH)
       .enemyMoveset(Moves.SPLASH);
   });
 
-  it("test case", async () => {
-    // await game.classicMode.startBattle([Species.MAGIKARP]);
-    // game.move.select(Moves.SPLASH);
+  it("should do X", async () => {
+    await game.classicMode.startBattle([ Species.FEEBAS ]);
+
+    game.move.select(Moves.SPLASH);
+    await game.phaseInterceptor.to("BerryPhase");
+
+    expect(true).toBe(true);
   });
 });
 `;

eslint.config.js

@@ -1,5 +1,5 @@
 import tseslint from '@typescript-eslint/eslint-plugin';
-import stylisticTs from '@stylistic/eslint-plugin-ts'
+import stylisticTs from '@stylistic/eslint-plugin-ts';
 import parser from '@typescript-eslint/parser';
 import importX from 'eslint-plugin-import-x';
 
@@ -16,31 +16,36 @@ export default [
             '@typescript-eslint': tseslint
         },
         rules: {
-            "eqeqeq": ["error", "always"], // Enforces the use of === and !== instead of == and !=
-            "indent": ["error", 2], // Enforces a 2-space indentation
+            "eqeqeq": ["error", "always"], // Enforces the use of `===` and `!==` instead of `==` and `!=`
+            "indent": ["error", 2, { "SwitchCase": 1 }], // Enforces a 2-space indentation, enforces indentation of `case ...:` statements
             "quotes": ["error", "double"], // Enforces the use of double quotes for strings
-            "no-var": "error", // Disallows the use of var, enforcing let or const instead
-            "prefer-const": "error", // Prefers the use of const for variables that are never reassigned
+            "no-var": "error", // Disallows the use of `var`, enforcing `let` or `const` instead
+            "prefer-const": "error", // Enforces the use of `const` for variables that are never reassigned
             "no-undef": "off", // Disables the rule that disallows the use of undeclared variables (TypeScript handles this)
             "@typescript-eslint/no-unused-vars": [ "error", {
                 "args": "none", // Allows unused function parameters. Useful for functions with specific signatures where not all parameters are always used.
-                "ignoreRestSiblings": true // Allows unused variables that are part of a rest property in object destructuring. Useful for excluding certain properties from an object while using the rest.
+                "ignoreRestSiblings": true // Allows unused variables that are part of a rest property in object destructuring. Useful for excluding certain properties from an object while using the others.
             }],
             "eol-last": ["error", "always"], // Enforces at least one newline at the end of files
             "@stylistic/ts/semi": ["error", "always"], // Requires semicolons for TypeScript-specific syntax
             "semi": "off", // Disables the general semi rule for TypeScript files
             "no-extra-semi": ["error"], // Disallows unnecessary semicolons for TypeScript-specific syntax
             "brace-style": "off", // Note: you must disable the base rule as it can report incorrect errors
             "curly": ["error", "all"], // Enforces the use of curly braces for all control statements
-            "@stylistic/ts/brace-style": ["error", "1tbs"],
+            "@stylistic/ts/brace-style": ["error", "1tbs"], // Enforces the following brace style: https://eslint.style/rules/js/brace-style#_1tbs
             "no-trailing-spaces": ["error", { // Disallows trailing whitespace at the end of lines
                 "skipBlankLines": false, // Enforces the rule even on blank lines
                 "ignoreComments": false // Enforces the rule on lines containing comments
             }],
             "space-before-blocks": ["error", "always"], // Enforces a space before blocks
             "keyword-spacing": ["error", { "before": true, "after": true }], // Enforces spacing before and after keywords
-            "comma-spacing": ["error", { "before": false, "after": true }], // Enforces spacing after comma
+            "comma-spacing": ["error", { "before": false, "after": true }], // Enforces spacing after commas
             "import-x/extensions": ["error", "never", { "json": "always" }], // Enforces no extension for imports unless json
+            "array-bracket-spacing": ["error", "always", { "objectsInArrays": false, "arraysInArrays": false }], // Enforces consistent spacing inside array brackets
+            "object-curly-spacing": ["error", "always", { "arraysInObjects": false, "objectsInObjects": false }], // Enforces consistent spacing inside braces of object literals, destructuring assignments, and import/export specifiers
+            "computed-property-spacing": ["error", "never" ], // Enforces consistent spacing inside computed property brackets
+            "space-infix-ops": ["error", { "int32Hint": false }], // Enforces spacing around infix operators
+            "no-multiple-empty-lines": ["error", { "max": 2, "maxEOF": 1, "maxBOF": 0 }], // Disallows multiple empty lines
         }
     }
 ]

global.d.ts

@@ -0,0 +1,14 @@
+import type { SetupServerApi } from "msw/node";
+
+export {};
+
+declare global {
+  /**
+   * Only used in testing.
+   * Can technically be undefined/null but for ease of use we are going to assume it is always defined.
+   * Used to load i18n files exclusively.
+   * 
+   * To set up your own server in a test see `game_data.test.ts`
+   */
+  var i18nServer: SetupServerApi;
+}

lefthook.yml

@@ -13,4 +13,9 @@ pre-push:
   commands:
     eslint:
       glob: "*.{js,ts,jsx,tsx}"
-      run: npx eslint --fix {push_files}
+      run: npx eslint --fix {push_files}
+
+post-merge:
+  commands:
+    update-submodules:
+      run: git submodule update --init --recursive