WXT项目中解决Sizzle选择器在Node环境报错的方案

背景介绍

在开发浏览器扩展时，我们经常需要在内容脚本(content script)中操作DOM元素。WXT作为一个现代化的浏览器扩展开发框架，提供了便捷的开发体验。然而，当开发者尝试在WXT项目中使用Sizzle这样的DOM选择器库时，可能会遇到"window is not defined"的错误。

问题本质

这个问题的根源在于模块加载的环境差异。Sizzle是一个专门为浏览器环境设计的DOM操作库，它依赖于浏览器提供的window对象。而在WXT项目的构建过程中，代码可能会先在Node.js环境下被处理，这时window对象并不存在，导致报错。

解决方案

1. 使用WXT的内容脚本定义方式

WXT框架提供了defineContentScript方法来定义内容脚本，这是推荐的做法。在这种方式下，代码会被正确地注入到浏览器环境中执行：

export default defineContentScript({
  matches: ['*://*/*'],
  main() {
    // 这里的代码会在浏览器环境中执行
    const elements = document.querySelectorAll('.my-class');
    console.log(elements);
  }
});

2. 避免在模块顶层使用浏览器API

如果确实需要使用Sizzle等浏览器专用库，应该确保它们只在浏览器环境中被调用。可以将相关代码放在函数内部或生命周期钩子中：

export function cssSelector(selector: string, documentCtx: Document) {
  // 动态导入确保只在需要时加载
  const Sizzle = require('sizzle');
  return Sizzle(selector, documentCtx);
}

3. 使用环境判断

对于需要在不同环境中运行的代码，可以添加环境判断：

if (typeof window !== 'undefined') {
  // 浏览器环境代码
  const Sizzle = require('sizzle');
  // 使用Sizzle...
}

最佳实践建议

1. 优先使用原生DOM API：现代浏览器已经提供了强大的选择器API(querySelector, querySelectorAll等)，大多数情况下不需要额外引入Sizzle。

2. 理解WXT的执行环境：WXT项目中的代码会在多个环境中执行，包括构建时(Node环境)和运行时(浏览器环境)。

3. 模块设计原则：保持模块的纯净性，避免在模块顶层执行有环境依赖的代码。

4. 利用WXT的架构优势：WXT已经为浏览器扩展开发做了很多优化，遵循其推荐模式可以避免很多环境相关的问题。

总结

在WXT项目开发中遇到"window is not defined"错误时，开发者应该首先考虑代码执行的环境上下文。通过遵循WXT的内容脚本定义规范、合理安排代码执行时机，以及必要时进行环境判断，可以有效地解决这类问题。理解浏览器扩展开发特有的环境差异，是成为高效扩展开发者的关键一步。