Zen Browser 如何把 Firefox 引擎的 TypeScript 类型同步到 src/zen/types【免费下载链接】desktopWelcome to a calmer internet项目地址: https://gitcode.com/GitHub_Trending/desktop70/desktop在 Zen Browser 的开发仓库里src/zen/下的浏览器代码大量直接使用Ci、Cc、Cu、Services、Components这些 Gecko 全局对象。为了让这些对象在 TypeScript 里有真实的类型而不是一片any仓库通过 scripts/update_ts_types.py 把 Firefox 引擎自带的类型声明文件同步到 src/zen/types并在其中挂入 Zen 自己的扩展声明 src/zen/types/zen.d.ts。当你升级了引擎代码、或想确认本地类型是否与当前引擎一致时就需要重新执行这次同步。本文只讲这一件事跑同步脚本、理解它复制了哪些文件、以及怎么确认同步已经生效。同步机制三类来源文件脚本把类型文件分成三组每组在engine/tools/types里的位置不同见 scripts/update_ts_types.py 中的FILES、GENERATED_FILES和路径常量分组文件在引擎中的来源位置手写声明FILESindex.d.ts、lib.gecko.tweaks.d.ts、lib.gecko.xpidl.d.tsengine/tools/types/生成声明GENERATED_FILESlib.gecko.win32.d.ts、lib.gecko.xpcom.d.ts、lib.gecko.darwin.d.ts、lib.gecko.dom.d.ts、lib.gecko.glean.d.ts、lib.gecko.linux.d.ts、lib.gecko.modules.d.ts、lib.gecko.nsresult.d.ts、lib.gecko.services.d.tsengine/tools/types/generated/Zen 扩展zen.d.ts不复制只追加引用见下文复制完成后脚本还会在src/zen/types/index.d.ts末尾追加以下内容/// reference types./zen.d.ts /这一步把 Zen 的扩展声明挂进整个类型索引。当前仓库里的 src/zen/types/index.d.ts 最后一行就是这条引用。注意追加发生在文件尾部因此重复运行脚本会在index.d.ts里堆叠多条相同的 reference——同步前如果引擎或类型声明没有变化不必重复执行。前置条件仓库必须已经完成初始化本地存在engine/目录Firefox 引擎源码。仓库的 npm 脚本 里startcd engine python3 ./mach run --noprofile、lintcd engine ./mach lint zen等命令都要求先cd engine同步脚本中的mach ts调用同理。docs/contribute.md 明确要求配置本地开发环境前先阅读官方的 Building Guidelines构建指南链接位于该文档中否则可能出现可以避免的构建错误。环境要求 Linux 或 macOS 的 shell 环境cd engine ./mach ...是 shell 调用仓库根目录下能执行python3。执行同步在仓库根目录运行python3 scripts/update_ts_types.py脚本内部按顺序做三件事执行cd engine ./mach ts build ./mach ts update在引擎侧生成/更新类型按上表把engine/tools/types与engine/tools/types/generated中的 12 个.d.ts复制到src/zen/types/向src/zen/types/index.d.ts追加对./zen.d.ts的 reference。如果某个源文件不存在脚本打印File 路径 does not exist.并跳过该文件不会中断整个同步——出现这类输出时先检查engine/是否完整初始化再考虑是否重跑。同步成功时脚本的最后一行输出是Updated TypeScript types.验证同步结果检查 src/zen/types/index.d.ts 末尾存在/// reference types./zen.d.ts /当前仓库中位于第 42 行。检查被复制的生成文件带有引擎生成的标识例如 src/zen/types/lib.gecko.modules.d.ts 开头注释为Content was generated by running mach ts paths.。类型声明在仓库根目录的 tsconfig.json 下工作strict开启、skipLibCheck开启见 tsconfig.json所以.d.ts文件本身不做类型检查重点保证声明本身是最新的即可。可选仓库 package.json 提供了npm run lint实际执行cd engine ./mach lint zen用它确认src/zen/下的代码在最新类型下通过 lint。限制与说明本仓库是补丁/扩展式仓库Firefox 引擎通过 surfer 初始化package.json 中init、download、sync等脚本拉取到engine/不在本仓库内直接提交。没有engine/时mach ts build无从谈起同步必然失败先完成初始化。该脚本不检查index.d.ts是否已有 zen.d.ts 引用追加是无条件的同步操作针对的是你本地的克隆仓库请勿把重复堆叠的 reference 提交上去。生成文件只覆盖上表列出的 9 个lib.gecko.*.d.ts与 3 个手写文件src/zen/types/中其余 Zen 维护的文件如zen.d.ts、lib.gecko.tweaks.d.ts的定制内容不在此脚本的复制范围内。完成以上步骤后src/zen/types与当前引擎的声明保持一致src/zen/下代码里的Ci/Cc/Cu等全局对象类型即为最新。后续若升级引擎npm run sync重新执行本同步即可。【免费下载链接】desktopWelcome to a calmer internet项目地址: https://gitcode.com/GitHub_Trending/desktop70/desktop创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考