ConformanceRules.BanSettingAttributes

java.lang.Object

com.google.javascript.jscomp.ConformanceRules.AbstractRule

com.google.javascript.jscomp.ConformanceRules.BanSettingAttributes

All Implemented Interfaces:: CheckConformance.Rule

Enclosing class:: ConformanceRules

public static final class ConformanceRules.BanSettingAttributes extends ConformanceRules.AbstractRule

Can be used to ban any function like Element#setAttribute which takes two parameters, an attribute name and a value.

The specific attribute names that are banned are specified in SecuritySensitiveAttributes.BANNED_ATTRS.

Constructor Summary

Constructors

Constructor

Description

BanSettingAttributes(AbstractCompiler compiler, com.google.javascript.jscomp.Requirement requirement)

Create a custom checker to ban a function like Element#setAttribute based on a conformance requirement spec.
Method Summary

Modifier and Type

Method

Description

protected ConformanceRules.ConformanceResult

checkConformance(NodeTraversal traversal, Node node)

Methods inherited from class com.google.javascript.jscomp.ConformanceRules.AbstractRule
check, report, tsIsAllowlisted

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.google.javascript.jscomp.CheckConformance.Rule
getPrecondition

Constructor Details
- BanSettingAttributes
  
  public BanSettingAttributes(AbstractCompiler compiler, com.google.javascript.jscomp.Requirement requirement) throws CheckConformance.InvalidRequirementSpec
  
  Create a custom checker to ban a function like Element#setAttribute based on a conformance requirement spec.
  Names in value fields indicate the functions that should be blocked. Throws CheckConformance.InvalidRequirementSpec if the requirement is malformed.
  
  Throws:
  
  CheckConformance.InvalidRequirementSpec
Method Details
- checkConformance
  
  protected ConformanceRules.ConformanceResult checkConformance(NodeTraversal traversal, Node node)
  
  Specified by:
  
  checkConformance in class ConformanceRules.AbstractRule
  
  Returns:
  
  Whether the code represented by the Node conforms to the rule.