com.google.javascript.jscomp.lint

Class CheckConstantCaseNames

java.lang.Object

com.google.javascript.jscomp.lint.CheckConstantCaseNames

All Implemented Interfaces:

CompilerPass, HotSwapCompilerPass, NodeTraversal.Callback

public class CheckConstantCaseNames
extends java.lang.Object
implements NodeTraversal.Callback, HotSwapCompilerPass

This pass looks for module-level variable declarations that use CONSTANT_CASE, according to the Google style guide, and verifies that they are also annotated @const or are in a const clause.

This pass could be extended to check CONSTANT_CASE properties in the future.

Non-module-level variables should always use camel case according to the Google style guide. In order to not confuse users, this pass does not warn that they should be @const. (A more correct lint check could warn that non-module-locals should not be constant case.)

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticType	MISSING_CONST_PROPERTY
static DiagnosticType	REASSIGNED_CONSTANT_CASE_NAME

Constructor Summary

Constructors

Constructor and Description
CheckConstantCaseNames(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method and Description
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.
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

Field Detail

MISSING_CONST_PROPERTY

public static final DiagnosticType MISSING_CONST_PROPERTY

REASSIGNED_CONSTANT_CASE_NAME

public static final DiagnosticType REASSIGNED_CONSTANT_CASE_NAME

Constructor Detail

CheckConstantCaseNames

public CheckConstantCaseNames(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.

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.