eslint/sort-vars Pedantic

🚧 An auto-fix is planned for this rule, but not implemented at this time.

What it does

When declaring multiple variables within the same block, sorting variable names make it easier to find necessary variable easier at a later time.

Why is this bad?

Unsorted variable declarations can make the code harder to read and maintain.

Examples

Examples of incorrect code for this rule:

var b, a;
var a, B, c;

Examples of correct code for this rule:

var a, b, c, d;
var B, a, c;

Configuration

This rule accepts a configuration object with the following properties:

ignoreCase

type: boolean

default: false

When true, the rule ignores case-sensitivity when sorting variables.

How to use

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

CLI

oxlint --deny sort-vars

Config (.oxlintrc.json)

{
  "rules": {
    "sort-vars": "error"
  }
}

References

• Rule Source