プラグイン

リポジトリの既存のプラグインを使用するか、独自のプラグインを開発することで、Qodana を拡張できます。

リポジトリからのプラグイン

このセクションでは、ペソインスペクション (EA 拡張)(英語) プラグインで強化された PHP 用の Qodana リンターを使用して PHP コードをインスペクションする方法について説明します。JetBrains マーケットプレイス(英語)または任意のカスタムリポジトリの関連する IDE プラグインに対してこれらの手順を繰り返すことができます。

プラグインをインストールして設定する

プラグインをインストールする最も簡単な方法は、qodana.yaml ファイルの plugin オプションを使用することです。

                    plugins:
                      - id: <plugin.id>
                

ここで、<plugin-id> は JetBrains マーケットプレイス(英語)のプラグイン ID を表します。例: Grazie Professional(英語) の場合、プラグイン ID 値は com.intellij.grazie.pro になります。特定のプラグインの ID を見つけるには、JetBrains マーケットプレイス(英語)のプラグインページで概要タブをクリックし、追加情報セクションに移動します。

あるいは、次のファイルを準備する必要があります。

プラグインのコード
プラグインの構成
プラグインインスペクションの構成を含むインスペクションプロファイル

これらのファイルを取得する方法は次のとおりです。

利用可能なインストール方法のいずれかを使用してプラグインをインストールします。どのインストール方法を選択しても、インストール後のプラグインファイルへのパスを知っておく必要があります。IDE の設定 | プラグインダイアログを使用してプラグインをインストールする場合は、プラグインディレクトリセクションを参照してください。JetBrains マーケットプレイス(英語)から PhpInspectionsEA.jar プラグインファイルをダウンロードする場合は、Qodana がアクセスできるディレクトリに保存します。
ea_extended.xml プラグイン構成ファイルは、IDE 構成ディレクトリの options サブディレクトリにあります。このファイルは、Qodana がアクセスできる任意のディレクトリに保存できます。
IDE のインスペクションダイアログに移動し、PHP | ペソインスペクション (EA 拡張) エントリを展開し、使用するインスペクションをチェックして、インスペクションプロファイルをプロジェクトルートフォルダーに qodana-inspection-profile.xml ファイル名でエクスポートします。

Qodana の設定

プロジェクトのルートディレクトリに qodana.yaml ファイルを作成し、そのファイル内のプロファイルの場所へのパスを指定します。

                profile:
                    path: ./qodana-inspection-profile.xml
            

Qodana の実行

Qodana をローカルで実行するには、次のスニペットを使用します。

                docker run \
                   -v <project-directory>:/data/project/ \
                   -v <report-directory>:/data/results/ \
                   -e QODANA_TOKEN="<cloud-project-token>" \
                   -v <path-to-plugin-file>/PhpInspectionsEA.jar:/opt/idea/plugins/PhpInspectionsEA.jar \
                   -v <path-to-plugin-config>/ea_extended.xml:/root/.config/idea/options/ea_extended.xml \
                   jetbrains/qodana-php
            

カスタムプラグイン

プラグインの開発方法については、IntelliJ プラットフォームプラグイン SDK ドキュメントポータルの最初のプラグインの作成(英語)ページを参照してください。また、各プラグインは、ドキュメントポータルのインスペクション(英語)セクションに従って、インスペクションを実行し、インスペクション結果を生成する必要があります。

最終更新日: 2024 年 6 月 28 日

関連ページ：

PHP 用の Qodana

PHP の Qodana は PhpStorm に基づいています。PhpStorm のすべての機能が組み込まれており、次のことに役立ちます。異常なコードと潜在的なバグを検出する、デッドコードを削除する、スペルの問題をハイライトする、全体的なコード構造を改善する、コーディングのベストプラクティスを紹介する、インスペクションの結果を Qodana クラウドにアップロードする、サポートされているテクノロジー：PHP 用 Qodana は、次のテクノロジ用にインスペクションを提供します。プログラミング言語 P...

プラグインのインストール

プラグインは PhpStorm のコア機能を拡張します。例: プラグインをインストールして、次の機能を取得します。バージョン管理システム、課題追跡システム、ビルド管理サーバー、その他のツールとの統合。さまざまな言語とフレームワークのコーディング支援サポート。ショートカットのヒント、ライブプレビュー、ファイルウォッチャーなど。新しいプログラミング言語を学ぶのに役立つコーディング演習。プラグイン設定を開くを押して設定を開き、を選択します。マーケットプレースタブを使用して、JetBrains マーケッ...

IDE で使用されるディレクトリ

デフォルトでは、PhpStorm は、各 IDE インスタンスのユーザー固有のファイル（構成、キャッシュ、プラグイン、ログなど）をユーザーのホームディレクトリに保存します。ただし、必要に応じて、これらのファイルを保存する場所を変更できます。IDE ディレクトリの場所を変更するたとえば、ユーザープロファイルドライブの容量が不足している場合や低速ディスクにある場合、ホームディレクトリが暗号化されている（IDE の速度が低下している）場合、またはネットワークドライブにある場合は、デフォルトの IDE...

インスペクション

このページを使用して、インスペクションプロファイルのカスタマイズ、インスペクション重大度レベルの構成、インスペクションの無効化と有効化、さまざまなスコープのインスペクションの構成を行います。変更されたインスペクションは青でハイライトされます。プロファイルの管理：プロファイル設定したいプロファイルの名前を選択します。適用をクリックすると、選択したプロファイルがプロジェクトのハイライトに自動的に使用されます。IDE にコピー / プロジェクトにコピー: プロジェクトまたはグローバル（IDE）レベルで選...

プロファイルを構成する

インスペクションプロファイルは、有効なインスペクション、これらのインスペクションが分析するファイルのスコープ、およびインスペクション重大度設定に関する情報を保持します。PhpStorm には、2 種類のプロファイルがあります。プロファイル IDE に保管は、PhpStorm 構成ディレクトリの inspection フォルダーに保存され、すべてのプロジェクトで使用できます。プロジェクトにコピーオプションを使用して、IDE プロファイルを現在のプロジェクトにコピーできます。プロファイルプロジェクトに保管は...

構造検索

構造検索は、JetBrains IDE に組み込まれた強力で柔軟なメカニズムです。検索テンプレートを使用して、セマンティクスを考慮してコードベースをインスペクションできるようにします。独自の検索テンプレートを作成し、Qodana インスペクションとして使用できます。使い方：例として、次の検索テンプレートを考えてみましょう。$Instance$.$MethodCall$($Parameter$) これにより、Java ステートメントを検出できます。のようなハードコードされたテキストを含むステートメ...