Struct rslint_core::groups::errors::NoIrregularWhitespace

pub struct NoIrregularWhitespace {
    pub skip_strings: bool,
    pub skip_comments: bool,
    pub skip_regex: bool,
    pub skip_templates: bool,
}

Disallow weird/irregular whitespace.

ECMAScript allows a wide selection of unicode whitespace, they are however known to cause issues with various parsers, therefore they should never be used.

A lot of the whitespace is invisible, therefore is hard to detect, it may have been inserted by accident.

Whitespace such as line separator causes issues since line separators are not valid JSON which may cause many issues.

This rule disallows the following whitespace:

\u000B - Line Tabulation (\v) - <VT>
\u000C - Form Feed (\f) - <FF>
\u00A0 - No-Break Space - <NBSP>
\u0085 - Next Line
\u1680 - Ogham Space Mark
\u180E - Mongolian Vowel Separator - <MVS>
\ufeff - Zero Width No-Break Space - <BOM>
\u2000 - En Quad
\u2001 - Em Quad
\u2002 - En Space - <ENSP>
\u2003 - Em Space - <EMSP>
\u2004 - Tree-Per-Em
\u2005 - Four-Per-Em
\u2006 - Six-Per-Em
\u2007 - Figure Space
\u2008 - Punctuation Space - <PUNCSP>
\u2009 - Thin Space
\u200A - Hair Space
\u200B - Zero Width Space - <ZWSP>
\u2028 - Line Separator
\u2029 - Paragraph Separator
\u202F - Narrow No-Break Space
\u205f - Medium Mathematical Space
\u3000 - Ideographic Space

Fields

skip_strings: bool

Whether to allow any whitespace in string literals (true by default)

skip_comments: bool

Whether to allow any whitespace in comments (false by default)

skip_regex: bool

Whether to allow any whitespace in regular expressions (false by default)

skip_templates: bool

Whether to allow any whitespace in template literals (false by default)

Implementations

impl NoIrregularWhitespace

pub fn new() -> Self

Trait Implementations

impl Clone for NoIrregularWhitespace

fn clone(&self) -> NoIrregularWhitespace

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CstRule for NoIrregularWhitespace

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.

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.

impl Debug for NoIrregularWhitespace

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

Formats the value using the given formatter.

impl Default for NoIrregularWhitespace

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for NoIrregularWhitespace where
    NoIrregularWhitespace: 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 NoIrregularWhitespace

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

impl Serialize for NoIrregularWhitespace

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

Serialize this value into the given Serde serializer.