Package com.google.javascript.jscomp.lint

Class CheckExtraRequires

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

com.google.javascript.jscomp.lint.CheckExtraRequires

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

public class CheckExtraRequires
extends NodeTraversal.AbstractPostOrderCallback
implements CompilerPass

Walks the AST looking for usages of qualified names, and 'goog.require's of those names. Then, reconciles the two lists, and reports warning for any unnecessary require statements.

Field Summary

Fields

Modifier and Type	Field	Description
static DiagnosticType	EXTRA_REQUIRE_WARNING

Constructor Summary

Constructors

Constructor	Description
CheckExtraRequires(AbstractCompiler compiler, @Nullable com.google.common.collect.ImmutableSet<java.lang.String> requiresToRemove)

Method Summary

Modifier and Type	Method	Description
void	process(Node externs, Node root)	Process the JS with root node root.
void	visit(NodeTraversal t, Node n, Node parent)	Visits a node in postorder (after its children).

Methods inherited from class com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

shouldTraverse

Methods inherited from class java.lang.Object

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

Field Detail

EXTRA_REQUIRE_WARNING

public static final DiagnosticType EXTRA_REQUIRE_WARNING

Constructor Detail

CheckExtraRequires

public CheckExtraRequires(AbstractCompiler compiler,
                          @Nullable com.google.common.collect.ImmutableSet<java.lang.String> requiresToRemove)

Parameters:

requiresToRemove - providing a non-null set to this parameter will result in only removing the goog.requires that are in this set. If this is null, it will attempt to remove all the unnecessary requires.

Method Detail

process

public void process(Node externs,
                    Node root)

Description copied from interface: CompilerPass

Process the JS with root node root. Can modify the contents of each Node tree

Specified by:

process in interface CompilerPass

Parameters:

externs - Top of external JS tree

root - Top of JS tree

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.