Babel 的 APIs 主要位于 @babel/core
包中。
这里顺便介绍一下每个依赖包的作用:
@babel/parser
:Babel 的解析器,用于将源代码转换为 AST。@babel/core
:Babel 的核心包,提供了 Babel 的核心编译功能。使用 Babel 这个包是必须安装的。@babel/generator
:Babel 的代码生成器,它接收一个 AST 并将其转换为代码和源码映射(source map)。@babel/code-frame
:提供了一种用于生成 Babel 错误消息的方法,可以在代码帧中高亮显示错误。@babel/runtime
:提供了 Babe 运行时所需要的辅助函数和 polyfills,以避免在每个文件中都重复这些代码。@babel/template
:提供了一种编写带有占位符的 Babel AST 模板的方法。@babel/traverse
:是 Babel 的 AST 遍历器,它包含了一些用于处理 AST 的工具。@babel/types
:提供了一种用于 AST 节点的 Lodash-esque 实用程序库。
在 第一节课,我们安装了三个依赖:core
、cli
、preset
,使用 Babel 进行编译时发现最终是生成了编译后的代码,而从 AST 生成编译后代码是 generator
的工作,实际上当你安装 core
的时候,就会间接的安装 generator
、traverse
等需要用到的依赖包。
通过对官方 API 的观察,发现 @babel/core
的 API 主要分为三大类:
transformXXX
parseXXX
loadXXX
transformXXX
这一组方法做和编译相关的操作,之所以有这么多,其实就是同步或者异步、编译代码或者文件的区别,每个方法的具体含义如下:
transform(code: string, options: Object)
:异步函数,用于将源代码字符串转换为 Babel 的结果对象。结果对象包含了转换后的代码,源码映射,以及 AST。transformSync(code: string, options: Object)
:和transform
函数功能相同,但它是同步执行的。transformAsync(code: string, options: Object)
:和transform
函数功能相同,但它返回一个 Promise。transformFile(filename: string, options: Object, callback: Function)
:读取并转换指定的文件。转换完成后,会调用提供的回调函数,并将结果对象传递给回调函数。transformFileSync(filename: string, options: Object)
:和transformFile
函数功能相同,但它是同步执行的。transformFileAsync(filename: string, options: Object)
:和transformFile
函数功能相同,但它返回一个 Promise。transformFromAst(ast: Object, code: string, options: Object)
:接受一个 AST 对象,将这个 AST 转换为 Babel 的结果对象。这个函数可以用于在已有 AST 的情况下避免重新解析代码。transformFromAstSync(ast: Object, code: string, options: Object)
:和transformFromAst
函数功能相同,但它是同步执行的。transformFromAstAsync(ast: Object, code: string, options: Object)
:和transformFromAst
函数功能相同,但它返回一个 Promise。
parseXXX
该系列方法主要负责将源码转为抽象语法树(AST)。
parse(code: string, options: Object)
:异步函数,用于解析源代码字符串并返回一个 AST。可以通过选项对象来配置解析过程,例如是否包含注释,是否包含 location 信息等。parseSync(code: string, options: Object)
:和parse
函数功能相同,但它是同步执行的。parseAsync(code: string, options: Object)
:和parse
函数功能相同,但它返回一个 Promise。
loadXXX
这一系列方法主要是做配置文件的加载工作的。
loadOptions(options: Object)
:接受一个选项对象,返回一个完整的、已解析的 Babel 配置对象。这个配置对象包括了所有的预设、插件和其他配置选项。如果提供的选项对象中没有指定配置,那么这个函数会尝试从.babelrc
文件或babel.config.*
文件中加载配置。loadPartialConfig(options: Object)
:和loadOptions
函数类似,但是返回的配置对象可能是部分的,也就是说,它可能没有包括所有的预设和插件。这个函数主要用于在构建工具中,需要对 Babel 配置进行更精细的控制时。