Class SourceInformationAnnotator

  • All Implemented Interfaces:
    NodeTraversal.Callback

    public final class SourceInformationAnnotator
    extends NodeTraversal.AbstractPostOrderCallback
    Annotates nodes with information from their original input file before the compiler performs work that changes this information (such as its original location, its original name, etc).

    Information saved:

    • Annotates all NAME nodes with an ORIGINALNAME_PROP indicating its original name.
    • Annotates all GETPROP and OPTCHAIN_GETPROP nodes with an original name.
    • Annotates all OBJECT_LITERAL unquoted string key nodes with an original name.
    • Annotates all FUNCTION nodes with an original name indicating its nearest original name.
    • Method Detail

      • visit

        public void visit​(NodeTraversal t,
                          Node n,
                          Node parent)
        Description copied from interface: NodeTraversal.Callback
        Visits a node in postorder (after its children). A node is visited in postorder iff NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) returned true for its parent. In particular, the root node is never visited in postorder.

        Siblings are always visited left-to-right.

        Implementations can have side-effects (e.g. modify the parse tree). Removing the current node is legal, but removing or reordering nodes above the current node may cause nodes to be visited twice or not at all.

        Parameters:
        t - The current traversal.
        n - The current node.
        parent - The parent of the current node.
      • isStringNodeRequiringOriginalName

        public static boolean isStringNodeRequiringOriginalName​(Node node)
        Whether JSCompiler attempts to preserve the original string attached to this node on the AST post-mangling and in source maps.