FAQ
なぜフォーマットにESLintを使うのですか?
理由を参照してください。
スタイルルールとは何ですか?
typescript-eslint
の定義によると、ほとんどのLintルールは次の2つまたは3つのカテゴリのいずれかに分類されます。
- 論理的: コードのロジックと実行時の動作に関するルール(awaitの欠落や無効な論理チェックなど)。
- スタイル的: 一般的にコードの実行時の動作に影響を与えない、スタイルに関するルール。これらは主に命名、またはどの程度の同等の構文構造を使用するか(関数宣言とアロー関数など)に関するものです。
- フォーマット: Trivia(セミコロン、空白など)のみに関わるスタイルルールのサブセットであり、コードの実行時の動作には影響しません。これらのルールは、Prettierなどの専用フォーマッタと競合する可能性があります。
ESLint Stylisticでは、eslint
とtypescript-eslint
から継承されたフォーマットルールとスタイルルールに主に焦点を当てています。一部のスタイルルールは維持しますが、すべてが含まれるわけではありません。それらの包含は、アップストリームプロジェクトがそれらを保持することを選択するかどうかによって異なります。メンテナンスフェーズに移行し、実験的なルールを導入するためのインフラストラクチャを開発する際には、コミュニティから提案された新しいルールを歓迎します。詳細については、プロジェクトの進捗をご覧ください。
ESLint Stylisticの要件は何ですか?
ルールの大部分はESLint v8とtypescript-eslint
v6から移行されているため、同じ要件を継承しています。
- Node.js >=v16.0.0
- ESLint >=v8.40.0
保存時に自動フォーマットするにはどうすればよいですか?
VS Code
VS Code ESLint拡張機能をインストールします。
次の設定を.vscode/settings.json
に追加します。
jsonc
{
"editor.formatOnSave": false,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
},
}
JetBrains IDE
- 設定ダイアログ(
Ctrl + Alt + S
)を開きます。 言語とフレームワーク -> JavaScript -> コード品質ツール -> ESLint
に移動します。保存時にeslint --fixを実行する
チェックボックスを選択します。
JetBrainsドキュメントを参照してください。
コードスタイルのエラーメッセージ(波線)が煩わしい
VS Codeを使用している場合は、.vscode/settings.json
で次の設定を使用してオーバーライドできます。
jsonc
{
"eslint.rules.customizations": [
{
"rule": "@stylistic/*",
"severity": "off"
}
]
}
これは、VS Codeにエディターでエラーを表示しないように指示しますが、それでも自動修正する機能は保持します。
どのように移行できますか?
移行ガイドを参照してください。
いつ移行すればよいですか?
移行ガイドも参照してください。