← Back to rules

eslint/sort-keys スタイル

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

何を行うか

複数のプロパティを宣言する場合、プロパティ名をアルファベット順に並べることで、後で必要なプロパティを見つけることや差分を確認することがより簡単になります。

なぜ問題なのか

ソートされていないプロパティキーは、コードの読みやすさや保守性を低下させます。

例

このルールに対する誤りの例：

let myObj = {
  c: 1,
  a: 2,
};

このルールに対する正しい例：

let myObj = {
  a: 2,
  c: 1,
};

設定

1 番目のオプション

type: "desc" | "asc"

キーの並べ替え順序。昇順（"asc"）または降順（"desc"）のどちらかを受け入れます。

2 番目のオプション

このオプションは以下のプロパティを持つオブジェクトです：

allowLineSeparatedGroups

type: boolean

default: false

true の場合、空行で区切られたプロパティグループは個別に並べ替えられます。

caseSensitive

type: boolean

default: true

並べ替え比較が大文字小文字を区別するかどうか（true なら A < a となる）。

minKeys

type: integer

default: 2

並べ替えが適用される前に、オブジェクトに必要な最低限のプロパティ数。

natural

type: boolean

default: false

自然順序（例： "a2" が "a10" よりも前に来る）を使用します。

使用方法

設定ファイルまたは CLI でこのルールを有効化するには、次のように使用できます：

Config (.oxlintrc.json)

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

CLI

oxlint --deny sort-keys

参照

• ルールのソース