feat: migrate extension from Plasmo to WXT (#1172)

* feat: migrate extension framework to wxt

- Replace Plasmo entrypoints, messaging, and storage usage with WXT-compatible implementations

- Update workflows, build scripts, and locale paths for WXT outputs

- Switch store submission to wxt submit with optional dry-run input

* fix(ci): fallback to vars for submit credentials

- Resolve missing required config in submit workflow when values are stored in GitHub Variables instead of Secrets

- Keep existing secrets first and add vars fallback for Chrome, Firefox, and Edge credentials

Author: DIYgod

.github/workflows/release.yml

@@ -6,8 +6,9 @@ on:
       - "*"
 
 env:
-  PLASMO_PUBLIC_UMAMI_ID: ${{ vars.PLASMO_PUBLIC_UMAMI_ID }}
-  PLASMO_PUBLIC_UMAMI_URL: ${{ vars.PLASMO_PUBLIC_UMAMI_URL }}
+  WXT_UMAMI_ID: ${{ vars.WXT_UMAMI_ID || vars.PLASMO_PUBLIC_UMAMI_ID }}
+  WXT_UMAMI_URL: ${{ vars.WXT_UMAMI_URL || vars.PLASMO_PUBLIC_UMAMI_URL }}
+  WXT_UMAMI_SAMPLE_RATE: ${{ vars.WXT_UMAMI_SAMPLE_RATE || vars.PLASMO_PUBLIC_UMAMI_SAMPLE_RATE }}
 
 jobs:
   build:
@@ -32,9 +33,9 @@ jobs:
           node-version: 22.x
           cache: "pnpm"
       - name: Package the extension for Chrome
-        run: pnpm build --zip
+        run: pnpm zip
       - name: Package the extension for Firefox
-        run: pnpm build:firefox --zip
+        run: pnpm zip:firefox
       - name: Package the extension for Safari
         run: pnpm build:safari:zip
       - name: Upload file

.github/workflows/submit.yml

@@ -1,10 +1,17 @@
 name: "Submit to Web Store"
 on:
   workflow_dispatch:
+    inputs:
+      dry_run:
+        description: "Run submission in dry-run mode"
+        required: false
+        default: false
+        type: boolean
 
 env:
-  PLASMO_PUBLIC_UMAMI_ID: ${{ vars.PLASMO_PUBLIC_UMAMI_ID }}
-  PLASMO_PUBLIC_UMAMI_URL: ${{ vars.PLASMO_PUBLIC_UMAMI_URL }}
+  WXT_UMAMI_ID: ${{ vars.WXT_UMAMI_ID || vars.PLASMO_PUBLIC_UMAMI_ID }}
+  WXT_UMAMI_URL: ${{ vars.WXT_UMAMI_URL || vars.PLASMO_PUBLIC_UMAMI_URL }}
+  WXT_UMAMI_SAMPLE_RATE: ${{ vars.WXT_UMAMI_SAMPLE_RATE || vars.PLASMO_PUBLIC_UMAMI_SAMPLE_RATE }}
 
 jobs:
   build:
@@ -28,14 +35,30 @@ jobs:
           node-version: 22.x
           cache: "pnpm"
       - name: Package the extension for Chrome
-        run: pnpm build --zip
+        run: pnpm zip
       - name: Package the extension for Firefox
-        run: pnpm build:firefox --zip
-      - name: Browser Platform Publish
-        uses: PlasmoHQ/bpp@v3
-        with:
-          keys: ${{ secrets.SUBMIT_KEYS }}
-          chrome-file: build/chrome-mv3-prod.zip
-          edge-file: build/chrome-mv3-prod.zip
-          firefox-file: build/firefox-mv3-prod.zip
-          notes: "RSSHub Radar is an open source project, you can find the source code at https://github.com/DIYgod/RSSHub-Radar"
+        run: pnpm zip:firefox
+      - name: Submit to web stores
+        env:
+          CHROME_EXTENSION_ID: ${{ secrets.CHROME_EXTENSION_ID || vars.CHROME_EXTENSION_ID }}
+          CHROME_CLIENT_ID: ${{ secrets.CHROME_CLIENT_ID || vars.CHROME_CLIENT_ID }}
+          CHROME_CLIENT_SECRET: ${{ secrets.CHROME_CLIENT_SECRET || vars.CHROME_CLIENT_SECRET }}
+          CHROME_REFRESH_TOKEN: ${{ secrets.CHROME_REFRESH_TOKEN || vars.CHROME_REFRESH_TOKEN }}
+          FIREFOX_EXTENSION_ID: ${{ secrets.FIREFOX_EXTENSION_ID || vars.FIREFOX_EXTENSION_ID }}
+          FIREFOX_JWT_ISSUER: ${{ secrets.FIREFOX_JWT_ISSUER || vars.FIREFOX_JWT_ISSUER }}
+          FIREFOX_JWT_SECRET: ${{ secrets.FIREFOX_JWT_SECRET || vars.FIREFOX_JWT_SECRET }}
+          EDGE_PRODUCT_ID: ${{ secrets.EDGE_PRODUCT_ID || vars.EDGE_PRODUCT_ID }}
+          EDGE_CLIENT_ID: ${{ secrets.EDGE_CLIENT_ID || vars.EDGE_CLIENT_ID }}
+          EDGE_API_KEY: ${{ secrets.EDGE_API_KEY || vars.EDGE_API_KEY }}
+        run: |
+          DRY_RUN_FLAG=""
+          if [ "${{ inputs.dry_run }}" = "true" ]; then
+            DRY_RUN_FLAG="--dry-run"
+          fi
+
+          pnpm wxt submit \
+            --chrome-zip .output/*-chrome.zip \
+            --firefox-zip .output/*-firefox.zip \
+            --firefox-sources-zip .output/*-sources.zip \
+            --edge-zip .output/*-chrome.zip \
+            ${DRY_RUN_FLAG}

.github/workflows/test.yml

@@ -4,8 +4,9 @@ on:
   push:
 
 env:
-  PLASMO_PUBLIC_UMAMI_ID: ${{ vars.PLASMO_PUBLIC_UMAMI_ID }}
-  PLASMO_PUBLIC_UMAMI_URL: ${{ vars.PLASMO_PUBLIC_UMAMI_URL }}
+  WXT_UMAMI_ID: ${{ vars.WXT_UMAMI_ID || vars.PLASMO_PUBLIC_UMAMI_ID }}
+  WXT_UMAMI_URL: ${{ vars.WXT_UMAMI_URL || vars.PLASMO_PUBLIC_UMAMI_URL }}
+  WXT_UMAMI_SAMPLE_RATE: ${{ vars.WXT_UMAMI_SAMPLE_RATE || vars.PLASMO_PUBLIC_UMAMI_SAMPLE_RATE }}
 
 jobs:
   build:
@@ -30,9 +31,9 @@ jobs:
           node-version: 22.x
           cache: "pnpm"
       - name: Package the extension for Chrome
-        run: pnpm build --zip
+        run: pnpm zip
       - name: Package the extension for Firefox
-        run: pnpm build:firefox --zip
+        run: pnpm zip:firefox
       - name: Package the extension for Safari
         run: pnpm build:safari:zip
       - name: Archive production artifacts

.prettierrc.mjs

@@ -15,8 +15,6 @@ export default {
     "<BUILTIN_MODULES>", // Node.js built-in modules
     "<THIRD_PARTY_MODULES>", // Imports not matched by other special words or groups.
     "", // Empty line
-    "^@plasmo/(.*)$",
-    "",
     "^@plasmohq/(.*)$",
     "",
     "^~(.*)$",

README.md

@@ -67,21 +67,21 @@ Open the upper right corner `Developer mode`
 
 Click `Load unpacked extension` in the upper left corner
 
-Select the unzipped `dist` directory
+Select the unzipped extension directory containing `manifest.json`
 
 **Firefox install extension:**
 
 Open `about:debugging`
 
 Click `Load Temporary Extension` in the upper right corner
 
-Select the `manifest.json` file in the unzipped `dist` directory
+Select the `manifest.json` file in the unzipped extension directory
 
 ## Join us
 
 ### Start the Development Server
 
-Also refer to: https://docs.plasmo.com/framework/workflows/dev
+Also refer to: https://wxt.dev/guide/installation
 
 ```
 pnpm i
@@ -95,7 +95,7 @@ npm install
 npm run dev
 ```
 
-Get the `build/chrome-mv3-dev` directory, the installation method refers to [manual installation](#manual installation)
+Get the `.output/chrome-mv3` directory, the installation method refers to [manual installation](#manual installation)
 
 ### Submit New RSSHub Radar Rules
 

package.json

@@ -6,21 +6,22 @@
   "author": "DIYgod",
   "packageManager": "pnpm@9.12.3",
   "scripts": {
-    "dev": "plasmo dev --no-cs-reload",
-    "build": "plasmo build",
-    "dev:firefox": "plasmo dev --target=firefox-mv3 --no-cs-reload",
-    "build:firefox": "plasmo build --target=firefox-mv3",
-    "build:safari": "plasmo build --target=safari-mv3",
-    "safari-convert": "xcrun safari-web-extension-converter build/safari-mv3-prod --project-location build --bundle-identifier app.rsshub.RSSHub-Radar --force",
+    "dev": "wxt",
+    "build": "wxt build",
+    "dev:firefox": "wxt -b firefox --mv3",
+    "build:firefox": "wxt build -b firefox --mv3",
+    "build:safari": "wxt build -b safari --mv3",
+    "zip": "wxt zip && mkdir -p build && cp .output/rsshub-radar-*-chrome.zip build/chrome-mv3-prod.zip",
+    "zip:firefox": "wxt zip -b firefox --mv3 && mkdir -p build && cp .output/rsshub-radar-*-firefox.zip build/firefox-mv3-prod.zip",
+    "safari-convert": "xcrun safari-web-extension-converter .output/safari-mv3 --project-location build --bundle-identifier app.rsshub.RSSHub-Radar --force",
     "safari-zip": "zip -r build/safari-mv3-prod.zip \"build/RSSHub Radar\"",
-    "build:safari:zip": "npm run build:safari && npm run safari-convert && npm run safari-zip",
-    "package": "plasmo package",
-    "prepare": "husky install"
+    "build:safari:zip": "pnpm build:safari && pnpm safari-convert && pnpm safari-zip",
+    "package": "pnpm zip && pnpm zip:firefox",
+    "prepare": "husky install",
+    "postinstall": "wxt prepare"
   },
   "dependencies": {
     "@iconify-json/mingcute": "^1.2.3",
-    "@plasmohq/messaging": "^0.6.2",
-    "@plasmohq/storage": "^1.13.0",
     "@radix-ui/react-accordion": "^1.2.3",
     "@radix-ui/react-dialog": "1.1.6",
     "@radix-ui/react-label": "^2.1.2",
@@ -34,7 +35,6 @@
     "lodash": "^4.17.21",
     "lucide-react": "^0.475.0",
     "md5.js": "^1.3.5",
-    "plasmo": "0.89.4",
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "react-hot-toast": "^2.5.1",
@@ -54,6 +54,7 @@
     "@types/node": "22.13.1",
     "@types/react": "18.3.11",
     "@types/react-dom": "18.3.1",
+    "@wxt-dev/module-react": "^1.1.5",
     "autoprefixer": "^10.4.20",
     "husky": "9.1.7",
     "lint-staged": "15.4.3",
@@ -62,29 +63,15 @@
     "prettier-package-json": "2.8.0",
     "shadcn-ui": "^0.9.4",
     "tailwindcss": "^3.4.13",
-    "typescript": "5.7.3"
+    "typescript": "5.7.3",
+    "wxt": "^0.20.14"
   },
   "lint-staged": {
     "**/*": "prettier --write --ignore-unknown"
   },
-  "manifest": {
-    "default_locale": "en",
-    "host_permissions": [
-      "https://*/*"
-    ],
-    "permissions": [
-      "tabs",
-      "offscreen",
-      "storage",
-      "alarms"
-    ],
-    "optional_permissions": [
-      "notifications"
-    ],
-    "browser_specific_settings": {
-      "gecko": {
-        "id": "i@diygod.me"
-      }
+  "pnpm": {
+    "overrides": {
+      "publish-browser-extension": "3.0.3"
     }
   }
 }