# wxa-runner

> 在浏览器里用微信官方基础库运行微信小程序，用于本地调试和 E2E 自动化测试

wxa-runner 直接运行小程序的编译产物（原生小程序，或 uni-app、Taro 编译出的 mp-weixin 目录），
渲染、组件、生命周期都是微信官方基础库的代码。可以用 Chrome DevTools 调试，用 Playwright 写无头 E2E 测试，
在 setup 文件里预置登录态、mock 原生 API、拦截 wx.request。

- 启动：`npx wxa-runner dev <小程序目录>`
- Playwright 测试：`@open-wxa/wxa-runner-playwright`，提供 `miniProgram` fixture
- setup 文件的类型：`@open-wxa/wxa-runner-core/setup`
- 源码：https://github.com/open-wxa/wxa-runner

## Table of Contents

### 开始

- [快速开始](https://open-wxa.github.io/wxa-runner/getting-started.md): 一行命令在浏览器里运行微信小程序：原生小程序、uni-app、Taro 编译产物的启动方式，以及怎么用 Chrome DevTools 打断点、看请求、看页面结构。
- [功能与限制](https://open-wxa.github.io/wxa-runner/features.md): wxa-runner 和微信开发者工具的区别，支持的项目类型、组件和 API，已验证的基础库版本，以及插件、蓝牙等已知限制。

### 使用

- [启动前准备（setup）](https://open-wxa.github.io/wxa-runner/setup.md): 用 wxa.setup.ts 在小程序启动前预置 Storage、mock wx.login 等原生 API、拦截 wx.request，跳过登录。从最小示例开始，按场景给出写法，并说明每个配置项。
- [真实登录](https://open-wxa.github.io/wxa-runner/real-login.md): 用 --real-login 借本机微信开发者工具的登录态，在浏览器里拿到真实的 wx.login code 和手机号，以及新版开发者工具需要打开的安全设置。
- [热更新](https://open-wxa.github.io/wxa-runner/hot-reload.md): wxa-runner 的热更新：修改 WXSS、WXML 和页面、组件的 JS 后不刷新页面，data、页面栈和 globalData 尽量保留；其他改动整页刷新并恢复页面栈。
- [在 Playwright 中测试](https://open-wxa.github.io/wxa-runner/testing.md): 用 Playwright 给微信小程序写 E2E 测试：安装 @open-wxa/wxa-runner-playwright，打开页面、点击、断言页面 data，mock 原生 API、拦截和断言 wx.request。

### 参考

- [命令与环境变量](https://open-wxa.github.io/wxa-runner/cli.md): wxa-runner 命令行：dev 启动开发服务器的选项（端口、基础库版本、setup、真实登录），baselib 管理基础库，以及 WXA_BASELIB 等环境变量。
- [测试 API](https://open-wxa.github.io/wxa-runner/test-api.md): 小程序页面上的 window.__wxa_test_api__：不用 Playwright fixture 时，直接用它读取页面 data、mock 原生 API、拦截和记录 wx.request、跳转页面。