minidev 1.1.6 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -213
- package/assets/web-sim/main.js +1 -1
- package/assets/web-sim/simulator/main.js +1 -1
- package/index.d.ts +43 -1
- package/lib/index.js +1 -1
- package/lib/rw_host.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,219 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
# 基本使用
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
````shell
|
|
11
|
-
npm i -g minidev
|
|
12
|
-
````
|
|
13
|
-
|
|
14
|
-
## 工具授权 (真机预览和真机调试都需要)
|
|
15
|
-
|
|
16
|
-
工具首次使用时，建议通过 login 指令完成对工具的授权
|
|
17
|
-
|
|
18
|
-
授权过程需要联网，使用支付宝扫描出现在终端中的二维码即可完成授权
|
|
19
|
-
|
|
20
|
-
````shell
|
|
21
|
-
|
|
22
|
-
minidev login
|
|
23
|
-
|
|
24
|
-
````
|
|
25
|
-
|
|
26
|
-
## 真机预览
|
|
27
|
-
|
|
28
|
-
运行指令以进行真机预览, 需要提供小程序 Appid
|
|
29
|
-
|
|
30
|
-
````shell
|
|
31
|
-
|
|
32
|
-
# 进入小程序项目
|
|
33
|
-
cd /path/to/yourProject
|
|
34
|
-
|
|
35
|
-
# 运行真机预览指令
|
|
36
|
-
minidev preview -a {yourAppId}
|
|
37
|
-
|
|
38
|
-
````
|
|
39
|
-
|
|
40
|
-
指令运行后，默认会直接推送到手机支付宝进行预览
|
|
41
|
-
|
|
42
|
-
如果没有自动推送，指令也会在命令行打印二维码，可以通过扫描二维码进行真机预览
|
|
43
|
-
|
|
44
|
-
### preview 指令支持的参数
|
|
45
|
-
|
|
46
|
-
````shell
|
|
47
|
-
Usage: minidev preview [options]
|
|
48
|
-
|
|
49
|
-
发起真机预览
|
|
50
|
-
|
|
51
|
-
Options:
|
|
52
|
-
-s, --skip-build [可选] 跳过构建过程
|
|
53
|
-
--auto-push [可选] 自动推送到客户端, 默认打开, 使用 --no-auto-push 来关闭 (default: true)
|
|
54
|
-
--ignore-http-domain-check [可选] 忽略 http 请求白名单校验
|
|
55
|
-
--ignore-webview-domain-check [可选] 忽略 webview 加载域名白名单校验
|
|
56
|
-
-a, -appid <appId> [必填] 小程序应用 id
|
|
57
|
-
--bundle-id <bundleId> [可选] <高级> 开放平台 bundleId, 此项会覆盖 clientType 的效果
|
|
58
|
-
-c, --client-type <clientType> [可选] 端类型 (choices: "alipay", "ampe", "amap", "genie", "alios", "alipayiot", "uc",
|
|
59
|
-
"quark", "health", "koubei", "taobao", "cainiao", "alihealth", "OTT_CIBN", "OTT_TAITAN")
|
|
60
|
-
--page <page> [可选] 入口页面
|
|
61
|
-
--page-query <page> [可选] 页面参数, 可在当前页面的 onLoad 中取得，如: name=vendor&color=black
|
|
62
|
-
--query <page> [可选] 全局参数，app.js 的 onLaunch 中取得，如: name=vendor&color=black
|
|
63
|
-
--scene <page> [可选] 进入场景值
|
|
64
|
-
--simulate-update [可选] 模拟更新
|
|
65
|
-
--ampe-device-id <ampeDeviceId> [可选] [AMPE] 设备 ID
|
|
66
|
-
--ampe-host-app-id <ampeHostAppId> [可选] [AMPE] 产品 ID
|
|
67
|
-
--ampe-product-id <ampeProductId> [可选] [AMPE] 移动应用 ID
|
|
68
|
-
--appxv <appxv> [可选] [构建]构建类别，可选值为 v1, v2, legacy-v1 (choices: "v1", "v2", "legacy-v1")
|
|
69
|
-
--cacheDir <cacheDir> [可选] [构建]指定构建缓存路径, 默认为系统缓存路径
|
|
70
|
-
--less [可选] [构建]启用 less 编译
|
|
71
|
-
--typescript [可选] [构建]启用 typescript 编译
|
|
72
|
-
--minify [可选] [构建]是否需要压缩，默认不开
|
|
73
|
-
-o, --output <output> [可选] [构建]产物路径
|
|
74
|
-
--parallel [parallel] [可选] [构建]多进程编译
|
|
75
|
-
--pluginId <pluginId> [可选] [构建]插件 Id，构建插件时将生成到代码中
|
|
76
|
-
--source-map [可选] [构建]是否产出 sourceMap
|
|
77
|
-
-p, --project <project> [可选] [构建]目标项目, 默认为当前工作目录
|
|
78
|
-
--machine-output [可选] [构建]机器可读输出（只显示最终结果）
|
|
79
|
-
````
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
## 真机调试
|
|
83
|
-
|
|
84
|
-
运行指令以进行真机调试, 需要提供小程序 Appid
|
|
85
|
-
|
|
86
|
-
````shell
|
|
87
|
-
|
|
88
|
-
# 进入小程序项目
|
|
89
|
-
cd /path/to/yourProject
|
|
90
|
-
|
|
91
|
-
# 运行真机调试指令
|
|
92
|
-
minidev remote-debug -a {yourAppId}
|
|
93
|
-
|
|
94
|
-
````
|
|
95
|
-
|
|
96
|
-
指令运行后，默认会直接推送到手机支付宝进行真机调试
|
|
97
|
-
|
|
98
|
-
如果没有自动推送，指令也会在命令行打印二维码，可以通过扫描二维码的方式来继续
|
|
99
|
-
|
|
100
|
-
**真机调试指令会在命令行打印真机预览调试器的本地服务地址，请使用本机浏览器打开对应网址进行调试**
|
|
101
|
-
|
|
102
|
-
### 支持的参数
|
|
103
|
-
````shell
|
|
104
|
-
Usage: minidev remote-debug [options]
|
|
105
|
-
|
|
106
|
-
发起真机调试
|
|
107
|
-
|
|
108
|
-
Options:
|
|
109
|
-
--auto-push [可选] 自动推送到客户端, 默认打开, 使用 --no-auto-push 来关闭 (default: true)
|
|
110
|
-
--ignore-http-domain-check [可选] 忽略 http 请求白名单校验
|
|
111
|
-
--ignore-webview-domain-check [可选] 忽略 webview 加载域名白名单校验
|
|
112
|
-
-a, -appid <appId> [必填] 小程序应用 id
|
|
113
|
-
--bundle-id <bundleId> [可选] <高级> 开放平台 bundleId, 此项会覆盖 clientType 的效果
|
|
114
|
-
-c, --client-type <clientType> [可选] 端类型 (choices: "alipay", "ampe", "amap", "genie", "alios", "alipayiot", "uc",
|
|
115
|
-
"quark", "health", "koubei", "taobao", "cainiao", "alihealth", "OTT_CIBN", "OTT_TAITAN")
|
|
116
|
-
--page <page> [可选] 入口页面
|
|
117
|
-
--page-query <page> [可选] 页面参数, 可在当前页面的 onLoad 中取得，如: name=vendor&color=black
|
|
118
|
-
--query <page> [可选] 全局参数，app.js 的 onLaunch 中取得，如: name=vendor&color=black
|
|
119
|
-
--scene <page> [可选] 进入场景值
|
|
120
|
-
--simulate-update [可选] 模拟更新
|
|
121
|
-
--ampe-device-id <ampeDeviceId> [可选] [AMPE] 设备 ID
|
|
122
|
-
--ampe-host-app-id <ampeHostAppId> [可选] [AMPE] 产品 ID
|
|
123
|
-
--ampe-product-id <ampeProductId> [可选] [AMPE] 移动应用 ID
|
|
124
|
-
--appxv <appxv> [可选] [构建]构建类别，可选值为 v1, v2, legacy-v1 (choices: "v1", "v2", "legacy-v1")
|
|
125
|
-
--cacheDir <cacheDir> [可选] [构建]指定构建缓存路径, 默认为系统缓存路径
|
|
126
|
-
--less [可选] [构建]启用 less 编译
|
|
127
|
-
--typescript [可选] [构建]启用 typescript 编译
|
|
128
|
-
--minify [可选] [构建]是否需要压缩，默认不开
|
|
129
|
-
-o, --output <output> [可选] [构建]产物路径
|
|
130
|
-
--parallel [parallel] [可选] [构建]多进程编译
|
|
131
|
-
--pluginId <pluginId> [可选] [构建]插件 Id，构建插件时将生成到代码中
|
|
132
|
-
--source-map [可选] [构建]是否产出 sourceMap
|
|
133
|
-
-p, --project <project> [可选] [构建]目标项目, 默认为当前工作目录
|
|
134
|
-
--machine-output [可选] [构建]机器可读输出（只显示最终结果）
|
|
135
|
-
````
|
|
136
|
-
|
|
137
|
-
## 上传小程序
|
|
138
|
-
|
|
139
|
-
运行指令以进行小程序上传
|
|
140
|
-
|
|
141
|
-
````shell
|
|
142
|
-
|
|
143
|
-
# 进入小程序项目
|
|
144
|
-
cd /path/to/yourProject
|
|
145
|
-
|
|
146
|
-
# 运行上传指令
|
|
147
|
-
minidev upload -a {yourAppId}
|
|
148
|
-
|
|
149
|
-
````
|
|
150
|
-
|
|
151
|
-
如果需要上传完成后直接设置为体验版, 可以在运行时添加 `--experience` 参数
|
|
152
|
-
|
|
153
|
-
### 支持的参数
|
|
154
|
-
````shell
|
|
155
|
-
Usage: minidev upload [options]
|
|
156
|
-
|
|
157
|
-
上传发布小程序
|
|
158
|
-
|
|
159
|
-
Options:
|
|
160
|
-
-e, --experience [可选] 上传成功后，自动设置为体验版本 (需要对应权限)
|
|
161
|
-
-v, --version [version] [可选] 上传包版本
|
|
162
|
-
-p, --project <project> [可选] 目标项目, 默认为当前工作目录
|
|
163
|
-
-a, -appid <appId> [必填] 小程序应用 id
|
|
164
|
-
--bundle-id <bundleId> [可选] <高级> 开放平台 bundleId, 此项会覆盖 clientType 的效果
|
|
165
|
-
-c, --client-type <clientType> [可选] 端类型 (choices: "alipay", "ampe", "amap", "genie", "alios", "alipayiot", "uc",
|
|
166
|
-
"quark", "health", "koubei", "taobao", "cainiao", "alihealth", "OTT_CIBN", "OTT_TAITAN")
|
|
167
|
-
--machine-output [可选] 机器可读输出（只显示最终结果）
|
|
168
|
-
````
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
## 启动 devServer
|
|
172
|
-
|
|
173
|
-
启动 devServer 以在启动开发模式，生成的小程序会响应小程序代码的实时变化
|
|
174
|
-
|
|
175
|
-
````shell
|
|
176
|
-
|
|
177
|
-
cd /path/to/yourProject
|
|
178
|
-
minidev dev
|
|
179
|
-
|
|
180
|
-
````
|
|
181
|
-
|
|
182
|
-
devServer 启动之后，可以继续键入指令来利用 devServer 的产物进行进一步操作
|
|
183
|
-
|
|
184
|
-
````shell
|
|
185
|
-
|
|
186
|
-
可以继续执行以下命令 (可以通过 指令名 -h 来查看参数)
|
|
187
|
-
|
|
188
|
-
- preview : 使用模拟器产物发起真机预览 （此模式仅整包, 无法验证分包可用性）
|
|
189
|
-
- remote-debug : 使用模拟器产物发起真机调试 （此模式仅整包）
|
|
190
|
-
- ide : 启动小程序开发者工具模拟器进行调试
|
|
191
|
-
|
|
192
|
-
````
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
## Node JS API 调用
|
|
196
|
-
|
|
197
|
-
除了 cli 的使用方式外， minidev 也提供了 js api 的调用方式, 上述对应的指令都能找到相应的 js api 调用方式。
|
|
198
|
-
|
|
199
|
-
示例：
|
|
200
|
-
|
|
201
|
-
````typescript
|
|
202
|
-
|
|
203
|
-
const { minidev } = require('minidev');
|
|
204
|
-
|
|
205
|
-
minidev.preview({
|
|
206
|
-
appId:'2021xxxxxxxxx9999', // 传入 appId
|
|
207
|
-
|
|
208
|
-
project: 'path/to/project' // 小程序项目路径
|
|
209
|
-
}).then(({qrcodeUrl}) => {
|
|
210
|
-
|
|
211
|
-
// qrcodeUrl为二维码图片地址, 可以进行进一步的展示
|
|
212
|
-
console.log(qrcodeUrl);
|
|
213
|
-
|
|
214
|
-
});
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
````
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
8
|
+
请参阅我们官方网站的[在线文档](https://opendocs.alipay.com/mini/02q17h)
|
|
221
9
|
|
|
222
10
|
# 问题反馈
|
|
223
11
|
|