From 9f273afcd8661dbfae6e72ae6064d2d1b186353c Mon Sep 17 00:00:00 2001
From: DCloud_LXH <283700113@qq.com>
Date: Mon, 27 Sep 2021 16:39:08 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E5=B0=8F=E7=A8=8B=E5=BA=8F=E6=8F=92?=
 =?UTF-8?q?=E4=BB=B6?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/collocation/_sidebar.md           |   1 +
 docs/collocation/miniprogram-plugin.md | 159 +++++++++++++++++++++++++
 2 files changed, 160 insertions(+)
 create mode 100644 docs/collocation/miniprogram-plugin.md

diff --git a/docs/collocation/_sidebar.md b/docs/collocation/_sidebar.md
index 48ffc6cab..b059a3065 100644
--- a/docs/collocation/_sidebar.md
+++ b/docs/collocation/_sidebar.md
@@ -7,6 +7,7 @@
   * [App.vue](collocation/App.md)
   * [main.js](collocation/main.md)
   * [env](collocation/env.md)
+  * [小程序插件](collocation/miniprogram-plugin.md)
 * 框架接口
   * [日志打印](collocation/frame/log.md)
   * [定时器](collocation/frame/timer.md)
diff --git a/docs/collocation/miniprogram-plugin.md b/docs/collocation/miniprogram-plugin.md
new file mode 100644
index 000000000..38adf2bc8
--- /dev/null
+++ b/docs/collocation/miniprogram-plugin.md
@@ -0,0 +1,159 @@
+### 小程序插件开发
+
+**平台差异说明**
+
+| 微信小程序 | 支付宝小程序 | 百度小程序 | 字节跳动小程序 | QQ 小程序 | 快手小程序 |
+| :--------: | :----------: | :--------: | :------------: | :-------: | :--------: |
+|     √      |       √ ( `3.2.9+` )      |     x      |       x        |     x     |     x      |
+
+**注意**
+
+1. 开发 `微信小程序插件` 时，基础库版本 `1.9.6` 开始支持。（如果插件包含页面，则需要基础库版本 `2.1.0` 。）
+2. 开发 `支付宝小程序插件` 时，IDE 版本要求在 0.60 及以上
+
+#### 插件目录结构
+
+```
+plugin
+├── components               // 插件提供的自定义组件（可以有多个）
+│   ├── hello-component.js
+│   ├── hello-component.json
+│   ├── hello-component.wxml
+│   └── hello-component.wxss
+├── pages
+│   ├── hello-page.js        // 插件提供的页面（可以有多个）
+│   ├── hello-page.json
+│   ├── hello-page.wxml
+│   └── hello-page.wxss
+├── index.js                 // 插件的 js 接口
+└── plugin.json              // 插件配置文件
+```
+
+#### 插件配置文件
+
+> 向第三方小程序开放的所有组件、页面和 js 接口都必须在 plugin.json 中声明
+
+- `mp-weixin`
+
+  ```json
+  {
+  	"publicComponents": {
+  		"hello-component": "components/hello-component"
+  	},
+  	"pages": {
+  		"hello-page": "pages/hello-page"
+  	},
+  	"main": "index.js"
+  }
+  ```
+
+  每个配置的含义如下：
+
+  - `publicComponents`：列出所有向小程序开放的自定义组件。
+  - `pages`：列出所有向小程序开放的页面。
+  - `main`：插件面向第三方小程序的 js 接口。
+
+- `mp-alipay`
+
+  ```json
+  {
+     "publicComponents": {
+       "hello-component": "components/hello-component"
+     },
+     "publicPages": {
+       "hello-pages": "pages/hello-page"
+     },
+     "pages": [
+       "pages/hello-page"
+       "pages/index"
+     ],
+     "main": "index.js"
+  }
+  ```
+
+  每个配置的含义如下：
+
+  - `publicComponents`：列出所有向小程序开放的自定义组件。
+  - `publicPages`：列出所有向小程序开放的页面。
+  - `pages`：列出插件所有页面（包含向小程序开放的以及不向小程序开放的页面）。
+  - `main`：插件面向第三方小程序的 js 接口。
+
+**注意**
+
+1. `mp-weixin` 中的 `pages` 项与 `mp-alipay` 中的 `publicPages` 项作用一致
+2. `mp-alipay` 中供外部使用的页面，需要在 `pages` 中声明，数组类型
+3. 由于两端的格式不一致，可以在 `plugin.json` 中使用[条件编译](https://uniapp.dcloud.io/platform?id=preprocessor)处理
+
+#### 编译步骤
+
+- 安装 cli 最新的 alpha 版或最新的稳定版。截止文章发布时最新版本为：`2.0.0-alpha-32120210809004`。
+- 执行命令行：`yarn dev:mp-weixin -- --plugin test-plugin`。
+- 其中 `test-plugin` 为编译出插件包的名字。 `项目根目录\dist\dev\mp-weixin\test-plugin` 中即是可执行小程序插件代码。
+- `mp-alipay` 平台插件编译后续发布，请留意更新日志。
+
+#### 如何在项目中使用插件
+
+1. 宿主小程序是 `uniapp项目`，在 `manifest.json` 中配置相关信息即可，[详情](https://uniapp.dcloud.io/component/mp-weixin-plugin?id=%e9%85%8d%e7%bd%ae%e5%b0%8f%e7%a8%8b%e5%ba%8f%e6%8f%92%e4%bb%b6)
+2. 宿主为原生小程序，在项目的 `app.json` 中配置即可：
+   - [mp-wixin 配置](https://developers.weixin.qq.com/miniprogram/dev/framework/plugin/using.html)
+   - [mp-alipay 配置](https://opendocs.alipay.com/mini/plugin/plugin-development#app.json%20%E9%BB%98%E8%AE%A4%E9%85%8D%E7%BD%AE)
+
+#### 在插件中使用条件编译
+
+> 有时候项目不仅要编译到插件，也需要作为一个正常的小程序运行，但有些 api 并不适用于两端，此时可以使用自定义条件编译区分开来。
+
+1. 自定义条件编译（[详情](https://uniapp.dcloud.io/collocation/package)），在`package.json`中添加如以下配置：
+
+   ```json
+   "uni-app": {
+     "scripts": {
+       "mp-wx-plugin": {
+         "title": "微信小程序插件",
+         "env": {
+           "UNI_PLATFORM": "mp-weixin"
+         },
+         "define": {
+           "MP-WX-PLUGIN": true
+         }
+       },
+       "mp-ali-plugin": {
+         "title": "阿里小程序插件",
+         "env": {
+           "UNI_PLATFORM": "mp-alipay"
+         },
+         "define": {
+           "MP-ALI-PLUGIN": true
+         }
+       },
+     }
+   }
+   ```
+
+2. 使用条件编译：
+   ```js
+   // #ifdef MP-WX-PLUGIN
+   /**
+    * CODE
+    */
+   // #endif
+   ```
+3. 编译时执行命令：`yarn dev:custom mp-wx-plugin --plugin test-plugin` 即可，可将脚本写入`script`中，每次执行更加简化。
+   ```json
+   {
+   	"dev:mp-wx-plugin": "yarn dev:custom mp-wx-plugin --plugin",
+   	"dev:mp-ali-plugin": "yarn dev:custom mp-ali-plugin --plugin"
+   }
+   ```
+
+**注意**
+
+1. 组件在插件内部未使用，需要在宿主小程序中使用时，要在 main.js 中引入使用一下，否则编译后会丢失未使用插件。例如：
+   ```js
+   import helloList from '.../helloList';
+   Vue.component('hello-list', helloList);
+   ```
+2. 插件中所编写的页面需要在 `pages.json` 中填写。
+3. 如果有多个 `uniapp` 编译的 `插件` 需要运行在同一个小程序中，**不要重名**。
+4. 名称不要有特殊字符，比如 `\`。会用到这个名字来挂载一个方法。
+5. `-` 已经手动替换为 `_` ，其他的特殊字符不要写。
+6. 各家小程序插件对各 `api` 的支持情况不同，具体请查看小程序官方文档的相关描述
-- 
GitLab