Class CheckProvidesSorted
- java.lang.Object
-
- com.google.javascript.jscomp.lint.CheckProvidesSorted
-
- All Implemented Interfaces:
NodeTraversal.Callback
public final class CheckProvidesSorted extends java.lang.Object implements NodeTraversal.Callback
Checks that goog.provide statements 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
CheckProvidesSorted.Mode
Operation modes.
-
Field Summary
Fields Modifier and Type Field Description static DiagnosticType
PROVIDES_NOT_SORTED
-
Constructor Summary
Constructors Constructor Description CheckProvidesSorted(CheckProvidesSorted.Mode mode)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Node
getFirstNode()
Returns the node for the first recognized provide statement.Node
getLastNode()
Returns the node for the last recognized provide statement.java.lang.String
getReplacement()
Returns a textual replacement yielding a canonical version of the provides.boolean
needsFix()
Returns whether the provides 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 its children should be traversed.void
visit(NodeTraversal t, Node n, Node parent)
Visits a node in postorder (after its children).
-
-
-
Field Detail
-
PROVIDES_NOT_SORTED
public static final DiagnosticType PROVIDES_NOT_SORTED
-
-
Constructor Detail
-
CheckProvidesSorted
public CheckProvidesSorted(CheckProvidesSorted.Mode mode)
-
-
Method Detail
-
getFirstNode
public Node getFirstNode()
Returns the node for the first recognized provide statement.
-
getLastNode
public Node getLastNode()
Returns the node for the last recognized provide statement.
-
getReplacement
public java.lang.String getReplacement()
Returns a textual replacement yielding a canonical version of the provides.
-
needsFix
public boolean needsFix()
Returns whether the provides need to be fixed, i.e., whether they are *not* already canonical.
-
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 byNodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node)
in preorder and byNodeTraversal.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 interfaceNodeTraversal.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 iffNodeTraversal.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 interfaceNodeTraversal.Callback
- Parameters:
t
- The current traversal.n
- The current node.parent
- The parent of the current node.
-
-