useSymbolDescription (JavaScript)

Language JavaScript (and super languages)

Summary

Rule available since: v2.0.0
Diagnostic Category: lint/style/useSymbolDescription
This rule isn’t recommended, so you need to enable it.
This rule doesn’t have a fix.
The default severity of this rule is information.
Sources:
- Same as symbol-description

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "style": {
5
        "useSymbolDescription": "error"
6
      }
7
    }
8
  }
9
}

Description

Require a description parameter for the Symbol().

Symbol can have an optional description parameter which can be useful for debugging and making the purpose of the symbol clearer.

Examples

Invalid

1
Symbol();

code-block.js:1:7 lint/style/useSymbolDescription ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Symbol() is missing a description parameter.
  
  > 1 │ Symbol();
      │       ^^
    2 │ 
  
  ℹ Add explicit description which can be useful in debugging and making the purpose of the symbol clearer.

1
Symbol('');

code-block.js:1:7 lint/style/useSymbolDescription ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Symbol() is missing a description parameter.
  
  > 1 │ Symbol('');
      │       ^^^^
    2 │ 
  
  ℹ Add explicit description which can be useful in debugging and making the purpose of the symbol clearer.

1
 Symbol(``);

code-block.js:1:8 lint/style/useSymbolDescription ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Symbol() is missing a description parameter.
  
  > 1 │  Symbol(``);
      │        ^^^^
    2 │ 
  
  ℹ Add explicit description which can be useful in debugging and making the purpose of the symbol clearer.

Valid

1
Symbol('description');