← Back to rules

eslint/symbol-description Pedantic

What it does

Require symbol descriptions.

Why is this bad?

The Symbol function may have an optional description.

var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);

Using description promotes easier debugging: when a symbol is logged the description is used:

var foo = Symbol("some description");

console.log(foo);
// prints - Symbol(some description)

Examples

Examples of incorrect code for this rule:

var foo = Symbol();

Examples of correct code for this rule:

var foo = Symbol("some description");

How to use

To enable this rule using the config file or in the CLI, you can use:

Config (.oxlintrc.json)

{
  "rules": {
    "symbol-description": "error"
  }
}

Config (oxlint.config.ts)

import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "symbol-description": "error",
  },
});

CLI

oxlint --deny symbol-description

References

• Rule Source
• Open rule in Oxc Playground