QinJs 官网

Appearance

概述 ​

  • 在开发 web 时，有时需要一套代码编译发布到不同的站点，比如主站和微信 h5 站。（注意不是一套代码内部自适应不同浏览器，是真的分离部署了不同的网站）

qinjs 通过在 package.json 文件中增加 qinjs 扩展节点，可实现自定义条件编译平台。

扩展新的平台后，有3点影响：

  1. 可以在代码里编写自定义的条件编译，为这个新平台编写专用代码
  2. 运行时可以执行面向新平台的编译运行
  3. 发行时可以执行面向新平台的编译发行

扩展小程序平台时只能基于指定的基准平台扩展子平台，不能扩展基准平台。基准平台详见下文。

package.json扩展配置用法：

json
{
    /**
     * package.json其它原有配置 
     * 拷贝代码后请去掉注释！
     */
    "qinjs": {// 扩展配置
        "scripts": {
            "custom-platform": { //自定义编译平台配置，可通过cli方式调用
                "title":"自定义扩展名称", // 在HBuilderX中会显示在 运行/发行 菜单中
                "browser":"",  //运行到的目标浏览器，仅当QIN_PLATFORM为h5时有效
                "env": {//环境变量
                    "QIN_PLATFORM": "",  //基准平台
                    "MY_TEST": "", // ... 其他自定义环境变量
                 },
                "define": { //自定义条件编译
                    "CUSTOM-CONST": true //自定义条件编译常量，建议为大写
                }
            }
        }    
    }
}
{
    /**
     * package.json其它原有配置 
     * 拷贝代码后请去掉注释！
     */
    "qinjs": {// 扩展配置
        "scripts": {
            "custom-platform": { //自定义编译平台配置，可通过cli方式调用
                "title":"自定义扩展名称", // 在HBuilderX中会显示在 运行/发行 菜单中
                "browser":"",  //运行到的目标浏览器，仅当QIN_PLATFORM为h5时有效
                "env": {//环境变量
                    "QIN_PLATFORM": "",  //基准平台
                    "MY_TEST": "", // ... 其他自定义环境变量
                 },
                "define": { //自定义条件编译
                    "CUSTOM-CONST": true //自定义条件编译常量，建议为大写
                }
            }
        }    
    }
}

Tips：

  • QIN_PLATFORM 仅支持填写 qinjs 默认支持的基准平台，目前仅限如下枚举值： h5 、 wx 、 tt 、 ks
  • browser 仅在 QIN_PLATFORM 为 h5 时有效,目前仅限如下枚举值： chrome 、 firefox 、ie 、 edge 、 safari
  • package.json 文件中不允许出现注释，否则扩展配置无效

示例：微信小程序 ​

如下是一个自定义微信小程序（WX）的package.json示例配置（拷贝代码记得去掉注释）：

json
"qinjs": {
  "scripts": {
    "wx": { 
      "title":"微信小程序", 
      "env": { 
        "QIN_PLATFORM": "wx" 
      },
      "define": { 
        "WX": true 
      }
    }
  }
}
"qinjs": {
  "scripts": {
    "wx": { 
      "title":"微信小程序", 
      "env": { 
        "QIN_PLATFORM": "wx" 
      },
      "define": { 
        "WX": true 
      }
    }
  }
}

在代码中使用自定义平台

开发者可在代码中使用 WX 进行条件编译，如下：

js
// #ifdef TT
抖音平台通用代码
// #endif
// #ifdef WX
微信平台特有代码
// #endif
// #ifdef TT
抖音平台通用代码
// #endif
// #ifdef WX
微信平台特有代码
// #endif

运行及发布项目

vite 开发者可通过如下命令，启动钉钉小程序平台的编译：

npm run dev:custom wx
npm run build:custom wx
npm run dev:custom wx
npm run build:custom wx

示例：微信服务号 ​

如下是一个自定义微信服务号平台（H5-WEIXIN）的示例配置：

json
"qinjs": {
    "scripts": {
        "h5-weixin": { 
            "title":"微信服务号",
            "browser":"chrome",  
            "env": {
                "QIN_PLATFORM": "h5"  
             },
            "define": { 
                "H5-WEIXIN": true 
            }
        }
    }    
}
"qinjs": {
    "scripts": {
        "h5-weixin": { 
            "title":"微信服务号",
            "browser":"chrome",  
            "env": {
                "QIN_PLATFORM": "h5"  
             },
            "define": { 
                "H5-WEIXIN": true 
            }
        }
    }    
}

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

// #ifdef H5
H5平台通用代码（含微信服务号）
// #endif
// #ifdef H5-WEIXIN
微信服务号特有代码
// #endif
// #ifdef H5
H5平台通用代码（含微信服务号）
// #endif
// #ifdef H5-WEIXIN
微信服务号特有代码
// #endif