Struct rslint_core::groups::errors::ValidTypeof

pub struct ValidTypeof {
    pub require_string_literals: bool,
}

Enforce the use of valid string literals in a typeof comparison.

typeof can only return a small set of strings, undefined, object, boolean, number, string or function, and if you provide an invalid value, it’s most likely a typo, and the comparison will always return false. This behaviour will be denied by this rule.

Invalid Code Examples

typeof foo === "strnig"
typeof foo == "undefimed"
typeof bar != "nunber"
typeof bar !== "fucntion"

Fields

require_string_literals: bool

If this option is true, typeof expression can only be compared to valid string literals, or other typeof expressions, but can not be compared to any other value.

Implementations

impl ValidTypeof

pub fn new() -> Self

Trait Implementations

impl Clone for ValidTypeof

fn clone(&self) -> ValidTypeof

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CstRule for ValidTypeof

fn check_node(&self, node: &SyntaxNode, ctx: &mut RuleCtx) -> Option<()>

Check an individual node in the syntax tree. You can use the match_ast macro to make matching a node to an ast node easier. The reason this uses nodes and not a visitor is because nodes are more flexible, converting them to an AST node has zero cost and you can easily traverse surrounding nodes. Defaults to doing nothing.

fn check_token(&self, token: &SyntaxToken, ctx: &mut RuleCtx) -> Option<()>

Check an individual token in the syntax tree. Defaults to doing nothing.

fn check_root(&self, root: &SyntaxNode, ctx: &mut RuleCtx) -> Option<()>

Check the root of the tree one time. This method is guaranteed to only be called once. The root’s kind will be either SCRIPT or MODULE. Defaults to doing nothing.

impl Debug for ValidTypeof

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ValidTypeof

fn default() -> ValidTypeof

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ValidTypeof where
    ValidTypeof: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Rule for ValidTypeof

fn name(&self) -> &'static str

A unique, kebab-case name for the rule.

fn group(&self) -> &'static str

The name of the group this rule belongs to.

fn docs(&self) -> &'static str

Optional docs for the rule, an empty string by default

fn tags(&self) -> &'static [Tag]

A list of tags present on this rule. Empty by default.

fn recommended(&self) -> bool

Whether this rule is recommended, this is a simple helper around Self::tags.

impl Serialize for ValidTypeof

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.