minidev 1.0.3 → 1.0.7

package/assets/web-sim/simulator/main.js.LICENSE.txt

@@ -0,0 +1,67 @@
+/*
+object-assign
+(c) Sindre Sorhus
+@license MIT
+*/
+
+/*!
+ * Determine if an object is a Buffer
+ *
+ * @author   Feross Aboukhadijeh <https://feross.org>
+ * @license  MIT
+ */
+
+/*!
+ * mime-db
+ * Copyright(c) 2014 Jonathan Ong
+ * MIT Licensed
+ */
+
+/*!
+ * mime-types
+ * Copyright(c) 2014 Jonathan Ong
+ * Copyright(c) 2015 Douglas Christopher Wilson
+ * MIT Licensed
+ */
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+/** @license React v0.19.1
+ * scheduler.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/** @license React v16.14.0
+ * react-dom.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/** @license React v16.14.0
+ * react.production.min.js
+ *
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */

package/docs/guide/base/cli.md

@@ -0,0 +1,37 @@
+# CLI 风格使用
+
+支付宝小程序 CLI 最常见的使用方式是使用 CLI 风格进行调用，和对应的指令集使用方式可以通过 `-h` 参数打开帮助信息，也可以参照[指令列表](../commands/index.md)中的对应指令文档了解详细使用方式
+
+````
+Usage: minidev [options] [command]
+
+小程序开发 CLI 工具
+
+Options:
+  -v, --vers                   输出当前版本
+  -h, --help                   display help for command
+
+Commands:
+  build [options]              构建编译小程序
+  clean-build-cache [options]  清除构建缓存
+  dev [options]                启动开发服务器 DevServer
+  preview [options]            发起真机预览
+  login [options]              进行工具授权
+  remote-debug [options]       发起真机调试
+  pack [options]               打包源码
+  upload [options]             上传发布小程序
+  ide [options]                启动IDE
+  download-assets [options]    下载离线资源包
+  config                       设置管理
+  help [command]               display help for command
+````
+
+## 指定项目目录
+
+默认时 minidev 指令会以当前目录 (`cwd`) 作为小程序项目的根目录来处理小程序相关逻辑，但是当有必要时，和小程序项目有关的指令可以通过添加 `-p` 参数不切换 `cwd` 来指定小程序项目的目录
+
+````shell
+minidev build -p /path/to/your/mini-program
+````
+
+

package/docs/guide/base/node-js-api.md

@@ -0,0 +1,31 @@
+---
+slug: node-js-api
+title: Node.JS API 风格使用
+---
+
+# Node.JS API 风格使用
+
+支付宝小程序 CLI (`minidev`) 同时支持 Node.js API 风格进行调用，以便于集成入不同的流程中，更加灵活便捷。
+
+#### 示例
+
+````javascript
+
+const { minidev } = require('minidev');
+
+minidev.preview({
+  appId:'2021xxxxxxxxx9999', // 传入 appId
+  
+  project: 'path/to/project' // 小程序项目路径
+}).then(({qrcodeUrl}) => {
+  
+  // qrcodeUrl为二维码图片地址, 可以进行进一步的展示
+  console.log(qrcodeUrl);
+
+});
+
+````
+
+## CLI 指令与 Node.js API
+
+各个指令都拥有对应的 Node.js API，具体调用方式请参照[指令列表](../commands/index.md)中的对应指令文档了解。

package/docs/guide/base/quick-start.md

@@ -0,0 +1,135 @@
+---
+slug: quick-start
+title: 快速开始
+---
+
+
+# 快速开始
+
+## 安装
+
+首先安装 minidev 至您的系统中。为此，您的系统必须首先安装 node 运行环境 (前往 [node 官网](https://nodejs.org) 进行安装 )， minidev 需要 **node 版本 >= 10** 的运行环境。
+
+确认 node 环境之后，可以在命令行工具中执行以下指令进行安装
+
+````shell
+npm i -g minidev
+````
+
+> 安装过程会存在资源下载过程（调试器、模拟器类的资源），请保持网络畅通
+
+## 对工具进行授权
+
+minidev 中许多指令（如真机预览 `preview`、真机调试 `remote-debug`等）都需要与支付宝服务器进行可信通信，因此在执行上述指令前，我们需要首先对工具完成授权。
+
+在命令行中执行以下指令来对当前电脑进行授权
+
+````shell
+minidev login
+````
+
+执行后，终端界面会出现授权二维码，**在二维码过期前**使用手机支付宝钱包 app 进行扫码，即可完成授权
+
+
+## 进行本地开发
+
+使用命令行切换工作目录到小程序项目后，可以使用本地开发命令进行诸多开发操作
+
+> 新建小程序项目方式，以及小程序项目的相关信息可以查阅[支付宝小程序文档站](https://opendocs.alipay.com/mini/006kyi)
+
+### 运行开发服务器 (DevServer)
+
+在命令行工具中执行以下指令来将工作目录移动到小程序项目，并启动开发服务器 Dev Server。
+
+````shell
+cd /path/to/project
+minidev dev
+````
+
+启动后小程序将进行构建，构建时间根据项目规模而定，一般在 3 ~ 30s 不等。
+
+首次编译完成后，终端中将显示如下图的信息
+
+![](https://intranetproxy.alipay.com/skylark/lark/0/2021/png/111910/1638340227186-d583d721-9a39-4c9e-bd3f-446b183f927e.png?x-oss-process=image%2Fresize%2Cw_1500%2Climit_0)
+
+> 开发服务器 DevServer 会在每次改变小程序源码文件时进行重新构建
+
+#### 启动 web 模拟器和调试器
+
+在上述启动开发服务器后，继续在命令行中输入 web 指令，便可以打开 web 版本的模拟器和调试器
+
+````shell
+
+#-  preview : 使用模拟器产物发起真机预览 （此模式仅整包, 无法验证分包可用性）
+#-  remote-debug : 使用模拟器产物发起真机调试 （此模式仅整包）
+#-  ide : 启动小程序开发者工具模拟器进行调试
+#-  web : 启动 Web 模拟器（本地）
+
+# 在 devServer 启动完成后，输入 web 后回车
+
+web
+
+````
+
+启动后的模拟器和调试器如下：
+
+![](https://intranetproxy.alipay.com/skylark/lark/0/2021/png/111910/1638340616562-5a131cc0-dc80-44af-9df2-1e9ba9e58d1a.png?x-oss-process=image%2Fresize%2Cw_1500%2Climit_0)
+
+
+之后便可以在这个 web 版本的模拟器和调试器中进行小程序的运行和调试。
+
+
+### 发起真机预览
+
+在小程序项目目录运行如下指令可以对小程序进行真机预览
+
+````shell
+# $YourAppId 请使用你的小程序 appid 进行替换
+minidev preview -a $YourAppId
+
+# 填写 appid 后的示例
+# minidev preview -a 2021123412341234
+````
+
+> 为进行真机预览、真机调试等操作，你必须首先拥有一个 appid，小程序 appid 的创建和申请流程可以按照[支付宝相关文档](https://opendocs.alipay.com/mini/introduce/create)进行操作
+
+运行后，将会对小程序进行构建然后推送到支付宝小程序开放平台生成手机支付宝钱包可用的小程序，并在终端中显示预览二维码如下(示例)
+
+````
+✔ 生成预览码成功
+二维码图片地址 xxxxxxxx
+Schema Url xxxxxxxxxx
+----------------------------------------------------------------------------------------------------
+[               ]
+[               ]
+[   二维码图片    ]
+[               ]
+[               ]
+
+
+````
+
+此时用手机支付宝钱包扫描二维码图片即可进行真机预览。
+
+> 真机预览过程存在和服务器通信，请保证网络畅通
+
+## 上传提审小程序
+
+当小程序开发完毕准备[发布](https://opendocs.alipay.com/mini/introduce/release)时,
+
+使用如下命令可对小程序进行[上传提审](https://opendocs.alipay.com/mini/introduce/release#%E4%B8%8A%E4%BC%A0%E5%B0%8F%E7%A8%8B%E5%BA%8F)
+
+````
+minidev upload -a $YourAppId
+````
+
+小程序将会在开放平台进行构建，由于生产环境的管控和稳定性要求，此构建过程可能会花费比本地开发更多的时间，请耐心等待。
+
+
+## 更多
+
+以上便是 minidev 的基础用法，更多使用文档和建议，可以参照更多文档：
+
+* [CLI 使用](./cli.md)
+* [JS API 使用](./node-js-api.md)
+* [指令列表](../commands/index.md)

package/docs/guide/commands/build.md

@@ -0,0 +1,103 @@
+# build
+
+## 用途
+
+由小程序源码构建小程序，生成小程序运行时产物包
+
+## CLI 调用方法
+
+````shell
+Usage: minidev build [options]
+
+构建编译小程序
+
+Options:
+  --appxv <appxv>          [可选] 构建类别，可选值为 v1, v2, legacy-v1 (choices: "v1", "v2", "legacy-v1")
+  --cacheDir <cacheDir>    [可选] 指定构建缓存路径, 默认为系统缓存路径
+  --minify                 [可选] 是否需要压缩，默认不开
+  -o, --output <output>    [可选] 产物路径
+  --pluginId <pluginId>    [可选] 插件 Id，构建插件时将生成到代码中
+  --source-map             [可选] 是否产出 sourceMap (default: true)
+  -p, --project <project>  [可选] 目标项目, 默认为当前工作目录
+````
+## Node.js API 调用方法
+
+
+````javascript 
+
+const buildResult = await minidev.build({
+  project: 'path/to/mini-program'
+})
+
+// 输出产物目录
+console.log(buildResult.dist);
+
+````
+
+## 参数说明
+
+### project
+
+指定构建的小程序项目位置，请指向[小程序项目配置文件（mini.project.json）](https://opendocs.alipay.com/mini/framework/project)所在的目录
+
+### appxv
+
+````Typescript 
+appx: 'v1' | 'v2' | 'legacy-v1'
+````
+
+强制指定使用的[基础库](https://opendocs.alipay.com/mini/framework/lib)构建模式, 如果不指定会根据[小程序项目配置文件（mini.project.json）](https://opendocs.alipay.com/mini/framework/project)中的相关字段来自动判断
+
+可选值
+
+* `v1`:  构建使用小程序基础库 1.x 进行运行的小程序
+* `v2`:  构建使用小程序基础库 2.x 进行运行的小程序
+* `legacy-v1`: 使用旧构建器构建小程序基础库 1.x（不推荐）
+
+### cacheDir
+
+````Typescript 
+cacheDir: string
+````
+
+指定构建缓存路径, 默认为系统缓存路径
+
+默认缓存路径位于：
+
+* `MacOS/Linux` $TMPDIR/minicode_compile_dy/.cache
+* `Windows`: C:\\User\\你的用户名\\AppData\\Local\\Temp\\minicode_compile_dy/.cache 
+
+### minify
+
+````Typescript 
+minify: boolean
+````
+
+是否需要压缩产物，默认不会对产物进行压缩（压缩会耗费额外的时间）
+
+### output
+
+````Typescript 
+output: string
+````
+
+产物包的输出路径
+
+如果不提供输出路径，默认会在以下文件夹创建随机名称的文件夹作为产物路径：
+
+* `MacOS/Linux` $TMPDIR/minicode_compile_dy
+* `Windows`: C:\\User\\你的用户名\\AppData\\Local\\Temp\\minicode_compile_dy
+
+
+### sourceMap
+
+````Typescript 
+sourceMap: boolean
+````
+
+是否对构建产物生成源代码映射，默认开启。
+
+关闭源码映射会加快构建速度，但会影响运行时的调试和错误收集能力。
+
+
+

package/docs/guide/commands/config.md

@@ -0,0 +1,79 @@
+# config 
+
+## 用途
+
+用于设置和展示当前的配置信息, 拥有两个基础指令
+
+- `set` 设置配置值
+- `get` 获取配置值
+
+## CLI 风格使用
+
+````shell
+Usage: minidev config set [options] <configName> <value>
+
+设置配置
+
+Arguments:
+  configName               设置名称
+  value                    设置值
+
+Options:
+  --scope                  [可选] 设置范围, global 为全局设置， project 为项目设置 (choices: "global", "project")
+  -p, --project <project>  [可选] 目标项目, 默认为当前工作目录
+````
+
+````shell
+Usage: minidev config get [options] <configName>
+
+显示配置项
+
+Arguments:
+  configName               设置名称
+
+Options:
+  --scope                  [可选] 设置范围, global 为全局设置， project 为项目设置 (choices: "global", "project")
+  -p, --project <project>  [可选] 目标项目, 默认为当前工作目录
+````
+
+## Node.js API 风格使用
+
+````javascript
+
+import { minidev, ConfigScope } from 'minidev'
+
+// 例: 获取当前小程序编译器版本
+const configValue = await minidev.config.get('compiler.version');
+
+// 例: 设置指定项目下的使用的 ide 路径
+await minidev.config.set('ide.appPath', 'path/to/idePath', {
+  scope: ConfigScope.PROJECT,
+  project: '/path/to/project',
+});
+
+// JS API 下可以使用 useRuntime 方法指定 runtime 配置
+// 例： 注入运行时授权信息
+await minidev.config.useRuntime({
+  'alipay.authentication.privateKey': 'xxxxxxxxxx',
+  'alipay.authentication.toolId': 'xxxxxxxxxx',
+})
+
+````
+
+## 参数说明
+
+### scope
+
+设置范围, 支持值 global, project。详见 [minidev配置](../../guide/experiences/config.md)
+
+- `global` 全局设置
+- `project` 项目配置
+
+### project
+
+目标项目，默认为当前工作目录。当 set 或者 get 的 scope 为 project 或 空时生效
+
+### 注意事项
+
+- 当使用 set 时，如果不传入 scope， 则默认 scope 为 `global`, 即更改的是全局配置
+- 当使用 get 时，如果不传入 scope， 则默认 scope 为 `runtime`, 即获取的是最终生效的配置

package/docs/guide/commands/dev-daemon-commands/ide.md

@@ -0,0 +1,70 @@
+---
+slug: dev-ide
+---
+# ide
+
+## 用途
+
+启动开发服务器 Dev Server 之后，使用 IDE 对小程序进行模拟器调试、真机预览等操作
+
+## CLI 风格使用 
+
+````shell
+# minidev dev 运行之后
+# 界面会显示 
+
+# 可以继续执行以下命令 (可以通过 指令名 -h 来查看参数)
+
+# -  preview : 使用模拟器产物发起真机预览 （此模式仅整包, 无法验证分包可用性）
+# -  remote-debug : 使用模拟器产物发起真机调试 （此模式仅整包）
+# -  ide : 启动小程序开发者工具模拟器进行调试
+# -  web : 启动 Web 模拟器（本地）
+
+# 此时输入 
+
+ide 
+
+````
+
+可以添加的参数
+
+````
+Options:
+  --app-path               [可选] IDE 安装路径 
+   示例：MacOS:  /Applications/小程序开发者工具.app 
+   Windows: C:\Program Files\小程序开发者工具 
+  --lite                   [可选] 使用 Lite 模式启动 IDE
+  --project-type           [可选] 项目类型
+
+````
+
+## Node.js API 风格使用
+
+````javascript
+
+// 调用前必须先有 devServer
+// const devServerBuild = await minidev.dev({project: 'path/to/project'});
+
+devServerBuild.devServer.once('done', () => {
+  // devServer 构建完成后启动 ide
+  minidev.startIdeForDevServer({
+    lite: true
+  }, devServerBuild);
+});
+
+````
+
+## 参数说明
+
+
+### appPath
+
+IDE 的安装路径，详见 [IDE指令](../../../guide/commands/ide.md) 同名参数
+
+### projectType
+
+IDE 打开时指定的项目类型，详见 [IDE指令](../../../guide/commands/ide.md) 同名参数
+
+### lite
+
+是否使用 [Lite 模式](https://opendocs.alipay.com/mini/ide/idelite) 启动 IDE，此场景下默认为 true

package/docs/guide/commands/dev-daemon-commands/preview.md

@@ -0,0 +1,54 @@
+---
+slug: dev-preview
+---
+# preview
+
+## 用途
+
+启动开发服务器 Dev Server 之后，基于模拟器的产物进行快速真机预览
+
+此过程由于基于了模拟器的产物, 因此无需进行重新构建，从而有更快的预览速度。
+
+> 快速真机预览只会开启整包，无法验证分包功能的可用性。如需要运行分包真机预览，请使用 [preview 指令](../../../guide/commands/preview.md);
+
+> 使用该指令要求工具进行[授权](../../../guide/experiences/auth.md)
+
+## CLI 风格使用 
+
+````shell
+# minidev dev 运行之后
+# 界面会显示 
+
+# 可以继续执行以下命令 (可以通过 指令名 -h 来查看参数)
+
+# -  preview : 使用模拟器产物发起真机预览 （此模式仅整包, 无法验证分包可用性）
+# -  remote-debug : 使用模拟器产物发起真机调试 （此模式仅整包）
+# -  ide : 启动小程序开发者工具模拟器进行调试
+# -  web : 启动 Web 模拟器（本地）
+
+# 此时输入 
+
+preview
+
+````
+
+## Node.js API 风格使用
+
+````javascript
+
+// 调用前必须先有 devServer
+// const devServerBuild = await minidev.dev({project: 'path/to/project'});
+
+devServerBuild.devServer.once('done', () => {
+  // devServer 构建完成后发起真机预览
+  minidev.devPreview({
+    appId: 'YourAppId'
+  }, devServerBuild);
+});
+
+````
+
+
+## 参数说明
+
+参见 [preview 指令](../../../guide/commands/preview.md); 

package/docs/guide/commands/dev-daemon-commands/remote-debug.md

@@ -0,0 +1,63 @@
+---
+slug: dev-debug
+---
+# remote-debug
+## 用途
+
+启动开发服务器 Dev Server 之后，基于模拟器的产物进行快速真机调试
+
+此过程由于基于了模拟器的产物, 因此无需进行重新构建，从而有更快的速度。
+
+> 快速真机调试只会开启整包，无法验证分包功能的可用性。如需要运行分包真机调试，请使用 [remote-debug 指令](../../../guide/commands/remote-debug.md);
+
+> 使用该指令要求工具进行[授权](../../../guide/experiences/auth.md)
+
+## CLI 风格使用 
+
+````shell
+# minidev dev 运行之后
+# 界面会显示 
+
+# 可以继续执行以下命令 (可以通过 指令名 -h 来查看参数)
+
+# -  preview : 使用模拟器产物发起真机预览 （此模式仅整包, 无法验证分包可用性）
+# -  remote-debug : 使用模拟器产物发起真机调试 （此模式仅整包）
+# -  ide : 启动小程序开发者工具模拟器进行调试
+# -  web : 启动 Web 模拟器（本地）
+
+# 此时输入 
+
+remote
+
+````
+
+## Node.js API 风格使用
+
+````javascript
+
+// 调用前必须先有 devServer
+// const devServerBuild = await minidev.dev({project: 'path/to/project'});
+
+devServerBuild.devServer.once('done', async () => {
+  
+  // devServer 构建完成后发起真机调试
+  const { 
+    qrcodeSchema, 
+    qrcodeUrl, 
+    debugUrl 
+    } = await minidev.devRemoteDebug({
+    appId: 'YourAppId'
+  }, devServerBuild);
+
+  console.log(qrcodeUrl);
+
+  console.log(debugUrl );
+
+});
+
+````
+
+
+## 参数说明
+
+参见 [remote-debug 指令](../../../guide/commands/remote-debug.md);