Refactor manifest conversion for Firefox packaging

Replaced inline PowerShell/Node.js manifest conversion logic in build scripts with a dedicated Node.js script (convert-manifest-firefox.js) for improved reliability and maintainability. Updated build.bat and build.sh to use the new script for Firefox extension packaging.

Author: cloud-oc

build/build.bat

@@ -23,17 +23,14 @@ mkdir dist
 
 REM Chrome/Edge packaging
 echo [PACK] Building Chrome/Edge version...
-REM Use tar to create zip with forward slashes to avoid Firefox AMO "Invalid file name" error
 tar -a -cf "dist\pixtab-%VERSION%-chrome.zip" manifest.json LICENSE index.html options.html style.css _locales icons src
 
 REM Firefox packaging (temporarily modify manifest)
 echo [PACK] Building Firefox version...
 copy manifest.json manifest.backup.json >nul
 
-REM Use PowerShell to parse and update JSON (more robust)
-REM Firefox does not support service_worker, convert to scripts array format
-powershell -Command "$m = Get-Content manifest.json -Raw | ConvertFrom-Json; if ($m.background -and $m.background.service_worker) { $sw = $m.background.service_worker; $type = $m.background.type; $m.background = New-Object PSObject; $m.background | Add-Member scripts @($sw); if ($type) { $m.background | Add-Member type $type } }; if ($m.action -and $m.action.default_icon -is [System.Collections.Hashtable]) { $icon = $m.action.default_icon.'48' -or $m.action.default_icon.'32' -or $m.action.default_icon.'16' -or $m.action.default_icon.'128'; if (-not $icon) { $icon = 'icons/icon-48.png' }; $m.action.default_icon = $icon }; if (-not $m.browser_specific_settings) { $m.browser_specific_settings = New-Object PSObject }; if (-not $m.browser_specific_settings.gecko) { $m.browser_specific_settings | Add-Member gecko (New-Object PSObject) }; $m.browser_specific_settings.gecko.strict_min_version = '113.0'; $m.browser_specific_settings | Add-Member gecko_android (New-Object PSObject -Property @{ strict_min_version = '113.0' }) -Force; $m | ConvertTo-Json -Depth 10 | Set-Content manifest.json"
-powershell -Command "$m = Get-Content manifest.json -Raw | ConvertFrom-Json; if ($m.background -and $m.background.service_worker) { $sw = $m.background.service_worker; $type = $m.background.type; $m.background = New-Object PSObject; $m.background | Add-Member -NotePropertyName scripts -NotePropertyValue @($sw); if ($type) { $m.background | Add-Member -NotePropertyName type -NotePropertyValue $type } }; if ($m.action -and $m.action.default_icon -is [System.Collections.Hashtable]) { $icon = $null; foreach ($k in @('48','32','16','128')) { if ($m.action.default_icon.ContainsKey($k) -and $m.action.default_icon.$k) { $icon = $m.action.default_icon.$k; break } }; if (-not $icon) { $icon = 'icons/icon-48.png' }; $m.action.default_icon = $icon }; if (-not $m.browser_specific_settings) { $m.browser_specific_settings = New-Object PSObject }; if (-not $m.browser_specific_settings.gecko) { $m.browser_specific_settings | Add-Member -NotePropertyName gecko -NotePropertyValue (New-Object PSObject) }; $m.browser_specific_settings.gecko.strict_min_version = '113.0'; if (-not $m.browser_specific_settings.gecko_android) { $m.browser_specific_settings | Add-Member -NotePropertyName gecko_android -NotePropertyValue (New-Object PSObject -Property @{ strict_min_version = '113.0' }) } else { $m.browser_specific_settings.gecko_android.strict_min_version = '113.0' }; if (-not $m.browser_specific_settings.gecko.data_collection_permissions) { $m.browser_specific_settings.gecko | Add-Member -NotePropertyName data_collection_permissions -NotePropertyValue (New-Object PSObject -Property @{ collects = $false; required = @('none'); optional = @() }) }; $m | ConvertTo-Json -Depth 10 | Set-Content manifest.json"
+REM Use external Node.js script for manifest conversion (more reliable)
+node "%~dp0convert-manifest-firefox.js"
 
 tar -a -cf "dist\pixtab-%VERSION%-firefox.zip" manifest.json LICENSE index.html options.html style.css _locales icons src
 

build/build.sh

@@ -1,60 +1,37 @@
 #!/bin/bash
-# PixTab 一键打包脚本 (macOS/Linux)
+# PixTab Build Script (macOS/Linux)
+# Generates Chrome/Edge and Firefox extension packages
 set -e
 
-cd "$(dirname "$0")/.."
+SCRIPT_DIR="$(dirname "$0")"
+cd "$SCRIPT_DIR/.."
 
-echo "🔨 开始打包 PixTab..."
+echo "🔨 [BUILD] Starting PixTab packaging..."
 
-# 读取版本号
+# Read version from manifest.json
 VERSION=$(node -e "console.log(require('./manifest.json').version)")
-echo "📋 版本号: $VERSION"
+echo "📋 [INFO] Version: $VERSION"
 
 rm -rf dist
 mkdir -p dist
 
-# 打包 Chrome/Edge 版本
-echo "📦 打包 Chrome/Edge 版本..."
+# Chrome/Edge packaging
+echo "📦 [PACK] Building Chrome/Edge version..."
 zip -r "dist/pixtab-${VERSION}-chrome.zip" manifest.json LICENSE index.html options.html style.css _locales icons src -x "*.git*" -x "*.DS_Store"
 
-# 打包 Firefox 版本（临时修改 manifest）
-echo "📦 打包 Firefox 版本..."
+# Firefox packaging (temporarily modify manifest)
+echo "📦 [PACK] Building Firefox version..."
 cp manifest.json manifest.backup.json
 
-# 用 Node.js 处理 manifest 字段，兼容 Firefox
-# Firefox 不支持 service_worker，需要转换为 scripts 数组格式
-node -e "
-const fs = require('fs');
-const manifestPath = 'manifest.json';
-const manifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
-// Firefox 需要 scripts 数组而不是 service_worker
-if (manifest.background && manifest.background.service_worker) {
-    const sw = manifest.background.service_worker;
-    const type = manifest.background.type;
-    manifest.background = { scripts: [sw] };
-    if (type) manifest.background.type = type;
-}
-if (manifest.action && manifest.action.default_icon && typeof manifest.action.default_icon === 'object') {
-    const sizes = ['48', '32', '16', '128'];
-    let selected = null;
-    for (const s of sizes) { if (manifest.action.default_icon[s]) { selected = manifest.action.default_icon[s]; break; } }
-    if (!selected) selected = 'icons/icon-48.png';
-    manifest.action.default_icon = selected;
-}
-if (!manifest.browser_specific_settings) manifest.browser_specific_settings = {};
-if (!manifest.browser_specific_settings.gecko) manifest.browser_specific_settings.gecko = {};
-manifest.browser_specific_settings.gecko.strict_min_version = '113.0';
-if (!manifest.browser_specific_settings.gecko_android) manifest.browser_specific_settings.gecko_android = {};
-manifest.browser_specific_settings.gecko_android.strict_min_version = '113.0';
-manifest.browser_specific_settings.gecko.data_collection_permissions = manifest.browser_specific_settings.gecko.data_collection_permissions || { collects: false, required: ['none'], optional: [] };
-fs.writeFileSync(manifestPath, JSON.stringify(manifest, null, 2));
-"
+# Use external Node.js script for manifest conversion (more reliable)
+node "$SCRIPT_DIR/convert-manifest-firefox.js"
 
 zip -r "dist/pixtab-${VERSION}-firefox.xpi" manifest.json LICENSE index.html options.html style.css _locales icons src -x "*.git*" -x "*.DS_Store"
 
+# Restore original manifest
 mv manifest.backup.json manifest.json
 
 echo ""
-echo "✅ 打包完成!"
-echo " - dist/pixtab-${VERSION}-chrome.zip"
-echo " - dist/pixtab-${VERSION}-firefox.xpi"
+echo "✅ [DONE] Packaging complete!"
+echo "   - dist/pixtab-${VERSION}-chrome.zip  -> Chrome Web Store / Edge Add-ons"
+echo "   - dist/pixtab-${VERSION}-firefox.xpi -> Firefox AMO"

build/convert-manifest-firefox.js

@@ -0,0 +1,47 @@
+/**
+ * Convert manifest.json for Firefox compatibility
+ * Firefox does not support service_worker in background, needs scripts array
+ */
+const fs = require('fs');
+const path = require('path');
+
+const manifestPath = path.join(process.cwd(), 'manifest.json');
+const m = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));
+
+// Firefox needs scripts array instead of service_worker
+if (m.background && m.background.service_worker) {
+    const sw = m.background.service_worker;
+    const type = m.background.type;
+    m.background = { scripts: [sw] };
+    if (type) m.background.type = type;
+}
+
+// Firefox prefers single icon string for action.default_icon
+if (m.action && m.action.default_icon && typeof m.action.default_icon === 'object') {
+    const sizes = ['48', '32', '16', '128'];
+    let selected = null;
+    for (const s of sizes) {
+        if (m.action.default_icon[s]) {
+            selected = m.action.default_icon[s];
+            break;
+        }
+    }
+    if (!selected) selected = 'icons/icon-48.png';
+    m.action.default_icon = selected;
+}
+
+// Ensure browser_specific_settings for Firefox
+if (!m.browser_specific_settings) m.browser_specific_settings = {};
+if (!m.browser_specific_settings.gecko) m.browser_specific_settings.gecko = {};
+m.browser_specific_settings.gecko.strict_min_version = '113.0';
+
+if (!m.browser_specific_settings.gecko_android) m.browser_specific_settings.gecko_android = {};
+m.browser_specific_settings.gecko_android.strict_min_version = '113.0';
+
+// Data collection permissions for Firefox
+m.browser_specific_settings.gecko.data_collection_permissions = 
+    m.browser_specific_settings.gecko.data_collection_permissions || 
+    { collects: false, required: ['none'], optional: [] };
+
+fs.writeFileSync(manifestPath, JSON.stringify(m, null, 2));
+console.log('[OK] Manifest converted for Firefox');