分享

从零开始写一个 wepy 转 Vue 的工具

 ws8637 2019-03-24


为什么需要 wepy 转 VUE

“转转二手”是我司用 wepy 开发的功能与 APP 相似度非常高的小程序,实现了大量的功能性页面,而新业务 H5 项目在开发过程中有时也经常需要一些公共页面和功能,但新项目又有自己的独特点,这些页面需求重新开发成本很高,但如果把小程序代码转换成 VUE 就会容易的多,因此需要这样一个转换工具。

本文将通过实战带你体验 HTML、css、JavaScript 的 AST 解析和转换过程

如果你看完觉得有用,请点个赞~

AST 概览

AST 全称是叫抽象语法树,网络上有很多对 AST 的概念阐述和 demo,其实可以跟 XML 类比,目前很多流行的语言都可以通过 AST 解析成一颗语法树,也可以认为是一个 JSON,这些语言包括且不限于:CSS、HTML、JavaScript、PHP、Java、SQL 等,举一个简单的例子:

  1. var a = 1;

这句简单的 JavaScript 代码通过 AST 将被解析成一颗“有点复杂”的语法树:

这句话从语法层面分析是一次变量声明和赋值,所以父节点是一个 type 为 VariableDeclaration(变量声明)的类型节点,声明的内容又包括两部分,标识符:a 和 初始值:1

这就是一个简单的 AST 转换,你可以通过 astexplorer(https:///)可视化的测试更多代码。

AST 有什么用

AST 可以将代码转换成 JSON 语法树,基于语法树可以进行代码转换、替换等很多操作,其实 AST 应用非常广泛,我们开发当中使用的 less/sass、eslint、TypeScript 等很多插件都是基于 AST 实现的。

本文的需求如果用文本替换的方式也可能可以实现,不过需要用到大量正则,且出错风险很高,如果用 AST 就能轻松完成这件事。

AST 原理

AST 处理代码一版分为以下两个步骤:

词法分析

词法分析会把你的代码进行大拆分,会根据你写的每一个字符进行拆分(会舍去注释、空白符等无用内容),然后把有效代码拆分成一个个 token。

语法分析

接下来 AST 会根据特定的“规则”把这些 token 加以处理和包装,这些规则每个解析器都不同,但做的事情大体相同,包括:

  • 把每个 token 对应到解析器内置的语法规则中,比如上文提到的 var a = 1;这段代码将被解析成 VariableDeclaration 类型。

  • 根据代码本身的语法结构,将 tokens 组装成树状结构。

各种 AST 解析器

每种语言都有很多解析器,使用方式和生成的结果各不相同,开发者可以根据需要选择合适的解析器。

JavaScript

  • 最知名的当属 babylon,因为他是 babel 的御用解析器,一般 JavaScript 的 AST 这个库比较常用

  • acron:babylon 就是从这个库 fork 来的

HTML

  • htmlparser2:比较常用

  • parse5:不太好用,还需要配合 jsdom 这个类库

CSS

  • cssom、csstree 等

  • less/sass

XML

  • XmlParser

wepy 转 VUE 工具

接下来我们开始实战了,这个需求我们用到的技术有:

  • node

  • commander:用来写命令行相关命令调用

  • fs-extra:fs 类库的升级版,主要提高了 node 文件操作的便利性,并且提供了 Promise 封装

  • XmlParser:解析 XML

  • htmlparser2:解析 HTML

  • less:解析 css(我们所有项目统一都是 less,所以直接解析 less 就可以了)

  • babylon:解析 JavaScript

  • @babel/types:js 的类型库,用于查找、校验、生成相应的代码树节点

  • @babel/traverse:方便对 JavaScript 的语法树进行各种形式的遍历

  • @babel/template:将你处理好的语法树打印到一个固定模板里

  • @babel/generator:生成处理好的 JavaScript 文本内容

转换目标

我们先看一段简单的 wepy 和 VUE 的代码对比:

  1. //wepy版

  2. <template>

  3. <view class='userCard'>

  4. <view class='basic'>

  5. <view class='avatar'>

  6. <image src='{{info.portrait}}'></image>

  7. </view>

  8. <view class='info'>

  9. <view class='name'>{{info.nickName}}</view>

  10. <view class='label' wx:if='{{info.label}}'>

  11. <view class='label-text' wx:for='{{info.label}}'>{{item}}</view>

  12. </view>

  13. <view class='onsale'>在售宝贝{{sellingCount}}</view>

  14. <view class='follow ' @tap='follow'>{{isFollow ? '取消关注' : '关注'}}</view>

  15. </view>

  16. </view>

  17. </view>

  18. </template>

  19. <style lang='less' rel='stylesheet/less' scoped>

  20. .userCard {

  21. position:relative;

  22. background: #FFFFFF;

  23. box-shadow: 0 0 10rpx 0 rgba(162,167,182,0.31);

  24. border-radius: 3rpx;

  25. padding:20rpx;

  26. position: relative;

  27. }

  28. /* css太多了,省略其他内容 */

  29. </style>

  30. <script>

  31. import wepy from 'wepy'

  32. export default class UserCard extends wepy.component {

  33. props = {

  34. info:{

  35. type:Object,

  36. default:{}

  37. }

  38. }

  39. data = {

  40. isFollow: false,

  41. }

  42. methods = {

  43. async follow() {

  44. await someHttpRequest() //请求某个接口

  45. this.isFollow = !this.isFollow

  46. this.$apply()

  47. }

  48. }

  49. computed = {

  50. sellingCount(){

  51. return this.info.sellingCount || 1

  52. }

  53. }

  54. onLoad(){

  55. this.$log('view')

  56. }

  57. }

  58. </script>

  1. //VUE版

  2. <template>

  3. <div class='userCard'>

  4. <div class='basic'>

  5. <div class='avatar'>

  6. <img src='info.portrait'></img>

  7. </view>

  8. <view class='info'>

  9. <view class='name'>{{info.nickName}}</view>

  10. <view class='label' v-if='info.label'>

  11. <view class='label-text' v-for='(item,key) in info.label'>{{item}}</view>

  12. </view>

  13. <view class='onsale'>在售宝贝{{sellingCount}}</view>

  14. <view class='follow ' @click='follow'>{{isFollow ? '取消关注' : '关注'}}</view>

  15. </view>

  16. </view>

  17. </view>

  18. </template>

  19. <style lang='less' rel='stylesheet/less' scoped>

  20. .userCard {

  21. position:relative;

  22. background: #FFFFFF;

  23. box-shadow: 0 0 10rpx 0 rgba(162,167,182,0.31);

  24. border-radius: 3*@px;

  25. padding:20*@px;

  26. position: relative;

  27. }

  28. /* css太多了,省略其他内容 */

  29. </style>

  30. <script>

  31. export default {

  32. props : {

  33. info:{

  34. type:Object,

  35. default:{}

  36. }

  37. }

  38. data(){

  39. return {

  40. isFollow: false,

  41. }

  42. }


  43. methods : {

  44. async follow() {

  45. await someHttpRequest() //请求某个接口

  46. this.isFollow = !this.isFollow

  47. }

  48. }

  49. computed : {

  50. sellingCount(){

  51. return this.info.sellingCount || 1

  52. }

  53. }

  54. created() {

  55. this.$log('view')

  56. }

  57. }

  58. </script>

转换代码实现

我们先写个读取文件的入口方法

  1. const cwdPath = process.cwd()

  2. const fse = require('fs-extra')


  3. const convert = async function(filepath){

  4. let fileText = await fse.readFile(filepath, 'utf-8');

  5. fileHandle(fileText.toString(),filepath)

  6. }

  7. const fileHandle = async function(fileText,filepath){

  8. //dosth...

  9. }

  10. convert(`${cwdPath}/demo.wpy`)

在 fileHandle 函数中,我们可以得到代码的文本内容,首先我们将对其进行 XML 解析,把 template、css、JavaScript 拆分成三部分。 有同学可能问为什么不直接正则匹配出来,因为开发者的代码可能有很多风格,比如有两部分 style,可能有很多意外情况是使用正则考虑不到的,这也是使用 AST 的意义。

  1. //首先需要完成Xml解析及路径定义:


  2. //初始化一个Xml解析器

  3. let xmlParser = new XmlParser(),

  4. //解析代码内容

  5. xmlParserObj = xmlParser.parse(fileText),

  6. //正则匹配产生文件名

  7. filenameMatch = filepath.match(/([^\.|\/|\\]+)\.\w+$/),

  8. //如果没有名字默认为blank

  9. filename = filenameMatch.length > 1 ? filenameMatch[1] : 'blank',

  10. //计算出模板文件存放目录dist的绝对地址

  11. filedir = utils.createDistPath(filepath),

  12. //最终产出文件地址

  13. targetFilePath = `${filedir}/${filename}.vue`


  14. //接下来创建目标目录

  15. try {

  16. fse.ensureDirSync(filedir)

  17. }catch (e){

  18. throw new Error(e)

  19. }


  20. //最后根据xml解析出来的节点类型进行不同处理

  21. for(let i = 0 ;i < xmlParserObj.childNodes.length;i++){

  22. let v = xmlParserObj.childNodes[i]

  23. if(v.nodeName === 'style'){

  24. typesHandler.style(v,filedir,filename,targetFilePath)

  25. }

  26. if(v.nodeName === 'template'){

  27. typesHandler.template(v,filedir,filename,targetFilePath)

  28. }

  29. if(v.nodeName === 'script'){

  30. typesHandler.script(v,filedir,filename,targetFilePath)

  31. }

  32. }

不同节点的处理逻辑,定义在一个叫做 typesHandler 的对象里面存放,接下来我们看下不同类型代码片段的处理逻辑

因篇幅有限,本文只列举一部分代码转换的目标,实际上要比这些更复杂

接下来我们对代码进行转换:

模板处理

转换目标

  • 模板标签转换:把 view 转换成 div,把 image 标签转换成 img

  • 模板逻辑判断:wx:if='{{info.label}}' 转换成 v-if='info.label'

  • 模板循环:wx:for='{{info.label}}' 转换成 v-for='(item,key) in info.label'

  • 事件绑定:@tap='follow' 转换成 @click='follow'

核心流程

  • 首先把拿到的目标文本解析成语法树,然后进行各项转换,最后把语法树转换成文本写入到文件

  1. let templateContent = v.childNodes.toString(),

  2. //初始化一个解析器

  3. templateParser = new TemplateParser()


  4. //生成语法树

  5. templateParser.parse(templateContent).then((templateAst)=>{

  6. //进行上述目标的转换

  7. let convertedTemplate = templateConverter(templateAst)

  8. //把语法树转成文本

  9. templateConvertedString = templateParser.astToString(convertedTemplate)


  10. templateConvertedString = `<template>\r\n${templateConvertedString}\r\n</template>\r\n`

  11. fs.writeFile(targetFilePath,templateConvertedString, ()=>{

  12. resolve()

  13. });

  14. }).catch((e)=>{

  15. reject(e)

  16. })

  • TemplateParser 是我封装的一个简单的模板 AST 处理类库,(因为使用了 htmlparser2 类库,该类库的调用方式有点麻烦),我们看下代码:

  1. const Parser = require('./Parser') //基类

  2. const htmlparser = require('htmlparser2') //html的AST类库

  3. class TemplateParser extends Parser {

  4. constructor(){

  5. super()

  6. }


  7. /**

  8. * HTML文本转AST方法

  9. * @param scriptText

  10. * @returns {Promise}

  11. */

  12. parse(scriptText){

  13. return new Promise((resolve, reject) => {

  14. //先初始化一个domHandler

  15. const handler = new htmlparser.DomHandler((error, dom)=>{

  16. if (error) {

  17. reject(error);

  18. } else {

  19. //在回调里拿到AST对象

  20. resolve(dom);

  21. }

  22. });

  23. //再初始化一个解析器

  24. const parser = new htmlparser.Parser(handler);

  25. //再通过write方法进行解析

  26. parser.write(scriptText);

  27. parser.end();

  28. });

  29. }

  30. /**

  31. * AST转文本方法

  32. * @param ast

  33. * @returns {string}

  34. */

  35. astToString (ast) {

  36. let str = '';

  37. ast.forEach(item => {

  38. if (item.type === 'text') {

  39. str += item.data;

  40. } else if (item.type === 'tag') {

  41. str += '<' + item.name;

  42. if (item.attribs) {

  43. Object.keys(item.attribs).forEach(attr => {

  44. str += ` ${attr}='${item.attribs[attr]}'`;

  45. });

  46. }

  47. str += '>';

  48. if (item.children && item.children.length) {

  49. str += this.astToString(item.children);

  50. }

  51. str += `</${item.name}>`;

  52. }

  53. });

  54. return str;

  55. }

  56. }


  57. module.exports = TemplateParser

  • 3、接下来我们看下具体替换过程:

  1. //html标签替换规则,可以添加更多

  2. const tagConverterConfig = {

  3. 'view':'div',

  4. 'image':'img'

  5. }

  6. //属性替换规则,也可以加入更多

  7. const attrConverterConfig = {

  8. 'wx:for':{

  9. key:'v-for',

  10. value:(str)=>{

  11. return str.replace(/{{(.*)}}/,'(item,key) in $1')

  12. }

  13. },

  14. 'wx:if':{

  15. key:'v-if',

  16. value:(str)=>{

  17. return str.replace(/{{(.*)}}/,'$1')

  18. }

  19. },

  20. '@tap':{

  21. key:'@click'

  22. },

  23. }

  24. //替换入口方法

  25. const templateConverter = function(ast){

  26. for(let i = 0;i<ast.length;i++){

  27. let node = ast[i]

  28. //检测到是html节点

  29. if(node.type === 'tag'){

  30. //进行标签替换

  31. if(tagConverterConfig[node.name]){

  32. node.name = tagConverterConfig[node.name]

  33. }

  34. //进行属性替换

  35. let attrs = {}

  36. for(let k in node.attribs){

  37. let target = attrConverterConfig[k]

  38. if(target){

  39. //分别替换属性名和属性值

  40. attrs[target['key']] = target['value'] ? target['value'](node.attribs[k]) : node.attribs[k]

  41. }else {

  42. attrs[k] = node.attribs[k]

  43. }

  44. }

  45. node.attribs = attrs

  46. }

  47. //因为是树状结构,所以需要进行递归

  48. if(node.children){

  49. templateConverter(node.children)

  50. }

  51. }

  52. return ast

  53. }

css 处理

转换目标

  • 将 image 替换为 img

  • 将单位 rpx 转换成 *@px

核心过程

  • 1、我们要先对拿到的 css 文本代码进行反转义处理,因为在解析 xml 过程中,css 中的特殊符号已经被转义了,这个处理逻辑很简单,只是字符串替换逻辑,因此封装在 utils 工具方法里,本文不赘述。

  1. let styleText = utils.deEscape(v.childNodes.toString())

  • 2、根据节点属性中的 type 来判断是 less 还是普通 css

  1. if(v.attributes){

  2. //检测css是哪种类型

  3. for(let i in v.attributes){

  4. let attr = v.attributes[i]

  5. if(attr.name === 'lang'){

  6. type = attr.value

  7. }

  8. }

  9. }

  • 3、less 内容的处理:使用 less.render()方法可以将 less 转换成 css;如果是 css,直接对 styleText 进行处理就可以了

  1. less.render(styleText).then((output)=>{

  2. //output是css内容对象

  3. })

  • 4、将 image 选择器换成 img,这里也需要替换更多标签,比如 text、icon、scroll-view 等,篇幅原因不赘述

  1. const CSSOM = require('cssom') //css的AST解析器

  2. const replaceTagClassName = function(replacedStyleText){

  3. const replaceConfig = {}

  4. //匹配标签选择器

  5. const tagReg = /[^\.|#|\-|_](\b\w+\b)/g

  6. //将css文本转换为语法树

  7. const ast = CSSOM.parse(replacedStyleText),

  8. styleRules = ast.cssRules


  9. if(styleRules && styleRules.length){

  10. //找到包含tag的className

  11. styleRules.forEach(function(item){

  12. //可能会有 view image {...}这多级选择器

  13. let tags = item.selectorText.match(tagReg)

  14. if(tags && tags.length){

  15. let newName = ''

  16. tags = tags.map((tag)=>{

  17. tag = tag.trim()

  18. if(tag === 'image')tag = 'img'

  19. return tag

  20. })

  21. item.selectorText = tags.join(' ')

  22. }

  23. })

  24. //使用toString方法可以把语法树转换为字符串

  25. replacedStyleText = ast.toString()

  26. }

  27. return {replacedStyleText,replaceConfig}

  28. }

  • 5、将 rpx 替换为*@px

  1. replacedStyleText = replacedStyleText.replace(/([\d\s]+)rpx/g,'$1*@px')

  • 6、将转换好的代码写入文件

  1. replacedStyleText = `<style scoped>\r\n${replacedStyleText}\r\n</style>\r\n`


  2. fs.writeFile(targetFilePath,replacedStyleText,{

  3. flag: 'a'

  4. },()=>{

  5. resolve()

  6. });

JavaScript 转换

转换目标

  • 去除 wepy 引用

  • 转换成 vue 的对象写法

  • 去除无用代码:this.\$apply()

  • 生命周期对应

核心过程

在了解如何转换之前,我们先简单了解下 JavaScript 转换的基本流程:

借用其他作者一张图片,可以看出转换过程分为解析->转换->生成 这三个步骤。

具体如下:

  • 1、先把 xml 节点通过 toString 转换成文本

  1. v.childNodes.toString()

  • 2、再进行反转义(否则会报错的哦)

  1. let javascriptContent = utils.deEscape(v.childNodes.toString())

  • 3、接下来初始化一个解析器

  1. let javascriptParser = new JavascriptParser()

这个解析器里封装了什么呢,看代码:

  1. const Parser = require('./Parser') //基类

  2. const babylon = require('babylon') //AST解析器

  3. const generate = require('@babel/generator').default

  4. const traverse = require('@babel/traverse').default


  5. class JavascriptParser extends Parser {

  6. constructor(){

  7. super()

  8. }

  9. /**

  10. * 解析前替换掉无用字符

  11. * @param code

  12. * @returns

  13. */

  14. beforeParse(code){

  15. return code.replace(/this\.\$apply\(\);?/gm,'').replace(/import\s+wepy\s+from\s+['']wepy['']/gm,'')

  16. }

  17. /**

  18. * 文本内容解析成AST

  19. * @param scriptText

  20. * @returns {Promise}

  21. */

  22. parse(scriptText){

  23. return new Promise((resolve,reject)=>{

  24. try {

  25. const scriptParsed = babylon.parse(scriptText,{

  26. sourceType:'module',

  27. plugins: [

  28. // 'estree', //这个插件会导致解析的结果发生变化,因此去除,这本来是acron的插件

  29. 'jsx',

  30. 'flow',

  31. 'doExpressions',

  32. 'objectRestSpread',

  33. 'exportExtensions',

  34. 'classProperties',

  35. 'decorators',

  36. 'objectRestSpread',

  37. 'asyncGenerators',

  38. 'functionBind',

  39. 'functionSent',

  40. 'throwExpressions',

  41. 'templateInvalidEscapes'

  42. ]

  43. })

  44. resolve(scriptParsed)

  45. }catch (e){

  46. reject(e)

  47. }

  48. })

  49. }


  50. /**

  51. * AST树遍历方法

  52. * @param astObject

  53. * @returns {*}

  54. */

  55. traverse(astObject){

  56. return traverse(astObject)

  57. }


  58. /**

  59. * 模板或AST对象转文本方法

  60. * @param astObject

  61. * @param code

  62. * @returns {*}

  63. */

  64. generate(astObject,code){

  65. const newScript = generate(astObject, {}, code)

  66. return newScript

  67. }

  68. }

  69. module.exports = JavascriptParser

值得注意的是:babylon 的 plugins 配置有很多,如何配置取决于你的代码里面使用了哪些高级语法,具体可以参见文档或者根据报错提示处理

  • 4、在解析之前可以先通过 beforeParse 方法去除掉一些无用代码(这些代码通常比较固定,直接通过字符串替换掉更方便)

  1. javascriptContent = javascriptParser.beforeParse(javascriptContent)

  • 5、再把文本解析成 AST

  1. javascriptParser.parse(javascriptContent)

  • 6、通过 AST 遍历整个树,进行各种代码转换

  1. let {convertedJavascript,vistors} = componentConverter(javascriptAst)

componentConverter 是转换的方法封装,转换过程略复杂,我们先了解几个概念。

假如我们拿到了 AST 对象,我们需要先对他进行遍历,如何遍历呢,这样一个复杂的 JSON 结构如果我们用循环或者递归的方式去遍历,那无疑会非常复杂,所以我们就借助了 babel 里的traverse这个工具,文档:babel-traverse(https:///docs/en/babel-traverse)。

  • traverse 接受两个参数:AST 对象和 vistor 对象

  • vistor 就是配置遍历方式的对象

  • 主要有两种:

  • 树状遍历:主要通过在节点的进入时机 enter 和离开 exit 时机进行遍历处理,进入节点之后再判断是什么类型的节点做对应的处理

  1. const componentVistor = {

  2. enter(path) {

  3. if (path.isIdentifier({ name: 'n' })) {

  4. path.node.name = 'x';

  5. }

  6. },

  7. exit(path){

  8. //do sth

  9. }

  10. }

  • 按类型遍历:traverse 帮你找到对应类型的所有节点

  1. const componentVistor = {

  2. FunctionDeclaration(path) {

  3. path.node.id.name = 'x';

  4. }

  5. }

本文代码主要使用了树状遍历的方式,代码如下:

  1. const componentVistor = {

  2. enter(path) {

  3. //判断如果是类属性

  4. if (t.isClassProperty(path)) {

  5. //根据不同类属性进行不同处理,把wepy的类属性写法提取出来,放到VUE模板中

  6. switch (path.node.key.name){

  7. case 'props':

  8. vistors.props.handle(path.node.value)

  9. break;

  10. case 'data':

  11. vistors.data.handle(path.node.value)

  12. break;

  13. case 'events':

  14. vistors.events.handle(path.node.value)

  15. break;

  16. case 'computed':

  17. vistors.computed.handle(path.node.value)

  18. break;

  19. case 'components':

  20. vistors.components.handle(path.node.value)

  21. break;

  22. case 'watch':

  23. vistors.watch.handle(path.node.value)

  24. break;

  25. case 'methods':

  26. vistors.methods.handle(path.node.value)

  27. break;

  28. default:

  29. console.info(path.node.key.name)

  30. break;

  31. }

  32. }

  33. //判断如果是类方法

  34. if(t.isClassMethod(path)){

  35. if(vistors.lifeCycle.is(path)){

  36. vistors.lifeCycle.handle(path.node)

  37. }else {

  38. vistors.methods.handle(path.node)

  39. }

  40. }

  41. }

  42. }

本文的各种 vistor 主要做一个事,把各种类属性和方法收集起来,基类代码:

  1. class Vistor {

  2. constructor() {

  3. this.data = []

  4. }

  5. handle(path){

  6. this.save(path)

  7. }

  8. save(path){

  9. this.data.push(path)

  10. }

  11. getData(){

  12. return this.data

  13. }

  14. }

  15. module.exports = Vistor

这里还需要补充讲下@babel/types这个类库,它主要是提供了 JavaScript 的 AST 中各种节点类型的检测、改造、生成方法,举例:

  1. //类型检测

  2. if(t.isClassMethod(path)){

  3. //如果是类方法

  4. }

  5. //创造一个对象节点

  6. t.objectExpression(...)

通过上面的处理,我们已经把 wepy 里面的各种类属性和方法收集好了,接下来我们看如何生成 vue 写法的代码

  • 7、把转换好的 AST 树放到预先定义好的 template 模板中

  1. convertedJavascript = componentTemplateBuilder(convertedJavascript,vistors)

看下 componentTemplateBuilder 这个方法如何定义:

  1. const componentTemplateBuilder = function(ast,vistors){

  2. const buildRequire = template(componentTemplate);

  3. ast = buildRequire({

  4. PROPS: arrayToObject(vistors.props.getData()),

  5. LIFECYCLE: arrayToObject(vistors.lifeCycle.getData()),

  6. DATA: arrayToObject(vistors.data.getData()),

  7. METHODS: arrayToObject(vistors.methods.getData()),

  8. COMPUTED: arrayToObject(vistors.computed.getData()),

  9. WATCH: arrayToObject(vistors.watch.getData()),

  10. });

  11. return ast

  12. }

这里就用到了@babel/template这个类库,主要作用是可以把你的代码数据组装到一个新的模板里,模板如下:

  1. const componentTemplate = `

  2. export default {

  3. data() {

  4. return DATA

  5. },


  6. props:PROPS,


  7. methods: METHODS,


  8. computed: COMPUTED,


  9. watch:WATCH,


  10. }

  11. `

*生命周期需要进行对应关系处理,略复杂,本文不赘述

  • 8、把模板转换成文本内容并写入到文件中

  1. let codeText = `<script>\r\n${generate(convertedJavascript).code}\r\n</script>\r\n`


  2. fs.writeFile(targetFilePath,codeText, ()=>{

  3. resolve()

  4. });

这里用到了@babel/generate类库,主要作用是把 AST 语法树生成文本格式

上述过程的代码实现总体流程

  1. const JavascriptParser = require('./lib/parser/JavascriptParser')


  2. //先反转义

  3. let javascriptContent = utils.deEscape(v.childNodes.toString()),

  4. //初始化一个解析器

  5. javascriptParser = new JavascriptParser()


  6. //去除无用代码

  7. javascriptContent = javascriptParser.beforeParse(javascriptContent)

  8. //解析成AST

  9. javascriptParser.parse(javascriptContent).then((javascriptAst)=>{

  10. //进行代码转换

  11. let {convertedJavascript,vistors} = componentConverter(javascriptAst)

  12. //放到预先定义好的模板中

  13. convertedJavascript = componentTemplateBuilder(convertedJavascript,vistors)


  14. //生成文本并写入到文件

  15. let codeText = `<script>\r\n${generate(convertedJavascript).code}\r\n</script>\r\n`


  16. fs.writeFile(targetFilePath,codeText, ()=>{

  17. resolve()

  18. });

  19. }).catch((e)=>{

  20. reject(e)

  21. })

上面就是 wepy 转 VUE 工具的核心代码实现流程了

通过这个例子希望大家能了解到如何通过 AST 的方式进行精准的代码处理或者语法转换

如何做成命令行工具

既然我们已经实现了这个转换工具,那接下来我们希望给开发者提供一个命令行工具,主要有两个部分:

注册命令

  • 1、在项目的 package.json 里面配置 bin 部分

  1. {

  2. 'name': '@zz-vc/fancy-cli',

  3. 'bin': {

  4. 'fancy': 'bin/fancy'

  5. },

  6. //其他配置

  7. }

  • 2、写好代码后,npm publish 上去

  • 3、开发者安装了你的插件后就可以在命令行以fancy xxxx的形式直接调用命令了

编写命令调用代码

  1. #!/usr/bin/env node


  2. process.env.NODE_PATH = __dirname + '/../node_modules/'


  3. const { resolve } = require('path')


  4. const res = command => resolve(__dirname, './commands/', command)


  5. const program = require('commander')


  6. program

  7. .version(require('../package').version )


  8. program

  9. .usage('<command>')


  10. //注册convert命令

  11. program

  12. .command('convert <componentName>')

  13. .description('convert a component,eg: fancy convert Tab.vue')

  14. .alias('c')

  15. .action((componentName) => {

  16. let fn = require(res('convert'))

  17. fn(componentName)

  18. })



  19. program.parse(process.argv)


  20. if(!program.args.length){

  21. program.help()

  22. }

convert 命令对应的代码:

  1. const cwdPath = process.cwd()

  2. const convert = async function(filepath){

  3. let fileText = await fse.readFile(filepath, 'utf-8');

  4. fileHandle(fileText.toString(),filepath)

  5. }


  6. module.exports = function(fileName){

  7. convert(`${cwdPath}/${fileName}`)

  8. }

fileHandle 这块的代码最开始已经讲过了,忘记的同学可以从头再看一遍,你就可以整个串起来这个工具的整体实现逻辑了

结语

至此本文就讲完了如何通过 AST 写一个 wepy 转 VUE 的命令行工具,希望对你有所收获。

    本站是提供个人知识管理的网络存储空间,所有内容均由用户发布,不代表本站观点。请注意甄别内容中的联系方式、诱导购买等信息,谨防诈骗。如发现有害或侵权内容,请点击一键举报。
    转藏 分享 献花(0

    0条评论

    发表

    请遵守用户 评论公约

    类似文章 更多