Package com.google.javascript.jscomp.lint

Class CheckNestedNames

java.lang.Object

com.google.javascript.jscomp.lint.CheckNestedNames

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

public final class CheckNestedNames
extends java.lang.Object
implements CompilerPass, NodeTraversal.Callback

Checks if code has a module-level static property assignment (`X.Y`) inside a `goog.module`. If yes, reports a linter warning on the `X.Y` if:

1. X is any name {object, class, function, interface, enum, typedef}.
2. Y is {class, interface, enum, typedef}

For example, reports a linter finding in the following:

{ @code

 class C {}
 let obj = {...};

 /**
 * Reports nested name E on class C.
 * @enum {number}
 * /
 C.E={...}; // WARNING:

 /**
 * Reports nested interface I on variable obj.
 * @interface
 * /
 obj.I=class {}; // WARNING:

 // reports nested name D on class C.
 C.D=class {};
 }
 

 // Does not report on nested functions, or any nested property assigned to a value.
 C.F = function() {}
 obj.S = '';
 obj.Some = new Something();
 

Field Summary

Fields

Modifier and Type	Field	Description
static DiagnosticType	NESTED_NAME_IN_GOOG_MODULE

Constructor Summary

Constructors

Constructor	Description
CheckNestedNames(AbstractCompiler compiler)

Method Summary

Modifier and Type	Method	Description
void	process(Node externs, Node root)	Process the JS with root node root.
boolean	shouldTraverse(NodeTraversal nodeTraversal, 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

NESTED_NAME_IN_GOOG_MODULE

public static final DiagnosticType NESTED_NAME_IN_GOOG_MODULE

Constructor Detail

CheckNestedNames

public CheckNestedNames(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

shouldTraverse

public final boolean shouldTraverse(NodeTraversal nodeTraversal,
                                    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:

nodeTraversal - 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.