com.google.javascript.jscomp.lint

Class CheckRequiresAndProvidesSorted

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractShallowCallback

com.google.javascript.jscomp.lint.CheckRequiresAndProvidesSorted

All Implemented Interfaces:

CompilerPass, HotSwapCompilerPass, NodeTraversal.Callback

public final class CheckRequiresAndProvidesSorted
extends NodeTraversal.AbstractShallowCallback
implements HotSwapCompilerPass

Checks that goog.require() and goog.provide() calls are sorted alphabetically.

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticType	DUPLICATE_REQUIRE
static DiagnosticType	PROVIDES_AFTER_REQUIRES
static DiagnosticType	PROVIDES_NOT_SORTED
static DiagnosticType	REQUIRES_NOT_SORTED

Constructor Summary

Constructors

Constructor and Description
CheckRequiresAndProvidesSorted(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getSortKey(Node n)
void	hotSwapScript(Node scriptRoot, Node originalRoot) Process the JS with root node root.
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 have been visited).

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

shouldTraverse

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

PROVIDES_NOT_SORTED

public static final DiagnosticType PROVIDES_NOT_SORTED

PROVIDES_AFTER_REQUIRES

public static final DiagnosticType PROVIDES_AFTER_REQUIRES

DUPLICATE_REQUIRE

public static final DiagnosticType DUPLICATE_REQUIRE

Constructor Detail

CheckRequiresAndProvidesSorted

public CheckRequiresAndProvidesSorted(AbstractCompiler compiler)

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

hotSwapScript

public void hotSwapScript(Node scriptRoot,
                          Node originalRoot)

Description copied from interface: HotSwapCompilerPass

Process the JS with root node root. This is supposed to be significantly faster compared to corresponding full-compiler passes.

Specified by:

hotSwapScript in interface HotSwapCompilerPass

Parameters:

scriptRoot - Root node corresponding to the file that is modified, should be of type Token.SCRIPT.

originalRoot - Root node corresponding to the original version of the file that is modified. Should be of type token.SCRIPT.

getSortKey

public static final java.lang.String getSortKey(Node n)

visit

public void visit(NodeTraversal t,
                  Node n,
                  Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in postorder (after its children have been visited). A node is visited only if all its parents should be traversed (NodeTraversal.Callback.shouldTraverse(NodeTraversal, Node, Node)).

Implementations can have side effects (e.g. modifying the parse tree).

Specified by:

visit in interface NodeTraversal.Callback