com.google.javascript.jscomp

Class FindModuleDependencies

java.lang.Object

com.google.javascript.jscomp.FindModuleDependencies

All Implemented Interfaces:

NodeTraversal.Callback, NodeTraversal.ScopedCallback

public class FindModuleDependencies
extends java.lang.Object
implements NodeTraversal.ScopedCallback

Find and update any direct dependencies of an input. Used to walk the dependency graph and support a strict depth-first dependency ordering. Marks an input as providing its module name.

Discovers dependencies from:

• goog.require calls
• ES6 import statements
• CommonJS require statements

The order of dependency references is preserved so that a deterministic depth-first ordering can be achieved.

Method Summary

Modifier and Type	Method and Description
void	enterScope(NodeTraversal t) Called immediately after entering a new scope.
void	exitScope(NodeTraversal t) Called immediately before exiting a scope.
void	process(Node root)
boolean	shouldTraverse(NodeTraversal t, Node n, Node parent) Visits a node in preorder (before its children) and decides whether its children should be traversed.
void	visit(NodeTraversal t, Node n, Node parent) Visits a node in postorder (after its children).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

process

public void process(Node root)

shouldTraverse

public boolean shouldTraverse(NodeTraversal t,
                              Node n,
                              Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in preorder (before its children) and decides whether its children should be traversed. If the children should be traversed, they will be visited by NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) in preorder and by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) 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.

Specified by:

shouldTraverse in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

n - The current node.

parent - The parent of the current node.

Returns:

whether the children of this node should be visited

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.

Specified by:

visit in interface NodeTraversal.Callback

Parameters:

t - The current traversal.

n - The current node.

parent - The parent of the current node.

enterScope

public void enterScope(NodeTraversal t)

Description copied from interface: NodeTraversal.ScopedCallback

Called immediately after entering a new scope. The new scope can be accessed through t.getScope()

Specified by:

enterScope in interface NodeTraversal.ScopedCallback

exitScope

public void exitScope(NodeTraversal t)

Description copied from interface: NodeTraversal.ScopedCallback

Called immediately before exiting a scope. The ending scope can be accessed through t.getScope()

Specified by:

exitScope in interface NodeTraversal.ScopedCallback