sialvsic的Tech空间

# Babel API

# Path

# Path的属性

path {
  // 属性：
  node
  parent
  parentPath
  scope
  hub
  container AST 节点所在的父节点属性的属性
  key
  listKey
}
  • path.node 当前 AST 节点
  • path.parent 父 AST 节点
  • path.parentPath 父 AST 节点的 path
  • path.scope 作用域，见下文详解
  • path.hub 可以通过 path.hub.file 拿到最外层 File 对象， path.hub.getScope 拿到最外层作用域，path.hub.getCode 拿到源码的字符串
  • path.container 当前 AST 节点所在的父节点属性的属性值
  • path.key 当前 AST 节点所在父节点属性的属性名或所在数组的下标
  • path.listkey 当前 AST 节点所在父节点属性的属性值为数组时 listkey 为该属性名，否则为 undefined

# Path的方法

path {
  // 方法
  get(key) 
  set(key, node)
  inList() 判断节点是否在数组中，如果 container 为数组，也就是有 listkey 的时候，返回 true
  getSibling(key) 
  getNextSibling()
  getPrevSibling()
  getAllPrevSiblings()
  getAllNextSiblings()
  isXxx(opts)
  assertXxx(opts)
  find(callback)
  findParent(callback)
  
  insertBefore(nodes)
  insertAfter(nodes)
  replaceWith(replacement)
  replaceWithMultiple(nodes)
  replaceWithSourceString(replacement)
  remove()
  
  traverse(visitor, state)
  skip()
  stop()
}
  • inList() 判断节点是否在数组中，如果 container 为数组，也就是有 listkey 的时候，返回 true
  • get(key) 获取某个属性的 path
  • set(key, node) 设置某个属性的值
  • getSibling(key) 获取某个下标的兄弟节点
  • getNextSibling() 获取下一个兄弟节点
  • getPrevSibling() 获取上一个兄弟节点
  • getAllPrevSiblings() 获取之前的所有兄弟节点
  • getAllNextSiblings() 获取之后的所有兄弟节点
  • find(callback) 从当前节点到根节点来查找节点（包括当前节点），调用 callback（传入 path）来决定是否终止查找
  • findParent(callback) 从当前节点到根节点来查找节点（不包括当前节点），调用 callback（传入 path）来决定是否终止查找
  • isXxx(opts) 判断当前节点是否是某个类型，可以传入属性和属性值进一步判断，比如path.isIdentifier({name: 'a'})
  • assertXxx(opts) 同 isXxx，但是不返回布尔值，而是抛出异常
  • insertBefore(nodes) 在之前插入节点，可以是单个节点或者节点数组
  • insertAfter(nodes) 在之后插入节点，可以是单个节点或者节点数组
  • replaceWith(replacement) 用某个节点替换当前节点
  • replaceWithMultiple(nodes) 用多个节点替换当前节点
  • replaceWithSourceString(replacement) 解析源码成 AST，然后替换当前节点
  • remove() 删除当前节点
  • traverse(visitor, state) 遍历当前节点的子节点，传入 visitor 和 state（state 是不同节点间传递数据的方式）
  • skip() 跳过当前节点的子节点的遍历
  • stop() 结束所有遍历

# Path Scope 作用域

方法和属性

path.scope {
    bindings
    block
    parent
    parentBlock
    path
    references
 
    dump()
    parentBlock()
    getAllBindings()
    getBinding(name)
    hasBinding(name)
    getOwnBinding(name)
    parentHasBinding(name)
    removeBinding(name)
    moveBindingTo(name, scope)
    generateUid(name)
}
  • scope.bindings 当前作用域内声明的所有变量
  • scope.block 生成作用域的 block，详见下文
  • scope.path 生成作用域的节点对应的 path
  • scope.references 所有 binding 的引用对应的 path，详见下文
  • scope.dump() 打印作用域链的所有 binding 到控制台
  • scope.parentBlock() 父级作用域的 block
  • getAllBindings() 从当前作用域到根作用域的所有 binding 的合并
  • getBinding(name) 查找某个 binding，从当前作用域一直查找到根作用域
  • getOwnBinding(name) 从当前作用域查找 binding
  • parentHasBinding(name, noGlobals) 查找某个 binding，从父作用域查到根作用域，不包括当前作用域。可以通- 过 noGlobals 参数指定是否算上全局变量（比如console，不需要声明就可用），默认是 false
  • removeBinding(name) 删除某个 binding
  • hasBinding(name, noGlobals) 从当前作用域查找 binding，可以指定是否算上全局变量，默认是 false
  • moveBindingTo(name, scope) 把当前作用域中的某个 binding 移动到其他作用域
  • generateUid(name) 生成作用域内唯一的名字，根据 name 添- 加下划线，比如 name 为 a，会尝试生成 _a，如果被占用就会- 生成 __a，直到生成没有被使用的名字。

← Babel 插件手册 →

陕ICP备20004732号-3