特定の行を無視する
Aikido Code Quality では、抑制コメントを付けることで特定の行をスキップできます。これは、ルールが当てはまらない場合や、例外が意図的なものである場合に便利です。
この機能でできること(とできないこと)
- できること: Aikido にコードの 1 行を無視するよう正確に指示する方法です。
- できないこと: グローバルなミュートや、問題修正の代替ではありません。他の Aikido スキャナー(セキュリティ、シークレット、サプライチェーン)には影響しません。コードスキャンおよびシークレット検出の無視パターンもご確認ください。
抑制を使用するタイミング
正当なユースケースには次のようなものがあります:
- 変更できないサードパーティのコードや生成されたコード。
- 意図的にスタイルルールに違反する互換性シム/ポリフィル。
- 安全であることを確認済みの誤検知。
- 通常のコードでは警告を引き起こすパターンを含むテスト。
実際の問題を隠すためや、低いコード品質の近道として抑制を使用しないでください。
仕組み
コメントに次のいずれかのキーワードが含まれている場合、Aikido はその行を無視します:
NOAIKIDONO-AIKIDO
詳細:
- チェックは大文字と小文字を区別しません(noaikido、No-Aikido などすべて機能します)。
- マーカーは、スキップするコードと同じ行またはその上の行に記述する必要があります。
- マーカーの後に、人が読むための説明を追加できます。
例
Python
def compare(user_id, other_id):
# NOAIKIDO: simple equality check is fine here
return user_id == other_id JavaScript
const tmp = eval(userInput); // no-aikido: sandboxed in testsGo
// NOAIKIDO temporary debug
fmt.Println("Debug mode enabled") Java
List raw = new ArrayList(); // no-aikido: legacy interop