Package com.google.javascript.jscomp.lint

Class CheckRequiresSorted

java.lang.Object

com.google.javascript.jscomp.lint.CheckRequiresSorted

All Implemented Interfaces:

NodeTraversal.Callback

public final class CheckRequiresSorted
extends java.lang.Object
implements NodeTraversal.Callback

Checks that Closure import statements (goog.require, goog.requireType, and goog.forwardDeclare) are sorted and deduplicated, exposing the necessary information to produce a suggested fix.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CheckRequiresSorted.Mode	Operation modes.

Field Summary

Fields

Modifier and Type	Field	Description
static DiagnosticType	REQUIRES_NOT_SORTED

Constructor Summary

Constructors

Constructor	Description
CheckRequiresSorted(CheckRequiresSorted.Mode mode)

Method Summary

Modifier and Type	Method	Description
Node	getFirstNode()	Returns the node for the first recognized import statement.
Node	getLastNode()	Returns the node for the last recognized import statement.
java.lang.String	getReplacement()	Returns a textual replacement yielding a canonical version of the imports.
boolean	needsFix()	Returns whether the imports need to be fixed, i.e., whether they are *not* already canonical.
boolean	shouldTraverse(NodeTraversal t, Node n, Node parent)	Visits a node in preorder (before its children) and decides whether the node and 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

Field Detail

REQUIRES_NOT_SORTED

public static final DiagnosticType REQUIRES_NOT_SORTED

Constructor Detail

CheckRequiresSorted

public CheckRequiresSorted(CheckRequiresSorted.Mode mode)

Method Detail

getFirstNode

public Node getFirstNode()

Returns the node for the first recognized import statement.

getLastNode

public Node getLastNode()

Returns the node for the last recognized import statement.

getReplacement

public java.lang.String getReplacement()

Returns a textual replacement yielding a canonical version of the imports.

needsFix

public boolean needsFix()

Returns whether the imports need to be fixed, i.e., whether they are *not* already canonical.

shouldTraverse

public final 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 the node and its children should be traversed.

If this method returns true, the node will be visited by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) in postorder and its children will be visited by both NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) in preorder and by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) in postorder.

If this method returns false, the node will not be visited by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) and its children will neither be visited by NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node) nor NodeTraversal.Callback.visit(NodeTraversal, Node, Node).

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 final 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 and itself. 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.