Merge branch 'main' into implement-taunt

.eslintignore

@@ -0,0 +1,7 @@
+dist/*
+build/*
+coverage/*
+public/*
+.github/*
+node_modules/*
+.vscode/*

.eslintrc

@@ -1,17 +1,35 @@
 {
-	"env": {
-		"browser": true,
-		"es2021": true
-	},
-	"parserOptions": {
-		"ecmaVersion": "latest",
-		"sourceType": "module"
-	},
-	"overrides": [
-		{
-			"files": ["src/**/*.ts"],
-			"extends": "eslint:recommended"
-		}
-	],
-	"rules": {}
+  "parser": "@typescript-eslint/parser", // Specifies the ESLint parser for TypeScript
+  "plugins": ["@typescript-eslint", "import"], // Includes TypeScript and import plugins
+  "overrides": [
+    {
+      "files": ["src/**/*.{ts,tsx,js,jsx}"], // Applies these rules to all TypeScript and JavaScript files in the src directory
+      "rules": {
+        // General rules that apply to all files
+        "eqeqeq": ["error", "always"], // Enforces the use of === and !== instead of == and !=
+        "indent": ["error", 2], // Enforces a 2-space indentation
+        "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-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.
+        }],
+        "eol-last": ["error", "always"], // Enforces at least one newline at the end of files
+        "@typescript-eslint/semi": ["error", "always"], // Requires semicolons for TypeScript-specific syntax
+        "semi": "off", // Disables the general semi rule for TypeScript files
+        "@typescript-eslint/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
+        "@typescript-eslint/brace-style": ["error", "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
+      }
+    }
+  ]
 }

.github/workflows/eslint.yml

@@ -0,0 +1,31 @@
+name: ESLint
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch
+  push:
+    branches:
+      - main  # Trigger on push events to the main branch
+  pull_request:
+    branches:
+      - main  # Trigger on pull request events targeting the main branch
+
+jobs:
+  run-linters:  # Define a job named "run-linters"
+    name: Run linters  # Human-readable name for the job
+    runs-on: ubuntu-latest  # Specify the latest Ubuntu runner for the job
+
+    steps:
+      - name: Check out Git repository  # Step to check out the repository
+        uses: actions/checkout@v2  # Use the checkout action version 2
+
+      - name: Set up Node.js  # Step to set up Node.js environment
+        uses: actions/setup-node@v1  # Use the setup-node action version 1
+        with:
+          node-version: 20  # Specify Node.js version 20
+
+      - name: Install Node.js dependencies  # Step to install Node.js dependencies
+        run: npm ci  # Use 'npm ci' to install dependencies
+
+      - name: eslint  # Step to run linters
+        uses: icrawl/action-eslint@v1

.gitignore

@@ -24,9 +24,6 @@ dist-ssr
 *.sln
 *.sw?
 
-# Docummentation
-docs/*
-
 public/images/trainer/convert/*
 public/images/battle_anims/input/*.png
 public/images/pokemon/input/*.png

README.md

@@ -8,14 +8,17 @@ If you have the motivation and experience with Typescript/Javascript (or are wil
 
 ### 💻 Environment Setup
 #### Prerequisites
-- node: 18.3.0
+- node: 20.13.1
 - npm: [how to install](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
 
 #### Running Locally
 1. Clone the repo and in the root directory run `npm install`
     - *if you run into any errors, reach out in the **#dev-corner** channel in discord*
 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. 
+
 ### ❔ FAQ 
 
 **How do I test a new _______?**
@@ -74,7 +77,7 @@ Check out our [Trello Board](https://trello.com/b/z10B703R/pokerogue-board) to s
 ### 🎨 Trainer Portraits
   - pkmn_realidea (Paid Commissions)
 
-### 🎨 Pokemon Sprites
+### 🎨 Pokemon Sprites and Animation
   - GAMEFREAK (Pokémon Black/White 2)
   - Smogon Sprite Project (Various Artists)
   - Skyflyer
@@ -100,6 +103,7 @@ Check out our [Trello Board](https://trello.com/b/z10B703R/pokerogue-board) to s
   - bizcoeindoloro
   - mangalos810
   - Involuntary-Twitch
+  - selstar
 
 ### 🎨 Move Animations
   - Pokémon Reborn

docs/linting.md

@@ -0,0 +1,40 @@
+# ESLint
+## Key Features
+
+1. **Automation**:
+   - A pre-commit hook has been added to automatically run ESLint on the added or modified files, ensuring code quality before commits.
+
+2. **Manual Usage**:
+   - If you prefer not to use the pre-commit hook, you can manually run ESLint to automatically fix issues using the command:
+     ```sh
+     npx eslint --fix . or npm run eslint
+     ```
+   - Running this command will lint all files in the repository.
+
+3. **GitHub Action**:
+   - A GitHub Action has been added to automatically run ESLint on every push and pull request, ensuring code quality in the CI/CD pipeline.
+
+## Summary of ESLint Rules
+
+1. **General Rules**:
+   - **Equality**: Use `===` and `!==` instead of `==` and `!=` (`eqeqeq`).
+   - **Indentation**: Enforce 2-space indentation (`indent`).
+   - **Quotes**: Use doublequotes for strings (`quotes`).
+   - **Variable Declarations**: 
+     - Disallow `var`; use `let` or `const` (`no-var`).
+     - Prefer `const` for variables that are never reassigned (`prefer-const`).
+   - **Unused Variables**: Allow unused function parameters but enforce error for other unused variables (`@typescript-eslint/no-unused-vars`).
+   - **End of Line**: Ensure at least one newline at the end of files (`eol-last`).
+   - **Curly Braces**: Enforce the use of curly braces for all control statements (`curly`).
+   - **Brace Style**: Use one true brace style (`1tbs`) for TypeScript-specific syntax (`@typescript-eslint/brace-style`).
+
+2. **TypeScript-Specific Rules**:
+   - **Semicolons**:
+     - Enforce semicolons for TypeScript-specific syntax (`@typescript-eslint/semi`).
+     - Disallow unnecessary semicolons (`@typescript-eslint/no-extra-semi`).
+
+## Benefits
+
+- **Consistency**: Ensures consistent coding style across the project.
+- **Code Quality**: Helps catch potential errors and improve overall code quality.
+- **Readability**: Makes the codebase easier to read and maintain.

lefthook.yml

@@ -0,0 +1,7 @@
+pre-commit:
+  parallel: true
+  commands:
+    eslint:
+      glob: '*.{js,jsx,ts,tsx}'
+      run: npx eslint --fix {staged_files}
+      stage_fixed: true