com.google.javascript.jscomp.lint

Class CheckNullabilityModifiers

java.lang.Object

com.google.javascript.jscomp.NodeTraversal.AbstractPostOrderCallback

com.google.javascript.jscomp.lint.CheckNullabilityModifiers

All Implemented Interfaces:

CompilerPass, NodeTraversal.Callback

public class CheckNullabilityModifiers
extends NodeTraversal.AbstractPostOrderCallback
implements CompilerPass

Checks for missing or redundant nullability modifiers.

Primitive and literal types should not be preceded by a `!` modifier. Reference types must be preceded by a `?` or `!` modifier.

Field Summary

Fields

Modifier and Type	Field and Description
static DiagnosticType	MISSING_NULLABILITY_MODIFIER_JSDOC The diagnostic for a missing nullability modifier.
static DiagnosticType	NULL_MISSING_NULLABILITY_MODIFIER_JSDOC The diagnostic for a missing nullability modifier, where the value is clearly nullable.
static DiagnosticType	REDUNDANT_NULLABILITY_MODIFIER_JSDOC The diagnostic for a redundant nullability modifier.

Constructor Summary

Constructors

Constructor and Description
CheckNullabilityModifiers(AbstractCompiler compiler)

Method Summary

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

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

shouldTraverse

Methods inherited from class java.lang.Object

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

Field Detail

MISSING_NULLABILITY_MODIFIER_JSDOC

public static final DiagnosticType MISSING_NULLABILITY_MODIFIER_JSDOC

The diagnostic for a missing nullability modifier.

NULL_MISSING_NULLABILITY_MODIFIER_JSDOC

public static final DiagnosticType NULL_MISSING_NULLABILITY_MODIFIER_JSDOC

The diagnostic for a missing nullability modifier, where the value is clearly nullable.

REDUNDANT_NULLABILITY_MODIFIER_JSDOC

public static final DiagnosticType REDUNDANT_NULLABILITY_MODIFIER_JSDOC

The diagnostic for a redundant nullability modifier.

Constructor Detail

CheckNullabilityModifiers

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

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.