跳到正文

命令与环境变量 ​

命令作用
wxa-runner dev <项目目录>启动开发服务器,在浏览器里运行小程序,改动后热更新
wxa-runner baselib list列出可用的基础库及兼容性
wxa-runner baselib extract [版本]解包基础库(dev 会自动执行)

没装成开发依赖时在前面加 npx,如 npx wxa-runner dev .。

wxa-runner dev ​

bash
wxa-runner dev <项目目录> [选项]

<项目目录> 是小程序目录:原生项目的 project.config.json 所在目录,或 uni-app、Taro 等框架编译出的 mp-weixin 目录。

选项默认值作用
-p, --port <端口>3000端口号
--host <地址>localhost监听地址
-b, --baselib <版本>最新的兼容版本基础库版本,见 wxa-runner baselib
--setup <文件>自动查找小程序启动前执行的 setup 文件,路径相对当前目录。不指定时使用项目目录下的 wxa.setup.ts / .js / .mjs
--no-setup不执行 setup 文件
--no-watch不监听文件变化、不热更新,运行环境与真机一致。跑测试时用
-o, --open启动后打开浏览器
--real-login用本机开发者工具的登录态获取真实的 wx.login code 和手机号,见真实登录

常见用法:

bash
# 原生小程序,启动后打开浏览器
wxa-runner dev . --open

# uni-app:先运行 uni-app 的监听构建,再启动编译产物;setup 文件放在源码目录
wxa-runner dev ./dist/dev/mp-weixin --setup ./wxa.setup.ts

# 用指定的基础库版本
wxa-runner dev . --baselib 3.5.8

# 给测试用:不热更新,端口固定
wxa-runner dev . --no-watch --port 3000

地址带上 ?path= 直接打开指定页面,其余参数作为页面参数:http://localhost:3000/?path=pages/detail/detail&id=1。

wxa-runner baselib ​

命令作用
wxa-runner baselib list列出可用的基础库:本机开发者工具下载过的和内置的,标出默认使用的版本
wxa-runner baselib extract [版本]解包基础库到 ~/.wxa-runner/baselib,输出所在目录。内置基础库不用解包,直接输出所在目录

基础库的来源和版本:

  • 本机微信开发者工具下载过的版本优先;没有时用随依赖安装的内置基础库 3.7.0(wxa-baselib)
  • 不指定版本时选最新的兼容版本(≤ 3.7.0)
  • 3.7.1 起的版本要用 --baselib 或 WXA_BASELIB 指定,启动时提示超出已验证的范围;内置基础库只有 3.7.0,新版本要先在开发者工具里下载

环境变量 ​

变量作用
WXA_BASELIB没有用 --baselib 指定时使用的基础库版本
WXA_DEVTOOLS_PATH开发者工具不在默认位置时,指定安装目录(如 macOS 上的 .app 目录),新旧版本都可以
WXA_VENDOR_DIR指定基础库目录(开发者工具的 WeappVendor)
WXA_WCC / WXA_WCSC直接指定 WXML / WXSS 编译器,优先于开发者工具和 miniprogram-compiler
WECHAT_DEV_TICKET--real-login 使用的开发者 ticket,优先于开发者工具的登录态
WECHAT_DEVTOOLS_CLI_TOKEN开发者工具设置了「CLI 访问令牌」时设成它:--real-login 调用的开发者工具命令行从这里读取令牌
WXA_*所有 WXA_ 开头的变量都传给 setup 文件,见 setup 的环境变量

基于 MIT 许可发布。内置基础库是微信官方代码,版权归腾讯所有