com.google.javascript.jscomp

Class CheckConformance

java.lang.Object

com.google.javascript.jscomp.CheckConformance

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

@GwtIncompatible(value="com.google.protobuf")
public final class CheckConformance
extends java.lang.Object
implements NodeTraversal.Callback, CompilerPass

Provides a framework for checking code against a set of user configured conformance rules. The rules are specified by the ConformanceConfig proto, which allows for both standard checks (forbidden properties, variables, or dependencies) and allow for more complex checks using custom rules than specify

Conformance violations are both reported as compiler errors, and are also reported separately to the {cI gue@link ErrorManager}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CheckConformance.InvalidRequirementSpec
static interface	CheckConformance.Rule

Method Summary

Modifier and Type	Method and Description
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 pre order (before visiting its children) and decides whether this node's children should be traversed.
void	visit(NodeTraversal t, Node n, Node parent) Visits a node in postorder (after its children have been visited).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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 t,
                                    Node n,
                                    Node parent)

Description copied from interface: NodeTraversal.Callback

Visits a node in pre order (before visiting its children) and decides whether this node's children should be traversed. If children are traversed, they will be visited by NodeTraversal.Callback.visit(NodeTraversal, Node, Node) in postorder.

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

Specified by:

shouldTraverse in interface NodeTraversal.Callback

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