walkIdentifiers() — vue Function Reference

Architecture documentation for the walkIdentifiers() function in babelUtils.ts from the vue codebase.

Function typescript CompilerSFC ScriptCompiler calls 5 called by 3

Entity Profile

CompilerSFC→ ScriptCompiler→ walkIdentifiers() — vue Function Reference

Dependency Diagram

graph TD
  eb301be5_f530_960e_129f_798877ea7f83["walkIdentifiers()"]
  16b5f9ed_1e09_eff8_5797_7cb90fc86d37["compileScript()"]
  16b5f9ed_1e09_eff8_5797_7cb90fc86d37 -->|calls| eb301be5_f530_960e_129f_798877ea7f83
  0f4b2d12_1485_be8c_d799_815c5d739d57["processExp()"]
  0f4b2d12_1485_be8c_d799_815c5d739d57 -->|calls| eb301be5_f530_960e_129f_798877ea7f83
  da297c1b_76f1_4af5_5266_fee8757f87ed["prefixIdentifiers()"]
  da297c1b_76f1_4af5_5266_fee8757f87ed -->|calls| eb301be5_f530_960e_129f_798877ea7f83
  3b969150_5597_0548_8251_6f12c0644b67["isReferencedIdentifier()"]
  eb301be5_f530_960e_129f_798877ea7f83 -->|calls| 3b969150_5597_0548_8251_6f12c0644b67
  5fee095c_1592_ad66_e831_5c09154637d6["isFunctionType()"]
  eb301be5_f530_960e_129f_798877ea7f83 -->|calls| 5fee095c_1592_ad66_e831_5c09154637d6
  ed6d52fa_60a9_2e8f_6c01_9292d24121d8["walkFunctionParams()"]
  eb301be5_f530_960e_129f_798877ea7f83 -->|calls| ed6d52fa_60a9_2e8f_6c01_9292d24121d8
  43c62e56_9ebc_fc36_915f_af5e7c065dd6["markScopeIdentifier()"]
  eb301be5_f530_960e_129f_798877ea7f83 -->|calls| 43c62e56_9ebc_fc36_915f_af5e7c065dd6
  ba00ad14_1a95_475e_df8a_aaa28d1487cc["walkBlockDeclarations()"]
  eb301be5_f530_960e_129f_798877ea7f83 -->|calls| ba00ad14_1a95_475e_df8a_aaa28d1487cc
  style eb301be5_f530_960e_129f_798877ea7f83 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

packages/compiler-sfc/src/babelUtils.ts lines 15–85

export function walkIdentifiers(
  root: Node,
  onIdentifier: (
    node: Identifier,
    parent: Node,
    parentStack: Node[],
    isReference: boolean,
    isLocal: boolean
  ) => void,
  onNode?: (node: Node) => void
) {
  const includeAll = false
  const parentStack: Node[] = []
  const knownIds: Record<string, number> = Object.create(null)

  const rootExp =
    root.type === 'Program' &&
    root.body[0].type === 'ExpressionStatement' &&
    root.body[0].expression

  ;(walk as any)(root, {
    enter(node: Node & { scopeIds?: Set<string> }, parent: Node | undefined) {
      parent && parentStack.push(parent)
      if (
        parent &&
        parent.type.startsWith('TS') &&
        parent.type !== 'TSAsExpression' &&
        parent.type !== 'TSNonNullExpression' &&
        parent.type !== 'TSTypeAssertion'
      ) {
        return this.skip()
      }

      if (onNode) onNode(node)

      if (node.type === 'Identifier') {
        const isLocal = !!knownIds[node.name]
        const isRefed = isReferencedIdentifier(node, parent!, parentStack)
        if (includeAll || (isRefed && !isLocal)) {
          onIdentifier(node, parent!, parentStack, isRefed, isLocal)
        }
      } else if (
        node.type === 'ObjectProperty' &&
        parent!.type === 'ObjectPattern'
      ) {
        // mark property in destructure pattern
        ;(node as any).inPattern = true
      } else if (isFunctionType(node)) {
        // walk function expressions and add its arguments to known identifiers
        // so that we don't prefix them
        walkFunctionParams(node, id => markScopeIdentifier(node, id, knownIds))
      } else if (node.type === 'BlockStatement') {
        // #3445 record block-level local variables
        walkBlockDeclarations(node, id =>
          markScopeIdentifier(node, id, knownIds)
        )
      }
    },
    leave(node: Node & { scopeIds?: Set<string> }, parent: Node | undefined) {
      parent && parentStack.pop()
      if (node !== rootExp && node.scopeIds) {
        for (const id of node.scopeIds) {
          knownIds[id]--
          if (knownIds[id] === 0) {
            delete knownIds[id]
          }
        }
      }
    }
  })
}