packServer/backend/scripts/deploy/build-extension.cjs
liufumingren 6818da707e build(extension): 分发用压缩产物(esbuild minify,不混淆)
MV3 没有编译产物,桌面安装包会把插件源码装在 <安装目录>\extension,用户能直接看到
带注释的代码并随手改。这里加一层「压缩」:去注释、压空白、缩短标识符,体积 71KB → 30KB。

- backend/scripts/deploy/build-extension.cjs(新):esbuild 逐文件 minify 输出 extension/dist,
  不做 bundle(importScripts('lib/rules.js') 与各处路径原样有效),无 eval/Function,
  满足 MV3 的 CSP 与商店「代码可读」要求;
- publish-extension.cjs:打包/压缩包一律从 dist 取源;商店 zip 改用自写的
  zip-util.cjs —— PowerShell 5.1 的 Compress-Archive 会把条目名写成 `src\x.js`,
  8.3 短路径下还会多出前导 `/`,商店会当成怪文件名;
- desktop csproj 改为打 ..\extension\dist\**,installer/build.ps1 在 dotnet publish 前
  自动跑一次 bundle(找不到 node/esbuild 明确报错,避免打进上次的旧 dist);
- extension:rules.js 的兜底 urlTemplate/fallback 从 localhost:7301 改为线上站点
  (和服务端默认值保持一致),版本 1.1.2;
- backend 增加 esbuild devDependency 与 npm run extension:bundle;文档同步。

验证:5 个 js 全部 node --check 通过;dist 里 manifest 引用的 14 个文件都在;
Chrome --pack-extension 成功(扩展 ID 不变);zip 条目全部是标准 `/` 且 manifest.json 在根目录、
可正常解压;desktop Debug 编译 0 警告 0 错误,输出目录里是指向 dist 的压缩版(无 keys/README/test)。

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-11-01 03:53:13 +08:00

149 lines
5.2 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

'use strict';
/**
* 打包 Chrome 插件到 `extension/dist`(**只压缩,不混淆**)
*
* 为什么要这一步:
* - MV3 没有编译产物,浏览器直接执行明文 JS;桌面安装包把 `extension/` 整个装在
* `<安装目录>\extension`,用户打开就能看到带注释的源码,也能随手改掉跳转地址;
* - 压缩(去注释、压空白、合并冗余)后体积约为源码的 1/3,逆向和篡改成本明显上升,
* 而且**不需要** eval / Function(MV3 的 CSP 禁止),符合 Chrome 商店「代码必须可读」的要求;
* - 真正需要保密的东西不在这里:识别前缀 / 正则 / 生效站点全部由服务端下发,
* 扩展 ID 的私钥 `extension/keys/key.pem` 也从不进包(见 csproj 的 Exclude)。
*
* 产物目录结构**与源码一致**(manifest 里的路径不用改):
* dist/manifest.json 原样拷贝
* dist/icons/… 原样拷贝
* dist/src/… 的 .js 文件 esbuild 压缩
* dist/src/… 的 .html / .css 原样拷贝(HTML 里引用的 js 路径不变)
*
* ⚠️ `background.js` 用 `importScripts('lib/rules.js')`、`content_scripts` 也各自按路径加载,
* 所以这里**不做 bundle**(不合并文件),只逐文件压缩 —— 语义零变化。
*
* 用法:
* node scripts/deploy/build-extension.cjs
* npm run extension:bundle
*/
const fs = require('node:fs');
const path = require('node:path');
let esbuild;
try {
// devDependency:只在开发和发版机器上装(服务器跑的是已构建产物,不需要)
esbuild = require('esbuild');
} catch {
throw new Error('缺少 esbuild:先执行 `cd backend && npm install`(它是 devDependency,压缩插件要用)');
}
const ROOT = __dirname;
const REPO_ROOT = path.resolve(ROOT, '..', '..', '..');
const EXT_DIR = path.join(REPO_ROOT, 'extension');
const OUT_DIR = path.join(EXT_DIR, 'dist');
/** 进包的内容(README / test / tools / keys / out / dist 自身都不进) */
const INCLUDE = [ 'manifest.json', 'icons', 'src' ];
/** manifest 里声明的最低 Chrome 版本,压缩目标跟着它走 */
const JS_TARGET = 'chrome96';
/** 递归列出目录下所有文件 */
function walk(dir, files = []) {
for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
const full = path.join(dir, entry.name);
if (entry.isDirectory()) {
walk(full, files);
} else if (entry.isFile()) {
files.push(full);
}
}
return files;
}
/** 压缩单个 js 文件 */
async function minifyJs(from, to) {
const source = fs.readFileSync(from, 'utf8');
const result = await esbuild.transform(source, {
loader: 'js',
target: JS_TARGET,
minify: true,
// 保留 'use strict' 等语义;去掉 @license 之类注释(我们的注释都是给人看的)
legalComments: 'none',
// 中文提示语保持原样(默认会转成 \uXXXX,体积更大)
charset: 'utf8',
});
fs.writeFileSync(to, result.code);
return { bytesBefore: Buffer.byteLength(source), bytesAfter: Buffer.byteLength(result.code) };
}
/**
* 生成 dist
* @param {{ log?: boolean }} [options]
* @returns {Promise<Array<{ file: string, bytesBefore: number, bytesAfter: number }>>}
*/
async function build(options = {}) {
const log = options.log !== false;
if (!fs.existsSync(path.join(EXT_DIR, 'manifest.json'))) {
throw new Error(`找不到扩展源码目录:${EXT_DIR}`);
}
fs.rmSync(OUT_DIR, { recursive: true, force: true });
fs.mkdirSync(OUT_DIR, { recursive: true });
const stats = [];
for (const item of INCLUDE) {
const source = path.join(EXT_DIR, item);
if (!fs.existsSync(source)) {
throw new Error(`扩展缺少 ${item}:${source}`);
}
if (!fs.statSync(source).isDirectory()) {
fs.copyFileSync(source, path.join(OUT_DIR, item));
continue;
}
for (const file of walk(source)) {
const relative = path.relative(EXT_DIR, file);
const target = path.join(OUT_DIR, relative);
fs.mkdirSync(path.dirname(target), { recursive: true });
if (path.extname(file).toLowerCase() === '.js') {
const result = await minifyJs(file, target);
stats.push({ file: relative.replace(/\\/g, '/'), ...result });
} else {
fs.copyFileSync(file, target);
}
}
}
if (log) {
const pad = Math.max(...stats.map(item => item.file.length), 8);
let before = 0;
let after = 0;
for (const item of stats) {
before += item.bytesBefore;
after += item.bytesAfter;
console.log(
` ${item.file.padEnd(pad)} ${(item.bytesBefore / 1024).toFixed(1).padStart(6)} KB → ` +
`${(item.bytesAfter / 1024).toFixed(1).padStart(5)} KB`,
);
}
console.log(` ${'合计'.padEnd(pad)} ${(before / 1024).toFixed(1).padStart(6)} KB → ${(after / 1024).toFixed(1).padStart(5)} KB`);
console.log(`插件已打包: ${path.relative(REPO_ROOT, OUT_DIR)}(${INCLUDE.join(' / ')})`);
}
return stats;
}
module.exports = { build, EXT_DIR, OUT_DIR, INCLUDE };
if (require.main === module) {
build().catch(err => {
console.error(`打包插件失败:${err.message}`);
process.exit(1);
});
}