← Back to rules

unicorn/prefer-keyboard-event-key スタイル

An auto-fix is available for this rule.

何を実行するか

KeyboardEvent#key が非推奨になった KeyboardEvent#keyCode に代わって使用することを強制します。.key プロパティはより意味的に明確で読みやすいです。

なぜ悪いのか

keyCode、which、charCode のプロパティは非推奨であり、key プロパティの代替として避けるべきです。

例

このルールに違反する誤ったコードの例：

window.addEventListener("keydown", (event) => {
  if (event.keyCode === 8) {
    console.log("Backspace was pressed");
  }
});

window.addEventListener("keydown", (event) => {
  console.log(event.keyCode);
});

このルールに準拠する正しいコードの例：

window.addEventListener("keydown", (event) => {
  if (event.key === "Backspace") {
    console.log("Backspace was pressed");
  }
});

window.addEventListener("click", (event) => {
  console.log(event.key);
});

使い方

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

Config (.oxlintrc.json)

{
  "rules": {
    "unicorn/prefer-keyboard-event-key": "error"
  }
}

CLI

oxlint --deny unicorn/prefer-keyboard-event-key

参照

• ルールのソース