Qodana 2024.1 ヘルプ

Qodana を自分好みに設定する

Qodana インスペクションプロファイルは、使用するインスペクションを構成します。有効にするインスペクションが少なすぎると、重大な問題を見逃す可能性があり、プロジェクト全体に影響を及ぼします。一方、有効なインスペクションが多すぎると、インスペクションのパフォーマンスに悪影響が生じ、プロジェクトに無関係なインスペクションが使用される可能性があります。

Qodana は、ほとんどの場合に便利なデフォルトの qodana.starter および qodana.recommended プロファイルを提供します。必要に応じてデフォルトのプロファイルをオーバーライドできます。このセクションでは、カスタム YAML プロファイルセクションから抜粋した基本的な推奨事項を提供します。

初期構成

  1. プロジェクトのルートに、YAML 形式のファイルを作成します。次の構成を保存します。これには、Qodana プロファイルに名前を付け、qodana.recommended プロファイルをオーバーライドするための name ブロックBaseProfile ブロックが含まれます。

    name: "Configuring Qodana" # Paste the name of your profile baseProfile: qodana.recommended # Override qodana.recommended
  2. qodana.yaml ファイルに、前の手順で構成したファイルへのパスを指定します。

    profile: path: <relative-path-to-yaml-config-file>

JavaScript と TypeScript インスペクションを有効にする

Qodana のバージョン 2023.2 以降、すべてのリンターは JavaScript と TypeScript インスペクションを提供しますが、デフォルトでは無効になっています。 inspections ブロックを使用して JavaScript and TypeScript インスペクションカテゴリを有効にできるため、構成は次のようになります。

name: "Configuring Qodana" baseProfile: qodana.recommended inspections: - group: "category:JavaScript and TypeScript" # Specify the inspection category enabled: true # Enable the JavaScript and TypeScript category

特定のインスペクションを除外する

PHP 用の Qodana リンターを実行する前に、qodana.recommended プロファイルでサポートされている PhpDeprecationInspection インスペクションを除外するとします。この場合、次のように構成を更新できます。

name: "Configuring Qodana" baseProfile: qodana.recommended inspections: - group: "category:JavaScript and TypeScript" enabled: true - inspection: PhpDeprecationInspection # Specify an inspection enabled: false # Disable the inspection

インスペクションパスを指定してください

コードのインスペクション中に特定のパスを無視するように Qodana に指示できます。プロジェクトルートの vendor ディレクトリを無視したいとします。これは、 ignore ブロックを使用して実行できます。最終的な構成は次のようになります。

name: "Configuring Qodana" baseProfile: qodana.recommended inspections: - group: "category:JavaScript and TypeScript" enabled: true ignore: - "vendor/**" # Ignore the vendor directory - inspection: PhpDeprecationInspection enabled: false

詳細

高度な構成テクニック、その他の構成例、最初からの構成の作成について詳しくは、カスタム YAML プロファイルセクションにアクセスしてください。

Qodana を構成したら、クイックスタートセクションの推奨事項を使用して実行できます。