从零开始写一个babel插件

babel对于一个前端应该并不陌生,在我们随心所欲的使用ESnext的语法的时候,babel为我们默默的做着转换工作。那我们可能会好奇babel到底是怎么做到的呢,接下来我们就从手写一个babel插件入手来一起学习学习。

首先我们要研究一个东西得弄清楚它到底是干什么,引用babel官网的描述:


图一

我们首先思考一下babel要将最新的语法进行转换,肯定是有一套描述语法的数据结构,是的它就是AST(抽象语法树),看到这玩意是不是有点有头绪了。有了AST,数据结构我们就有了,剩下的就剩匹配转换了。

开始写代码之前我们先来介绍一下babel提供的工具:

1.https://astexplorer.net/ (在线js代码转换为AST)

2.babylon(js转换为AST的库)

3.babel-traverse(AST遍历库)

4.babel-types(包含了构造、验证以及变换 AST 节点的方法)

工欲善其事必先利其器,我们的工具都有了,接下来我们创建一个项目,项目的目录结构如下:


图二

index.js就是我们的插件入口,_test_为单元测试,test.js是我们需要转换的文件。接下来我们一起来看一看index.js文件


图三

我们这个插件主要功能是实现按照配置去除代码中的console,debugger,以及自定义的一个DEBUG的一个调试关键字(用于在指定环境下需要执行的代码)。

我们可以看到这边导出了一个function,function返回的是一个对象,这个对象内部有一个visitor属性,这visitor也是我们最核心的一个属性(AST的访问者),这个访问者是必须要提供的,也可以理解为固定写法。

我们看到导出的function有一个参数t,这个t是干什么的呢?这其实就是我们上面提到的babel-types。它可以让我们更方便的去匹配(if, else, for)这些关键字,从而定位到需要执行我们自己逻辑的代码块。

那visitor内部的这些东西又是什么呢,这个我们就得打开我们上面提到的AST转换网站,将我们需要处理的代码贴进去观察


图四

以debugger为例,我们看到debugger对应的AST里面的key为DebuggerStatement,然后我们在visitor里面也看到了DebuggerStatement,是不是有点眉目了,没错,这个key其实也是做类型匹配的。比如debugger,我们就可以在DebuggerStatement内去处理自己的逻辑,DebuggerStatement的value是一个function,提供有两个参数(path, state)path就是当前配备到的节点上下文,state我们经常的用法是获取babel插件配置的参数。到了这一步,我们回忆我们的需求:根据配置是否去除(debugger, console, 自定义关键字),现在配置能拿到了,接下来就是如何去除,这就得在path上面研究了,查询文档我们可以看到path提供了replaceWith,remove方法(nice),那我们的思路就很清晰了,匹配到关键字,删除就OK了。

接下来修改我们的package.json文件:

图五

npm run babel,可以看到这个插件完美的实现了我们的需求.。对于关键字和console的处理基本大同小异,需要注意的是自定义关键字需要处理eslint校验。最后附上完整代码地址:https://github.com/wangKXX/babel-plugin

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,558评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,002评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,024评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,144评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,255评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,295评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,068评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,478评论 1 305
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,789评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,965评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,649评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,267评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,982评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,800评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,847评论 2 351

推荐阅读更多精彩内容