Merge branch 'staging' into fix-srw-trim

Author: Cohee1207

.eslintrc.cjs

@@ -3,6 +3,9 @@ module.exports = {
     extends: [
         'eslint:recommended',
     ],
+    plugins: [
+        'jsdoc',
+    ],
     env: {
         es6: true,
     },
@@ -78,6 +81,7 @@ module.exports = {
         'public/scripts/extensions/tts/lib/**',
     ],
     rules: {
+        'jsdoc/no-undefined-types': ['warn', { disableReporting: true, markVariablesAsUsed: true }],
         'no-unused-vars': ['error', { args: 'none' }],
         'no-control-regex': 'off',
         'no-constant-condition': ['error', { checkLoops: false }],

.github/workflows/pr-auto-manager.yml

@@ -11,6 +11,41 @@ permissions:
   pull-requests: write
 
 jobs:
+  run-eslint:
+    name: ✅ Check ESLint on PR
+    runs-on: ubuntu-latest
+    # Only needs to run when code is changed
+    if: github.event.action == 'opened' || github.event.action == 'synchronize'
+
+    steps:
+      - name: Checkout Repository
+        # Checkout
+        # https://github.com/marketplace/actions/checkout
+        uses: actions/checkout@v4.2.2
+
+      - name: Setup Node.js
+        # Setup Node.js environment
+        # https://github.com/marketplace/actions/setup-node-js-environment
+        uses: actions/setup-node@v4.3.0
+        with:
+          node-version: 20
+
+      - name: Run npm install
+        run: npm ci
+
+      - name: Run ESLint
+        # Action ESLint
+        # https://github.com/marketplace/actions/action-eslint
+        uses: sibiraj-s/action-eslint@v3.0.1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          eslint-args: '--ignore-path=.gitignore --quiet'
+          extensions: 'js,ts'
+          annotations: true
+          ignore-patterns: |
+            dist/
+            lib/
+
   label-by-size:
     name: 🏷️ Label PR by Size
     # This job should run after all others, to prevent possible concurrency issues
@@ -186,6 +221,12 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event.pull_request.merged == true && github.event.pull_request.base.ref == 'staging'
 
+    # Override permissions, We need to be able to write to issues
+    permissions:
+      contents: read
+      issues: write
+      pull-requests: write
+
     steps:
       - name: Extract Linked Issues From PR Description
         id: extract_issues

package-lock.json

@@ -140,6 +140,7 @@
         "@types/write-file-atomic": "^4.0.3",
         "@types/yargs": "^17.0.33",
         "@types/yauzl": "^2.10.3",
-        "eslint": "^8.57.1"
+        "eslint": "^8.57.1",
+        "eslint-plugin-jsdoc": "^48.10.0"
     }
 }