sort-vars

要求在同一個宣告區塊內的變數必須排序

🔧

此規則報告的某些問題可以透過 --fix 命令列選項自動修正

在同一個區塊中宣告多個變數時，有些開發人員偏好依字母順序排序變數名稱，以便在稍後更容易找到所需的變數。其他人則認為這增加了複雜性，並成為維護的負擔。

規則詳情

此規則會檢查所有變數宣告區塊，並驗證所有變數是否依字母順序排序。此規則的預設設定為區分大小寫。

此規則的不正確程式碼範例

/*eslint sort-vars: "error"*/

var b, a;

var a, B, c;

var a, A;
1
2
3
4
5
6
7

此規則的正確程式碼範例

在遊樂場中開啟

/*eslint sort-vars: "error"*/

var a, b, c, d;

var _a = 10;
var _b = 20;

var A, a;

var B, a, c;
1
2
3
4
5
6
7
8
9
10

字母順序列表是從第一個變數開始維護的，並排除任何被視為問題的變數。因此，以下程式碼將產生兩個問題

/*eslint sort-vars: "error"*/

var c, d, a, b;
1
2
3

但這一個只會產生一個

/*eslint sort-vars: "error"*/

var c, d, a, e;
1
2
3

此規則有一個物件選項

在 { "ignoreCase": true } 選項下，此規則的正確程式碼範例

在遊樂場中開啟

/*eslint sort-vars: ["error", { "ignoreCase": true }]*/

var a, A;

var a, B, c;
1
2
3
4
5

此規則是一種格式偏好，不遵循它不會對您的程式碼品質產生負面影響。如果字母排序變數不是您的程式碼標準的一部分，那麼您可以關閉此規則。

此規則是在 ESLint v0.2.0 中引入的。

編輯此頁面