Skip to content

行内無視コメント

無視コメントは、一般的には正しいが、コードの小さな特定範囲では無効にする必要がある場合に使用するエスケープ機構です。行内コメントは設定ファイルを上書きします。

Oxlint は行コメント(//)とブロックコメント(/* */)をサポートしています。コメントは以下のキーワードのいずれかで始まる必要があります。

oxlint-disable

ファイルの残りの部分、または再度有効化されるまで、1つ以上のルールを無効にします。

js
// ファイルの残りの部分ですべての Oxlint ルールを無効化
/* oxlint-disable */

// 本ファイル内の単一のルールを無効化
/* oxlint-disable no-console */

// 本ファイル内の複数のルールを無効化
/* oxlint-disable no-console, typescript/no-floating-promises */

oxlint-enable

ファイルの残りの部分、または再度無効化されるまで、1つ以上のルールを有効にします。

js
/* oxlint-enable no-console */

/* oxlint-enable no-console, no-alert */

oxlint-disable-line

現在の行で1つ以上のルールを無効にします。

js
console.log("Hello, world!"); // oxlint-disable-line no-console

console.log(x++); // oxlint-disable-line no-console, no-plusplus

oxlint-disable-next-line

コメントの次の行で1つ以上のルールを無効にし、その後の行では再び有効になります。

js
// oxlint-disable-next-line no-console
console.log("Hello, world!"); // 前のコメントにより許可される
console.log(x++); // 前のコメントは前の行にのみ適用されたため、許可されない

// oxlint-disable-next-line no-console, no-plusplus
console.log("Hello, world!"); // 許可される

ESLint 互換性

既存の ESLint コードベースとの互換性のために、oxlinteslint に置き換えた同じキーワードもサポートされています。たとえば /* eslint-disable */// eslint-disable-next-line です。

推奨される形式は oxlint-* です。eslint-* 形式は、まだ Oxlint がサポートしていないルールの移行中に便利です。

行内でのルールオプションの変更は不可能

無視コメントはルールの有効・無効切り替えはできますが、ルールオプションの変更はできません。ルールオプションは設定ファイルに記述すべきです。

無用な無視コメントの報告

無用な無視コメントの報告はデフォルトで無効になっています。有効にすると、その行に診断メッセージが発生しなかった場合でも、// oxlint-disable-line などのコメントが報告されます。

報告を有効化する:

bash
oxlint --report-unused-disable-directives

深刻度を指定する:

bash
oxlint --report-unused-disable-directives-severity error

これらのオプションは同時に1つだけ使用できます。