Skip to content
← Back to rules

eslint/sort-vars Pedantic

🛠️ An auto-fix is available for this rule for some violations.

What it does ​

Enforce sorting of variable declarations within the same block.

Why is this bad? ​

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

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

Examples ​

Examples of incorrect code for this rule:

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

Examples of correct code for this rule:

js
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 using the config file or in the CLI, you can use:

json
{
  "rules": {
    "sort-vars": "error"
  }
}
ts
import { defineConfig } from "oxlint";

export default defineConfig({
  rules: {
    "sort-vars": "error",
  },
});
bash
oxlint --deny sort-vars

Version ​

This rule was added in v0.9.3.

References ​