Class CheckConformance

  • All Implemented Interfaces:
    CompilerPass, NodeTraversal.Callback

    @GwtIncompatible("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}

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