Merge pull request #12 from zyx19960415/master readme 优化
Merge pull request #12 from zyx19960415/master
readme 优化
wx2,微信小程序转换工具
基于已有的原生微信小程序项目,提供零成本平移转换的能力,对小程序间差异进行抹平,提供简单快捷的 API,助力开发者快速互转已有小程序项目。
百度小程序
$ npm i wx2 -g
切换到自己指定的工作目录,执行全局命令wx2,并指定转换目录路径,和输出目录路径
wx2
目录路径
// 当前只支持百度小程序,其他小程序后续支持 $ wx2 <微信小程序文件夹> <目标小程序文件夹>
注: 路径中请包含’/‘作为路径标识
使用命令行参数--target,简写-t
--target
-t
# 默认,百度小程序 $ wx2 <微信小程序文件夹> <目标小程序文件夹> --target=swan # 二次迭代 $ wx2 <微信小程序文件夹> <目标小程序文件夹> --target=wx # 当前版本暂不支持,qq小程序 $ wx2 <微信小程序文件夹> <目标小程序文件夹> --target=qq
// 第三个参数为生成日志的文件夹地址 $ wx2 <微信小程序文件夹> <目标小程序文件夹> <生成日志的文件夹> -t
// 第四个参数为生成日志的自定义规则地址 $ wx2 <微信小程序文件夹> <目标小程序文件夹> <生成日志的文件夹> <自定义规则地址> -t
自定义规则使用方法: 1、新建自定义规则文件夹(文件夹名自定义),在文件夹下新建wx2.json文件,内部对象用于处理css,js,component,json,view等内置规则,示例如下:
{ "view": { "backets": [ "s-if", "s-elif", "s-for" ] }, "component": { "beviors": { "swan://form-field": { "mapping": "wx://form-field" } } }, "js": {} "json": { "app.json": ["prefetches"] }, "css": {} }
2、自定义对API处理的插件 创建过程:需要在自定义规则文件夹下新建api文件夹,并在api下新建plugins文件夹,形如/api/plugins/(代码块的类型)/xxx.js 代码块类型包括以下: ‘MemberExpression’, ‘CallExpression’, ‘ObjectProperty’, ‘StringLiteral’, ‘ExpressionStatement’, ‘ObjectMethod’, ‘ImportDeclaration’, ‘VariableDeclaration’
项目通过jest工具进行单元测试,包括测试结果和测试覆盖率。
// 单元测试 npm run jest
详细文档参见技术官网:https://pan.baidu.com/union/wx2/home#/
owners:
committers:
issues贡献: 如在使用中遇到问题,请在 https://github.com/baidu/wx2/issues 新建 issues 反馈问题。
微信扫描二维码,欢迎加入wx2技术交流群(添加下列管理员微信,并备注“wx2”,管理员会邀请您入群):
互转工具百度如流讨论群:3498775
版权所有:中国计算机学会技术支持:开源发展技术委员会 京ICP备13000930号-9 京公网安备 11010802032778号
项目名称
wx2,微信小程序转换工具
基于已有的原生微信小程序项目,提供零成本平移转换的能力,对小程序间差异进行抹平,提供简单快捷的 API,助力开发者快速互转已有小程序项目。
百度小程序,后续支持QQ、支付宝、头条等小程序快速开始
安装
使用
切换到自己指定的工作目录,执行全局命令
wx2,并指定转换目录路径,和输出目录路径运行及参数
使用命令行参数
--target,简写-t日志输出
自定义转换
自定义规则使用方法: 1、新建自定义规则文件夹(文件夹名自定义),在文件夹下新建wx2.json文件,内部对象用于处理css,js,component,json,view等内置规则,示例如下:
2、自定义对API处理的插件 创建过程:需要在自定义规则文件夹下新建api文件夹,并在api下新建plugins文件夹,形如/api/plugins/(代码块的类型)/xxx.js 代码块类型包括以下: ‘MemberExpression’, ‘CallExpression’, ‘ObjectProperty’, ‘StringLiteral’, ‘ExpressionStatement’, ‘ObjectMethod’, ‘ImportDeclaration’, ‘VariableDeclaration’
测试
测试方法
项目通过jest工具进行单元测试,包括测试结果和测试覆盖率。
文档
详细文档参见技术官网:https://pan.baidu.com/union/wx2/home#/
维护者
owners:
committers:
反馈
issues贡献: 如在使用中遇到问题,请在 https://github.com/baidu/wx2/issues 新建 issues 反馈问题。
讨论
微信扫描二维码,欢迎加入wx2技术交流群(添加下列管理员微信,并备注“wx2”,管理员会邀请您入群):
互转工具百度如流讨论群:3498775
版本更新(npm)