uni-app扩展配置package.json

通过在package.json文件中增加uni-app扩展节点,可实现自定义条件编译平台(如钉钉小程序、微信服务号等平台)。

package.json扩展配置用法(拷贝代码记得去掉注释!):

{
    /**
     package.json其它原有配置 
     */
    "uni-app": {// 扩展配置
        "scripts": {
            "custom-platform": { //自定义编译平台配置,可通过cli方式调用
                "title":"自定义扩展名称", // 在HBuilderX中会显示在 运行/发行 菜单中
                "BROWSER":"",  //运行到的目标浏览器,仅当UNI_PLATFORM为h5时有效
                "env": {//环境变量
                    "UNI_PLATFORM": ""  //基准平台 
                 },
                "define": { //自定义条件编译
                    "CUSTOM-CONST": true //自定义条件编译常量,建议为大写
                }
            }
        }    
    }
}
  • UNI_PLATFORM仅支持填写uni-app默认支持的基准平台,目前仅限如下枚举值:h5mp-weixinmp-alipaymp-baidump-toutiaomp-qq
  • BROWSER仅在UNI_PLATFORMh5时有效,目前仅限如下枚举值:ChromeFirefoxIEEdgeSafariHBuilderX
  • package.json文件中不允许出现注释,否则扩展配置无效
  • vue-cli需更新到最新版,HBuilderX需升级到2.1.6+版本

示例:钉钉小程序

如下是一个自定义钉钉小程序(MP-DINGTALK)的package.json示例配置(拷贝代码记得去掉注释):

"uni-app": {
    "scripts": {
        "mp-dingtalk": { 
            "title": "钉钉小程序", 
            "env": { 
                "UNI_PLATFORM": "mp-alipay" 
            },
            "define": { 
                "MP-DINGTALK": true 
            }
        }
    }
}

在代码中使用自定义平台

开发者可在代码中使用MP-DINGTALK进行条件编译,如下:

// #ifdef MP-DINGTALK
钉钉平台特有代码
// #endif

运行及发布项目

vue-cli开发者可通过如下命令,启动钉钉小程序平台的编译:

npm run dev:custom mp-dingtalk 
npm run build:custom mp-dingtalk

HBuilderX会根据package.json的扩展配置,在运行、发行菜单下,生成自定义菜单(钉钉小程序),开发者点击对应菜单编译运行即可,如下图:

HBuilderX钉钉小程序扩展

Tips:钉钉小程序编译目录依然是mp-alipay,需通过支付宝开发者工具,选择“钉钉小程序”,然后打开该目录进行预览及发布。

示例:微信服务号

如下是一个自定义微信服务号平台(H5-WEIXIN)的示例配置:

"uni-app": {
    "scripts": {
        "h5-weixin": { 
            "title": "微信服务号",
            "BROWSER": "Chrome",  
            "env": {
                "UNI_PLATFORM": "h5"  
             },
            "define": { 
                "H5-WEIXIN": true 
            }
        }
    }    
}

开发者可在代码块中使用H5-WEIXIN变量,如下:

// #ifdef H5-WEIXIN
微信服务号特有代码
// #endif

vue-cli开发者可通过如下命令,启动微信服务号平台(H5-WEIXIN)平台的编译:

npm run dev:custom h5-weixin 
npm run build:custom h5-weixin

HBuilderX会根据package.json的扩展配置,在运行、发行菜单下,生成自定义菜单(微信服务号),开发者点击对应菜单编译运行即可,如下图:

HBuilderX微信服务号扩展

版权声明:
作者:Joe.Ye
链接:https://www.appblog.cn/index.php/2023/03/18/uni-app-extension-configuration-package-json/
来源:APP全栈技术分享
文章版权归作者所有,未经允许请勿转载。

THE END
分享
二维码
打赏
海报
uni-app扩展配置package.json
通过在package.json文件中增加uni-app扩展节点,可实现自定义条件编译平台(如钉钉小程序、微信服务号等平台)。 package.json扩展配置用法(拷贝代码记得去掉……
<<上一篇
下一篇>>
文章目录
关闭
目 录