インスペクションプロファイル

インスペクションプロファイルは、状態、構成オプション、分析の範囲、重要度を含む、事前に構成されたインスペクションのセットです。

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

このセクションでは、既存の Qodana プロファイルを使用する方法、独自のプロファイルを作成する方法、Qodana を使用してプロジェクトを分析するためのプロファイルを設定する方法について説明します。

既存の Qodana プロファイル

すぐに使用できる Qodana プロファイルは次のとおりです。

プロファイル名	説明
`qodana.starter`	`qodana.recommended` プロファイルのサブセット（デフォルトで有効）
`qodana.recommended`	最も使いやすいインスペクションを提供し、IntelliJ IDEA などの JetBrains IDE のデフォルトプロファイルを実装しますが、以下の例外があります。デフォルトでは、Qodana は特定の言語とフレームワークに対してのみ分析を提供します。つまり、たとえば、Groovy または JavaScript インスペクションは使用可能ですが、デフォルトでは無効になっています。IDE の `INFORMATION` 重大度のインスペクションも無効になっています。 IDE でのコードのハイライトに影響するいくつかのインスペクションとグローバルインスペクションが Qodana リンターから削除されました。 IDE でまだ利用可能な不安定なインスペクションは、Qodana リンターから削除されました。
`qodana.sanity`	このプロファイルは、プロジェクトが適切に構成されているかどうかを分析するために、デフォルトで有効になっています。`qodana.sanity` インスペクションで問題が検出された場合は、他のすべての Qodana インスペクションが正しく動作しない可能性があるため、プロジェクトを再構成する必要があります。このプロファイルのインスペクションを無効にする方法については、健全性チェックを無効にするおよびプロファイルのセクションを参照してください。

プロファイル名

説明

qodana.starter

qodana.recommended プロファイルのサブセット（デフォルトで有効）

qodana.recommended

最も使いやすいインスペクションを提供し、IntelliJ IDEA などの JetBrains IDE のデフォルトプロファイルを実装しますが、以下の例外があります。

デフォルトでは、Qodana は特定の言語とフレームワークに対してのみ分析を提供します。つまり、たとえば、Groovy または JavaScript インスペクションは使用可能ですが、デフォルトでは無効になっています。IDE の INFORMATION 重大度のインスペクションも無効になっています。
IDE でのコードのハイライトに影響するいくつかのインスペクションとグローバルインスペクションが Qodana リンターから削除されました。
IDE でまだ利用可能な不安定なインスペクションは、Qodana リンターから削除されました。

qodana.sanity

このプロファイルは、プロジェクトが適切に構成されているかどうかを分析するために、デフォルトで有効になっています。qodana.sanity インスペクションで問題が検出された場合は、他のすべての Qodana インスペクションが正しく動作しない可能性があるため、プロジェクトを再構成する必要があります。

このプロファイルのインスペクションを無効にする方法については、健全性チェックを無効にするおよびプロファイルのセクションを参照してください。

これらのプロファイルは GitHub(英語) でホストされているため、詳細を知ることができます。

既存のプロファイルを設定する

YAML 形式の設定ファイルは、Qodana の汎用的な設定方法として機能します。つまり、 qodana.yaml ファイルを使用して Qodana を一度設定すれば、その設定ファイルを Docker、GitHub、JetBrains IDE、または Qodana で現在サポートされているその他のソフトウェアで Qodana を実行する際に再利用できます。設定はこれらのすべてのプラットフォームで一貫して維持されます。

qodana.recommended プロファイルを設定するには、プロジェクトルートに次の構成を含む qodana.yaml ファイルを保存します。

            version: "1.0"
             
            profile:
                name: qodana.recommended
            

IDE で、ツール | Qodana | Qodana でコード解析を試すに移動します。
Qodana の実行ダイアログの profile セクションに、プロファイル構成を貼り付けます。
profile: name: qodana.recommended
Qodana の実行ダイアログで、qodana.yaml をプロジェクトルートに保存するオプションをオンにします。
コードの分析を開始するには、実行をクリックします。

GitHub UI の設定タブで、QODANA_TOKEN 暗号化シークレット(英語)を作成し、その値としてプロジェクトトークンを保存します。
GitHub UI のアクションタブで、新しいワークフローを設定し、.github/workflows/code_quality.yml ファイルを作成します。
main、ブランチ、リリースブランチ、リポジトリに届くプルリクエストを分析するには、ワークフロー構成を .github/workflows/code_quality.yml ファイルに保存します。
name: Qodana on: workflow_dispatch: pull_request: push: branches: # Specify your branches here - main # The 'main' branch - 'releases/*' # The release branches jobs: qodana: runs-on: ubuntu-latest permissions: contents: write pull-requests: write checks: write steps: - uses: actions/checkout@v3 with: ref: ${{ github.event.pull_request.head.sha }} # to check out the actual pull request commit, not the merge commit fetch-depth: 0 # a full history is required for pull request analysis - name: 'Qodana Scan' uses: JetBrains/qodana-action@v2026.1 with: args: --profile-name qodana.recommended env: QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
ここで、--profile-name オプションは qodana.recommended プロファイルを指定します。

--profile-name オプションを使用して qodana.recommended プロファイルを設定できます。

            docker run \
               -v $(pwd):/data/project/ \
               -e QODANA_TOKEN="<cloud-project-token>" \
               jetbrains/qodana-<image> \
               --profile-name qodana.recommended
        

            qodana scan \
               -e QODANA_TOKEN="<cloud-project-token>" \
               --profile-name qodana.recommended
        

カスタムプロファイル

次の形式を使用してカスタムプロファイルを作成できます。

YAML が推奨される形式です
XML は YAML の代替として使用できます

カスタムプロファイルは、既存のプロファイルを上書きすることも、最初から作成することもできます。

このスニペットは、YAML 形式を使用して、ニーズに合わせて Qodana を微調整する方法を示しています。

version: "1.0"

profile:  
  base: 
    name: empty # Use the 'empty' profile as an initial configuration of this profile

  # name: "My custom profile" # Name of existing profile, overlaps with base.name
    
  groups: # List of configured groups
    - groupId: InspectionsToInclude
      groups:
        - "category:PHP/General" # Inspection category from the linter
        - "JSCategories" # Include the JSCategories group below
        - "PHPInspections" # Include the PHPInspections group below
    - groupId: JSCategories
      groups:
        - "category:JavaScript and TypeScript/ES2015 migration aids"
    - groupId: PHPInspections 
      inspections: #  Inspection IDs
        - PhpDeprecationInspection 
        - PhpReturnDocTypeMismatchInspection
        
  inspections: # Group invocation
    - group: InspectionsToInclude
      enabled: true # Enable the InspectionsToInclude group
    - inspection: PhpNonCompoundUseInspection
      severity: WARNING # Overriding the severity level for PhpNonCompoundUseInspection
    - inspection: MissortedModifiers
      options:
        m_requireAnnotationsFirst: false # Overriding the configuration option

imports:
  - ".qodana/profiles/other-profile.yaml" # The imported file becomes part of this profile

このスニペットには次のキーが含まれています。

ノード名	説明
`profile`	プロファイル設定のメインノード
`imports`	インポートされたプロファイルへの相対パスのリスト

プロファイル

profile:
  base: 
    name: empty

  # name: "My custom profile" # Name of existing profile, overlaps with base.name

  groups:
    - groupId: InspectionsToInclude
      groups:
        - "category:PHP/General" 

  inspections: 
    - group: InspectionsToInclude
      enabled: true

profile キーは次の要素で構成されます。

セクション	説明
`base`	プロファイル構成の基礎となるプロファイル
`name`	インスペクションプロファイルの名前。`base.name` と重複しています
`groups`	プロファイルに含めるか除外する必要があるインスペクショングループ
`inspections`	`base` に適用された変更のリスト。これらの変更はグループまたは単一のインスペクションに適用できます

ベース

base ノードでは、プロファイル設定のベースとなるプロファイルを指定できます。ファイルパスまたは名前のいずれかを使用できます。

base: # Use either path or name
  # path: .qodana/profiles/base-profile.yaml
  # name: qodana.starter

name キーは次の値をサポートします。

`base.name` 値	説明
`Default`	JetBrains IDE から取得されたデフォルトのプロファイル
`Project Default`	プロファイルは基本的に `Default` に似ていますが、`.idea/inspectionProfiles/Project_Default.xml` ファイルに保存されたユーザーの変更が含まれています。
`Custom profile name`	`.idea/inspectionProfiles` ディレクトリに含まれる XML または YAML プロファイルの任意の名前
`qodana.starter`	デフォルトの Qodana プロファイル、`qodana.recommended` プロファイルのサブセット
`qodana.recommended`	JetBrains IDE のデフォルトプロファイルを実装するデフォルトの Qodana プロファイル
`empty`	インスペクションの重大度とパラメーターは `Project Default` から取得されますが、インスペクションは含まれません。`empty` を使用すると、プロファイルを最初から作成できます

name 宣言がない場合、Qodana は Project Default プロファイルを採用するため、カスタムプロファイルに適用されたすべての設定によって、Project Default に含まれる設定が上書きされます。

名前

ベースとして使用する設定を含む、.idea/inspectionProfiles ディレクトリのプロファイルの名前。

name: "Name of your profile"

このキーは base.name 設定と重複しており、併用することはできません。

グループ

groups ノードは、ユーザー定義グループのリストです。ここでは、インスペクションカテゴリと単一のインスペクションを組み合わせ、 inspections ノードでの使用箇所を設定できます。

各グループ定義では、他のグループまたは単一のインスペクションを含めたり除外したりできます。

感嘆符文字 (!) を使用して、グループまたはカテゴリを否定できます。例: 含まれるグループ内の特定のカテゴリの使用を除外できます。

ユーザーが定義した EnabledInspections グループを含むサンプルを次に示します。

groups:
  - groupId: EnabledInspections
    groups:
      - "category:Java/Probable bugs"
    inspections:
      - RedundantIf

このサンプルには次の要素が含まれています。

プロパティ	説明
`groupId`	グループの ID
`inspections`	このグループに含まれるインスペクションと除外されるインスペクションのリスト
`groups`	このグループに含まれるグループと除外されるグループのリスト

groups.groupId

一意のグループ識別子。

- groupId: IncludedInspections

2 つのグループが同じ groupId で定義されている場合、ファイル内で見つかった最新のグループが使用されます。インクルードされるファイルに含まれる設定は、現在のファイルに配置される設定よりも前に考慮されるため、このルールはインクルードされるすべてのファイルにも適用されます。

groups.inspections

グループに含まれるインスペクションのリスト。

inspections:
    - RedundantIf
    - UnnecessaryLocalVariable

groups.groups

使用可能な感嘆符文字 (!) を含むグループ ID のリスト:

groups:
    - "ALL"
    - "category:Java/Probable bugs"
    - "IncludedInspections" 
    - "!ExcludedInspections"
    - "severity:WEAK WARNING"

ここで、groups はいくつかの値を受け入れます。

`groupId` 値	説明
`ALL`	すべてのインスペクションを含めます。さらに、`LOCAL` を使用してローカルで利用可能なインスペクションを使用してコードを分析したり、JetBrains IDE のコードのインスペクションアクションを使用して `GLOBAL` を使用してコードを分析したりすることもできます。
`category:Java/Probable bugs`	`category:categoryname` 表記におけるインスペクションカテゴリの名前は、JetBrains IDE のエディター \| 設定 \| インスペクションセクションの名前と一致します。
`IncludedInspections`	既存のユーザー定義グループの名前、または含まれているプロファイルのグループの名前
`!ExcludedInspections`	ユーザー定義または別のプロファイルに含まれている既存の `ExcludedInspections` インスペクショングループを無効にします
`severity:WEAK WARNING`	インスペクションを特定の重大度レベルで含めるか除外します。重大度の値は `Default` プロファイルから取得されるため、Qodana はプロファイルに加えられた変更を認識しません。

デフォルトでは、Qodana は、次の表に示す JetBrains IDE から継承した重大度レベルを使用します。

IDE の重大度	SARIF 重大度	Qodana レポートの重大度	コード気候(英語)重大度	Bitbucket の重症度
ERROR	ERROR	クリティカル	ブロッカー	高
警告	警告	高	クリティカル	高
弱い警告	注	適度	メジャー	中
TYPO	注	低	マイナー	低
INFORMATION	注	情報	情報	情報
OTHER	注	情報	情報	情報

インスペクション

inspections を使用すると、次のことが可能になります。

特定のグループまたはインスペクションを有効または無効にする
これらの設定を適用する順序を定義します。
特定のグループまたはインスペクションによって無視されるパスまたはスコープを定義します。
特定のインスペクションまたはインスペクショングループの重症度をカスタマイズする
インスペクションオプションを構成します。

inspections:
  - group: InspectionGroup
  - inspection: JavadocReference
    severity: WARNING
  - group: ALL
    ignore:
      - "vendor/**" 
      - "scope#file[*test*]:src/*"
  - group: DisabledInspections
    enabled: false
  - inspection: MissortedModifiers
    options:
      m_requireAnnotationsFirst: false

このサンプルにはいくつかの要素が含まれています。

プロパティ	説明
`group`	埋め込みグループまたはユーザー定義グループの `groupId` プロパティからのグループの ID
`inspection`	インスペクションの ID
`severity`	インスペクションのグループまたは単一のインスペクションに割り当てられる重大度レベル。例: `ERROR` の代わりに `WARNING` を指定できます
`ignore`	インスペクション中に無視されるグロブパターン(英語)とスコープを使用するパスのリスト
`enabled`	グループまたはインスペクションをプロファイルで有効にするかどうかを指定します。`true` または `false` のいずれかを受け入れます
`options`	特定のインスペクションに設定できるオプションのリスト

インポート

インポートしたプロファイルのリストをプロジェクトルートを基準に設定できます。この機能は、特定のプロファイル設定をマージし、その結果を要件に合わせて調整する必要がある場合に便利です。例として、構成のマージセクションを参照してください。

imports:
    - ".qodana/profiles/firstprofile.yaml" 
    - ".qodana/profiles/anotherprofile.yaml"

imports ノードは base とは関連がありません。base に値が含まれていない場合は、Default に設定されます。

デフォルトプロファイルを表示するには、JetBrains IDE で設定 | エディター | インスペクションに移動し、プロファイルドロップダウンセレクターで Default プロファイルを選択します。

ファイルの内容は出現順に含まれるため、プロファイルの一部になります。これは、含まれるファイルの設定が、カスタムプロファイルで指定された設定よりも前に使用されることを意味します。

インポートの例

foo.yaml および bar.yaml プロファイルがあると仮定します。

foo.yaml プロファイルは Inspection1、Inspection2、Inspection3 インスペクションを有効にします。

inspections:
  - inspection: Inspection1
    enabled: true
  - inspection: Inspection2
    enabled: true
  - inspection: Inspection3
    enabled: true

bar.yaml プロファイルは、Inspection1 インスペクションを無効にします。

inspections:
  - inspection: Inspection1
    enabled: false

これら 2 つのファイルをカスタムプロファイルに含めて、Inspection2 を無効にすることができます。

imports:
  - "foo.yaml"
  - "bar.yaml"

profile:
  inspections:
    - inspection: Inspection2
      enabled: false

この場合、Qodana によって読み取られる有効なプロファイル構成は次のようになります。

inspections:
  - inspection: Inspection1
    enabled: false # "bar.yaml" was included later than "foo.yaml"
  - inspection: Inspection2
    enabled: false # it was applied in the custom profile last
  - inspection: Inspection3
    enabled: true

構成例

ここでは、プロファイル構成の例をいくつか紹介します。

インスペクションを除外

これにより、PHP 用の Qodana リンターで利用可能な PhpDeprecationInspection インスペクションを除外できます。

profile:
  base: 
    name: qodana.starter
    
  inspections:
    - inspection: PhpDeprecationInspection
      enabled: false 

あるいは、groups を使用して PhpDeprecationInspection インスペクションを除外することもできます。

profile:
  base: 
    name: qodana.starter
  
  groups:
    - groupId: Inspection
      inspections:
        -  PhpDeprecationInspection # Specify the PhpDeprecationInspection inspection   
  
  inspections:  
    - group: Inspection 
      enabled: false # Disable the PhpDeprecationInspection inspection

パスを無視する

ignore キーを使用すると、グローブパターンに一致する特定のスコープとパスを無視できます。

profile:
  inspections:
    - inspection: IncorrectFormatting
      ignore: # Select an option to ignore recursively:
        - "vendor/**" # All files and directories inside a directory
        - "scope#file[*test*]:src/*" # Specific filenames (test) of a directory (src/)
        - "scope#!file[intellij.python.psi]:*/" # PSI-recognized Python files in the project
        - "!my/path/to/**" # Negate a specific path

プロファイルの作成

base を使用して、この構成では空のプロファイルを定義し、JVM 用 Qodana リンターからの Java/Data flow インスペクショングループのみを含めます。

profile:
  base: 
    name: empty
                 
  inspections:  
    - group: "category:Java/Data flow"
      enabled: true # Enable the 'Java/Data flow' category

base の代わりに、 groups プロパティで ALL を使用できます。

profile:
  groups:
    - groupId: ExcludedInspections
      groups:
        - "ALL"
    - groupId: IncludedInspections
      groups:
        - "category:Java/Data flow" # Specify the 'Java/Data flow' category
                 
  inspections:  
    - group: ExcludedInspections
      enabled: false # Disable all inspections    
    - group: IncludedInspections
      enabled: true # Enable the 'Java/Data flow' category

プロファイルを上書きする

.NET 用 Qodana リンターに関連しないインスペクションカテゴリを qodana.starter (英語) プロファイルから除外できます。

profile:
  base: 
    name: qodana.starter # Use the 'qodana.starter' profile
  
  groups:
    - groupId: ExcludedInspections
      groups:
        - "category:Java"
        - "category:Kotlin"
        - "category:JVM languages"
        - "category:Spring"
        - "category:CDI (Contexts and Dependency Injection)"
        - "category:Bean Validation"
        - "category:Reactive Streams"
        - "category:RegExp"
        - "category:PHP"
        - "category:Go"
        - "category:Python"
        - "category:General"
        - "category:TOML"
    
  inspections:  
    - group: ExcludedInspections
      enabled: false

重大度でフィルタリングする

このサンプルには、Java コードのインスペクション中に、重大度レベルが WEAK WARNING のすべてのインスペクションが含まれています。

profile:
  groups:
    - groupId: IncludedInspections
      groups:
        - "category:Java"
        - "severity:WEAK WARNING"
              
  inspections:  
    - group: IncludedInspections
      enabled: true

オーバーライドの重大度

既存のインスペクションの重大度レベルを上書きできます。WARNING 重大度レベルを JavadocReference インスペクションに割り当てる方法は次のとおりです。

profile:
  inspections:  
    - inspection: JavadocReference
      severity: WARNING

上書きオプション

特定のインスペクション(英語)は構成可能なオプションを提供します。例: JvmCoverageInspection (英語) インスペクションは classThreshold、methodThreshold、warnMissingCoverage オプションを提供します。

これを確認するには、IntelliJ IDEA でこのインスペクションを設定し、プロファイルをエクスポートします。以下は JvmCoverageInspection インスペクションのプロファイル例です。

<component name="InspectionProjectProfileManager">
    <profile version="1.0">
        <option name="myName" value="Project Default" />
        <inspection_tool class="JvmCoverageInspection" enabled="true" level="WARNING" enabled_by_default="true">
            <option name="classThreshold" value="51" />
            <option name="methodThreshold" value="51" />
            <option name="warnMissingCoverage" value="true" />
        </inspection_tool>
    </profile>
</component>

このサンプルは、カスタムプロファイルでインスペクションオプションを構成する方法を示しています。

profile:
  base: 
    name: qodana.recommended
  
  inspections:
    - inspection: JvmCoverageInspection
      options:
        classThreshold: 51
        methodThreshold: 51
        warnMissingCoverage: true

カスタム XML プロファイル

IDE を使用して XML 形式のインスペクションプロファイルを作成できます。例: IntelliJ IDEA の場合は、プロファイルを構成するページで説明されています。プロファイルを作成したら、ファイルにエクスポートできます。

カスタムプロファイルを使用して Qodana を実行するには、既存のプロファイルを設定するセクションの推奨事項に従うことができます。この場合、プロファイル名は、それを含むファイルの名前と必ずしも一致しません。実際の名前は、プロファイルファイルに %profileName% 値として保存されます。

SQL ダイアレクトを指定する

SQL コードを解析するには、SQL 関連のインスペクションを有効にするだけでは不十分です。この場合、解析する SQL ダイアレクトも指定する必要があります。そのためには、以下の内容を含む .idea/sqldialects.xml をプロジェクトルートに保存してください。

    <?xml version="1.0" encoding="UTF-8"?>
    <project version="4">
        <component name="SqlDialectMappings">
            <file url="PROJECT" dialect="<SQLDialectName>" />
        </component>
    </project>

このスニペットの具体的な SQL ダイアレクトの名前を見つけるには、IDE で設定 | 言語 & フレームワーク | SQL ダイアレクト | プロジェクト SQL ダイアレクトに移動します。設定の上部にあるグローバル SQL ダイアレクトまたはプロジェクト SQL ダイアレクトのドロップダウンリストを展開します。

プロファイルを使用する

YAML 設定は、Qodana の汎用設定方法として機能します。つまり、 qodana.yaml ファイルを使用して Qodana を一度設定すれば、Docker、GitHub、JetBrains IDE、または Qodana で現在サポートされているその他のソフトウェアで Qodana を実行する際に再利用できます。この場合、追加の設定は不要で、すべての設定はこれらのプラットフォーム間で一貫して維持されます。以下の例を参照してください。

version: "1.0"
 
profile:
  base:
    path: .qodana/profiles/<custom-profile.yaml>

次の例は、 --profile-path オプションを使用してカスタムプロファイルを呼び出す方法を示しています。

GitHub UI の設定タブで、QODANA_TOKEN 暗号化シークレット(英語)を作成し、その値としてプロジェクトトークンを保存します。
GitHub UI のアクションタブで、新しいワークフローを設定し、.github/workflows/code_quality.yml ファイルを作成します。
main、ブランチ、リリースブランチ、リポジトリに届くプルリクエストを分析するには、ワークフロー構成を .github/workflows/code_quality.yml ファイルに保存します。
name: Qodana on: workflow_dispatch: pull_request: push: branches: # Specify your branches here - main # The 'main' branch - 'releases/*' # The release branches jobs: qodana: runs-on: ubuntu-latest permissions: contents: write pull-requests: write checks: write steps: - uses: actions/checkout@v3 with: ref: ${{ github.event.pull_request.head.sha }} # to check out the actual pull request commit, not the merge commit fetch-depth: 0 # a full history is required for pull request analysis - name: 'Qodana Scan' uses: JetBrains/qodana-action@v2026.1 with: args: --profile-path .qodana/profiles/<custom-profile.yaml> env: QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}

--profile-path オプションを使用してカスタムプロファイルを設定できます。

            docker run \
               -v $(pwd):/data/project/ \
               -v $(pwd)/.qodana/<custom-profile.yaml>:/data/project/myprofiles/<custom-profile.yaml> \
               -e QODANA_TOKEN="<cloud-project-token>" \
               jetbrains/qodana-<image> \
               --profile-path /data/project/myprofiles/<custom-profile.yaml>
        

            qodana scan \
               -v .qodana/<custom-profile.yaml>:/data/project/myprofiles/<custom-profile.yaml> \
               -e QODANA_TOKEN="<cloud-project-token>" \
               --profile-path .qodana/<custom-profile.yaml>
        

プロファイルを解決する順序

Qodana は、インスペクションプロファイルを解決するための構成パラメーターを次の順序でチェックします。

コマンドラインオプション --profile-name %name% からの %name% という名前のプロファイル
コマンドラインオプション --profile-path %path% からのパス %path% によるプロファイル
qodana.yaml から %name% という名前のプロファイル
qodana.yaml から %path% のパスによるプロファイル
/data/profile.xml に取り付けられたプロファイル
デフォルトの qodana.recommended プロファイルの使用に戻ります。

2026 年 4 月 20 日

Qodana 2026.1 ヘルプ