From 1c53b27726ff9f1841deaab9d00d03b478541542 Mon Sep 17 00:00:00 2001 From: hbcui1984 Date: Wed, 7 Aug 2019 17:59:42 +0800 Subject: [PATCH] =?UTF-8?q?=E6=96=B0=E5=A2=9Epackage.json=20->=20=E9=92=89?= =?UTF-8?q?=E9=92=89=E5=B0=8F=E7=A8=8B=E5=BA=8F=E7=A4=BA=E4=BE=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/collocation/_sidebar.md | 2 +- docs/collocation/package.md | 74 +++++++++++++++++++++++++++++++++--- 2 files changed, 70 insertions(+), 6 deletions(-) diff --git a/docs/collocation/_sidebar.md b/docs/collocation/_sidebar.md index 6b587ae7e..d2318a6a8 100644 --- a/docs/collocation/_sidebar.md +++ b/docs/collocation/_sidebar.md @@ -1,7 +1,7 @@ * 配置 * [pages.json](collocation/pages.md) * [manifest.json](collocation/manifest.md) - * [package](collocation/package.md) + * [package.json](collocation/package.md) * [vue-config.js](collocation/vue-config.md) * [uni.scss](collocation/uni-scss.md) * 框架接口 diff --git a/docs/collocation/package.md b/docs/collocation/package.md index bd613f5cf..d8caa2b01 100644 --- a/docs/collocation/package.md +++ b/docs/collocation/package.md @@ -1,4 +1,72 @@ -package.json 是一个可选的配置文件，如果项目的根目录中存在这个文件，且根节点下含有`uni-app`节点，则支持自定义条件编译平台（如钉钉小程序、H5-weixin等）。 +通过在`package.json`文件中增加`uni-app`扩展节点，可实现自定义条件编译平台（如钉钉小程序、微信服务号等平台）。 + +package.json扩展配置用法： + +```json +{ + /** + package.json其它原有配置 + */ + "uni-app": {// 扩展配置 + "scripts": { + "custom-platform": { //自定义编译平台配置，可通过cli方式调用 + "env": {//环境变量 + "UNI_PLATFORM": "" //基准平台 + }, + "define": { //自定义条件编译 + "CUSTOM-CONST": true //自定义常量，建议为大写 + } + } + } + } +} + + +``` + +Tips： + +- `UNI_PLATFORM`仅支持填写`uni-app`默认支持的基准平台，目前仅限如下枚举值：`app-plus`、`h5`、`mp-weixin`、`mp-alipay`、`mp-baidu`、`mp-toutiao`、`mp-qq` +- 目前仅`vue-cli`版本支持package.json扩展配置，HBuilderX将于下版支持 + +### 示例：钉钉小程序 + +如下是一个自定义钉钉小程序（MP-DINGTALK）的package.json示例配置（拷贝代码记得去掉注释）： +```json +"uni-app": { + "scripts": { + "mp-dingtalk": { //自定义编译平台配置，可通过cli方式调用 + "env": { //环境变量 + "UNI_PLATFORM": "mp-alipay" //基准平台 + }, + "define": { //自定义条件编译 + "MP-DINGTALK": true //自定义常量，建议为大写 + } + } + } +} +``` + +###在代码中使用自定义平台 + +开发者可在代码块中使用钉钉小程序变量，如下： +```javascript +// #ifdef MP-DINGTALK +钉钉平台特有代码 +// #endif +``` + +###运行及发布项目 + +开发者可通过如下命令，启动钉钉小程序平台的编译： +``` +npm run dev:custom mp-dingtalk +npm run build:custom mp-dingtalk +``` + +Tips：钉钉小程序编译目录依然是`mp-alipay`，需通过支付宝开发者工具，选择“钉钉小程序”，然后打开该目录进行预览及发布。 + +### 示例：微信服务号 如下是一个自定义微信服务号平台（H5-WEIXIN）的示例配置： @@ -30,7 +98,3 @@ package.json 是一个可选的配置文件，如果项目的根目录中存在 npm run dev:custom h5-weixin npm run build:custom h5-weixin ``` - -Tips： - -- `UNI_PLATFORM`仅支持填写`uni-app`默认支持的基准平台，目前仅限如下枚举值：`app-plus`、`h5`、`mp-weixin`、`mp-alipay`、`mp-baidu`、`mp-toutiao`、`mp-qq`。 -- GitLab