mousehunt-improved 0.97.1

package/.editorconfig

@@ -0,0 +1,15 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+quote_type = single
+
+[*.md]
+trim_trailing_whitespace = false

package/.eslintignore

@@ -0,0 +1,2 @@
+/dist
+/extension/static

package/.eslintrc.json

@@ -0,0 +1,153 @@
+{
+  "root": true,
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@wordpress/eslint-plugin/recommended-with-formatting",
+    "plugin:import/recommended",
+    "plugin:json/recommended",
+    "plugin:eslint-comments/recommended",
+    "plugin:promise/recommended",
+    "plugin:unicorn/recommended"
+  ],
+  "plugins": ["import-newlines", "jsdoc", "json", "unicorn"],
+  "parserOptions": {
+    "sourceType": "module"
+  },
+  "settings": {
+    "import/resolver": {
+      "node": {
+        "extensions": [".js", ".jsx", ".ts", ".tsx"]
+      }
+    }
+  },
+  "rules": {
+    "array-bracket-spacing": ["error", "never"],
+    "block-spacing": ["error", "always"],
+    "comma-dangle": [
+      "error",
+      {
+        "arrays": "only-multiline",
+        "objects": "only-multiline",
+        "imports": "never",
+        "exports": "never",
+        "functions": "never"
+      }
+    ],
+    "comma-spacing": [
+      "error",
+      {
+        "before": false,
+        "after": true
+      }
+    ],
+    "computed-property-spacing": ["error", "never"],
+    "eol-last": ["error", "always"],
+    "import-newlines/enforce": "error",
+    "import/exports-last": "error",
+    "import/first": "error",
+    "import/group-exports": "error",
+    "import/no-absolute-path": "error",
+    "import/no-cycle": "error",
+    "import/no-named-as-default": "error",
+    "import/no-unassigned-import": "error",
+    "import/no-unresolved": [
+      "error",
+      {
+        "ignore": ["^@/", "@data", "@utils"]
+      }
+    ],
+    "import/no-useless-path-segments": "error",
+    "indent": ["error", 2],
+    "jsdoc/check-alignment": "error",
+    "jsdoc/check-indentation": "warn",
+    "jsdoc/check-line-alignment": "warn",
+    "jsdoc/multiline-blocks": "warn",
+    "jsdoc/no-bad-blocks": "warn",
+    "jsdoc/no-blank-block-descriptions": "warn",
+    "jsdoc/no-blank-blocks": "warn",
+    "jsdoc/no-multi-asterisks": ["warn", { "allowWhitespace": true }],
+    "jsdoc/no-undefined-types": "warn",
+    "jsdoc/require-asterisk-prefix": "warn",
+    "jsdoc/require-description-complete-sentence": "warn",
+    "jsdoc/require-description": "warn",
+    "jsdoc/require-hyphen-before-param-description": ["warn", "never"],
+    "jsdoc/require-jsdoc": ["off", {
+      "require": {
+        "ArrowFunctionExpression": true,
+        "ClassDeclaration":  true,
+        "ClassExpression": true,
+        "FunctionDeclaration":  true,
+        "FunctionExpression":  true,
+        "MethodDefinition":  true
+      },
+      "enableFixer": false,
+      "minLineCount": 2
+    }],
+    "jsdoc/require-param-description": "warn",
+    "jsdoc/require-param-name": "warn",
+    "jsdoc/require-param-type": "warn",
+    "jsdoc/require-param": "warn",
+    "jsdoc/require-returns-check": "warn",
+    "jsdoc/require-returns-description": "warn",
+    "jsdoc/require-returns-type": "warn",
+    "jsdoc/require-returns": "warn",
+    "jsdoc/tag-lines": "warn",
+    "jsdoc/valid-types": "warn",
+    "jsx-quotes": ["error", "prefer-double"],
+    "linebreak-style": ["error", "unix"],
+    "no-alert": "error",
+    "no-console": "error",
+    "no-eval": "error",
+    "no-implied-eval": "error",
+    "no-template-curly-in-string": "error",
+    "no-undef": 0,
+    "no-unused-labels": 0,
+    "no-useless-concat": "error",
+    "object-curly-spacing": ["error", "always"],
+    "promise/always-return": ["error", { "ignoreLastCallback": true }],
+    "quotes": ["error", "single"],
+    "semi": ["error", "always"],
+    "sort-imports": [
+      "error",
+      {
+        "allowSeparatedGroups": true,
+        "memberSyntaxSortOrder": ["none", "all", "multiple", "single"]
+      }
+    ],
+    "space-before-function-paren": [
+      "error",
+      {
+        "anonymous": "always",
+        "named": "never",
+        "asyncArrow": "always"
+      }
+    ],
+    "space-in-parens": ["error", "never"],
+    "spaced-comment": ["error", "always"],
+    "template-curly-spacing": ["error", "never"],
+    "unicorn/explicit-length-check": "off",
+    "unicorn/no-array-for-each": "off",
+    "unicorn/no-array-reduce": "off",
+    "unicorn/no-keyword-prefix": "off",
+    "unicorn/no-null": "off",
+    "unicorn/no-unused-properties": "off",
+    "unicorn/prefer-add-event-listener": "off",
+    "unicorn/prefer-blob-reading-methods": "off",
+    "unicorn/prefer-dom-node-dataset": "off",
+    "unicorn/prefer-dom-node-text-content": "off",
+    "unicorn/prefer-switch": "off",
+    "unicorn/prevent-abbreviations": "off",
+    "unicorn/switch-case-braces": ["warn", "avoid"],
+    "unicorn/numeric-separators-style": "off",
+    "valid-jsdoc": [
+      "warn",
+      {
+        "requireReturn": false
+      }
+    ]
+  }
+}

package/.eslintrc.markdown.json

@@ -0,0 +1,11 @@
+{
+  "extends": ["./.eslintrc.json", "plugin:markdownlint/recommended"],
+  "parser": "eslint-plugin-markdownlint/parser",
+  "rules": {
+    "markdownlint/md013": "off",
+    "markdownlint/md024": "off",
+    "markdownlint/md029": "off",
+    "markdownlint/md033": "off",
+    "unicorn/filename-case": "off"
+  }
+}

package/.gitattributes

@@ -0,0 +1,7 @@
+# Force Git to checkout text files as LF for ESLint conformity
+* text eol=lf
+
+# Git thinks PNG files are a good candidate for CRLF replacement. They aren't.
+*.png binary
+
+*.lockb binary diff=lockb

package/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    assignees:
+      - "bradp"
+    versioning-strategy: increase
+    groups:
+      dev-dependencies:
+        applies-to: version-updates
+        patterns:
+          - "*"
+    ignore:
+      - dependency-name: "stylelint*"
+      - dependency-name: "eslint*"
+      - dependency-name: "yargs*"

package/.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        node-version:
+          - 24.x
+        os:
+          - macos-latest
+          - ubuntu-latest
+          - windows-latest
+    runs-on:
+      ${{ matrix.os }}
+    steps:
+    - uses: actions/checkout@v6
+    - uses: oven-sh/setup-bun@v2
+    - run: bun install
+    - run: bun run build

package/.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: Lint
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - name: Install Dependencies
+        run: bun install
+      - name: Lint
+        run: bun run lint

package/.github/workflows/publish.yml

@@ -0,0 +1,215 @@
+name: Release New Version
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - 'v*.*.*'
+
+jobs:
+  build:
+    name: Build Extension
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+      changelog: ${{ steps.changelog.outputs.changelog }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Get version
+        id: version
+        run: echo "version=$(bun run scripts/get-version.mjs)" >> "$GITHUB_OUTPUT"
+
+      - name: Get changelog
+        id: changelog
+        run: |
+          changelog=$(bun run get-changelog)
+          {
+            echo "changelog<<EOF"
+            echo "$changelog"
+            echo "EOF"
+          } >> "$GITHUB_OUTPUT"
+
+      - name: Build extension
+        run: |
+          # Make sure we pass linting before building.
+          bun run lint || exit 1
+
+          # Fetch external CSS files.
+          bun run build:css
+
+          bun run build:extension:chrome --release
+          bun run build:extension:firefox --release
+          bun run build:userscript
+
+      - name: Inject Sentry
+        run: |
+          # Create a new Sentry release, inject information, and upload source maps.
+          bun run sentry-cli releases new "mousehunt-improved@${{ steps.version.outputs.version }}" \
+            --org mousehunt \
+            --project mh-improved \
+            --auth-token ${{ secrets.SENTRY_AUTH_TOKEN }}
+
+          bun run sentry-cli sourcemaps inject dist/chrome \
+            --org mousehunt \
+            --project mh-improved \
+            --release "mousehunt-improved@${{ steps.version.outputs.version }}" \
+            --auth-token ${{ secrets.SENTRY_AUTH_TOKEN }}
+
+          bun run sentry-cli sourcemaps upload dist/chrome \
+            --org mousehunt \
+            --project mh-improved \
+            --release "mousehunt-improved@${{ steps.version.outputs.version }}" \
+            --rewrite \
+            --auth-token ${{ secrets.SENTRY_AUTH_TOKEN }}
+
+          bun run sentry-cli releases finalize "mousehunt-improved@${{ steps.version.outputs.version }}" \
+            --auth-token ${{ secrets.SENTRY_AUTH_TOKEN }}
+        env:
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+
+      - name: Zip and archive files
+        run: |
+          bun run scripts/build.mjs archive
+          bun run scripts/build.mjs zips
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: |
+            dist/mousehunt-improved-chrome.zip
+            dist/mousehunt-improved-firefox.zip
+            dist/firefox
+            dist/mousehunt-improved.user.js
+            dist/archive.zip
+
+
+  create-github-release:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v8
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Create GitHub Release
+        run: |
+          # Create a GitHub release with the version and changelog.
+          VERSION_TAG="v$VERSION"
+
+          gh release create "$VERSION_TAG" \
+            dist/mousehunt-improved-chrome.zip \
+            dist/mousehunt-improved-firefox.zip \
+            dist/mousehunt-improved.user.js \
+            --title "MouseHunt Improved $VERSION_TAG" \
+            --notes "$CHANGELOG"
+        env:
+          GH_TOKEN: ${{ github.token }}
+          VERSION: ${{ needs.build.outputs.version }}
+          CHANGELOG: ${{ needs.build.outputs.changelog }}
+
+  chrome-upload:
+    name: Upload Chrome Extension
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v8
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Upload Chrome Extension
+        run: |
+          bun run chrome-webstore-upload upload \
+            --source dist/mousehunt-improved-chrome.zip \
+            --auto-publish \
+            --extension-id fgjkidgknmkhnbeobehlfabjbignhkhm \
+            --client-id "$CHROME_CLIENT_ID" \
+            --client-secret "$CHROME_CLIENT_SECRET" \
+            --refresh-token "$CHROME_REFRESH_TOKEN"
+        env:
+          CHROME_CLIENT_ID: ${{ secrets.CHROME_CLIENT_ID }}
+          CHROME_CLIENT_SECRET: ${{ secrets.CHROME_CLIENT_SECRET }}
+          CHROME_REFRESH_TOKEN: ${{ secrets.CHROME_REFRESH_TOKEN }}
+
+  firefox-upload:
+    name: Upload Firefox Extension
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v8
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Set up Bun
+        uses: oven-sh/setup-bun@v2
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Upload Firefox Extension
+        run: |
+          bun run web-ext sign \
+            --source-dir dist/firefox \
+            --upload-source-code dist/archive.zip \
+            --api-key "$FIREFOX_API_KEY" \
+            --api-secret "$FIREFOX_API_SECRET" \
+            --channel "listed"
+        env:
+          FIREFOX_API_KEY: ${{ secrets.FIREFOX_API_KEY }}
+          FIREFOX_API_SECRET: ${{ secrets.FIREFOX_API_SECRET }}
+
+  userscript-upload:
+    name: Upload Userscript
+    runs-on: ubuntu-latest
+    needs: build
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          ref: 'userscript-build'
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v8
+        with:
+          path: dist
+          merge-multiple: true
+
+      - name: Commit changes
+        run: |
+          # Commit the files to the userscript-build branch.
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add dist/mousehunt-improved.user.js
+          git commit -m "User script v${{ needs.build.outputs.version }}" || exit 0
+          git push origin userscript-build

package/.stylelintrc.json

@@ -0,0 +1,51 @@
+{
+  "extends": [
+    "stylelint-config-standard",
+    "stylelint-config-recess-order",
+    "stylelint-stylistic/config",
+    "stylelint-prettier/recommended"
+  ],
+  "ignoreFiles": [
+    "dist/**/*",
+    "src/extension/static/*"
+  ],
+  "rules": {
+    "at-rule-no-unknown": true,
+    "block-no-empty": true,
+    "color-hex-length": "short",
+    "color-named": "never",
+    "color-no-invalid-hex": true,
+    "comment-no-empty": true,
+    "comment-whitespace-inside": "always",
+    "declaration-block-no-duplicate-properties": true,
+    "declaration-no-important": null,
+    "declaration-property-unit-allowed-list": { "line-height": ["px"]},
+    "font-family-name-quotes": "always-where-recommended",
+    "font-family-no-duplicate-names": true,
+    "font-weight-notation": ["numeric", { "ignore": ["relative"] }],
+    "function-url-quotes": "never",
+    "media-feature-range-notation": null,
+    "no-descending-specificity": null,
+    "no-invalid-double-slash-comments": true,
+    "no-irregular-whitespace": true,
+    "rule-empty-line-before": ["always", { "except": ["after-single-line-comment", "first-nested"], "ignore": ["after-comment"] }],
+    "selector-attribute-quotes": "always",
+    "selector-class-pattern": null,
+    "selector-id-pattern": null,
+    "selector-pseudo-class-no-unknown": true,
+    "selector-pseudo-element-colon-notation": "double",
+    "selector-pseudo-element-no-unknown": true,
+    "selector-type-case": "lower",
+    "selector-type-no-unknown": true,
+    "shorthand-property-no-redundant-values": true,
+    "unit-no-unknown": true,
+    "value-keyword-case": "lower",
+    "stylistic/max-line-length": [120, { "ignore": ["non-comments"] }],
+    "stylistic/number-leading-zero": null,
+    "prettier/prettier": [true, {
+      "singleQuote": false,
+      "printWidth": 220
+    }]
+  },
+  "cache": true
+}

package/.vscode/tasks.json

@@ -0,0 +1,37 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build",
+      "command": "bun run build:extension:chrome",
+      "type": "shell",
+      "options": {
+        "cwd": "${workspaceRoot}"
+      },
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "presentation": {
+        "echo": true,
+        "reveal": "always",
+        "panel": "shared",
+        "close": true
+      },
+      "problemMatcher": []
+    },
+    {
+      "label": "Lint",
+      "command": "bun run lint",
+      "type": "shell",
+      "options": {
+        "cwd": "${workspaceRoot}"
+      },
+      "group": "test",
+      "presentation": {
+        "reveal": "silent",
+        "panel": "shared"
+      }
+    }
+  ]
+}