Visual Studio Code
Visual Studio Code は、Windows、macOS、Linux で使用できるソースコードエディターです。このセクションでは、Visual Studio Code バージョン 1.81 以降を使用して Qodana クラウドからの Qodana レポートを表示する方法を示します。
始める前に
Qodana クラウドプロジェクトがあり、このプロジェクトに Visual Studio Code によって開かれたプロジェクトに関連する分析レポートが少なくとも 1 つあることを確認します。また、java -version
コマンドを実行して、マシンに Java 11 以降がインストールされているかどうかを確認します。必要に応じて、ローカルマシンに Java をインストールします。
Visual Studio マーケットプレイス (英語) Web サイトから、または Visual Studio Code の拡張ビューに移動して、Qodana 拡張機能をダウンロードしてインストールします。
拡張機能を設定する
Qodana 構成ページの概要は次のとおりです。
![VS Code の Qodana 設定 Qodana settings in VS Code](https://resources.jetbrains.com/help/img/qodana/2024.1/vscode-settings.png)
次の設定を使用して拡張機能を構成できます。
設定 | 説明 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
パスプレフィックス | 必要に応じて、プロジェクトパスのプレフィックスをオーバーライドできます。プロジェクトファイルへのフルパスがどのように構成されるかというルールは次のとおりです。 フルパス = ワークスペース + パスのプレフィックス + SARIF ファイル内のパス 正しいパスプレフィックスを定義する方法の例を次に示します。
Qodana クラウドレポートでは、 セクションを確認して、SARIF ファイル内のパスがどのように設定されているかを確認できます。 | ||||||||||||||||
プロジェクト ID | プロジェクト ID 値を取得するには、Qodana クラウドレポートからプロジェクトを開き、開くツールとして Visual Studio Code を選択します。 ボタンを使用して あるいは、ID は Qodana Cloud プロジェクト URL に含まれています。この URL の構造は |
Visual Studio Code UI のステータスバーに、Qodana アイコンがあります。このアイコンには次の状態があります。
設定が無効ですは、拡張機能を構成する必要があることを意味します。これを行うには、このアイコンをクリックすると、拡張機能の構成ページにリダイレクトされます。
レポートには添付されませんは、拡張機能を構成したが、レポートがまだダウンロードされていないことを意味します。レポートをダウンロードするには、アイコンをクリックします。
レポートに添付は、レポートが Qodana クラウドからダウンロードされ、Visual Studio Code を使用して表示できることを意味します。
分析結果の概要
構成が完了すると、拡張機能は Qodana クラウドに接続し、最新の Qodana レポートをダウンロードするため、Visual Studio Code の PROBLEMS タブで確認できるようになります。それでも PROBLEMS タブにレポートが表示されない場合は、パスプレフィックス設定を構成します。
このタブでは、問題のある項目をクリックして、Qodana が問題を検出したコードフラグメントに移動できます。
トラブルシューティング
別の Qodana Cloud アカウントに切り替える必要があります
Qodana: 認証をリセットするコマンドを使用すると、設定をクリアせずに Qodana クラウドアカウントを切り替えることができます。これは、異なる Qodana Cloud アカウントに複数の組織がある場合に役立ちます。
現在の設定では Qodana レポートを取得できません
Qodana: すべての設定をリセットするコマンドを使用して、すべての設定と資格情報をリセットし、拡張機能を再度構成するか、他の設定を使用することができます。
関連ページ:
![](https://resources.jetbrains.com/help/img/qodana/2024.1/qc-about-diagram.png)
Qodana クラウド
Qodana を複数のプロジェクトまたはリポジトリで実行する場合、特にコードベースが複数のサーバーと仮想プライベートネットワークに分散されていて、各チームが独立して作業している場合は、すべての分析レポートを 1 か所に読み込んで集約すると便利です。このような場合、すべての Qodana インスタンスからレポート情報を収集して表示するための集中型ソリューションが役立ちます。Qodana クラウドは、さまざまな Qodana レポートを蓄積し、プロジェクトの進捗状況を一元的に追跡するのに役立つクラウ...
![](https://resources.jetbrains.com/help/img/qodana/2024.1/qc-create-project.png)
プロジェクト
プロジェクトは、Qodana レポートを蓄積します。各プロジェクトは、プロジェクトトークンによって一意に識別されます。このトークンは、Qodana レポートのアップロードに使用されます。プロジェクトの作成:オンボーディング段階では、Qodana Cloud がすでに最初のプロジェクトの作成を支援しているため、これらの手順は追加のプロジェクトを作成する場合にのみ適用されます。チームページで、ボタンをクリックします。以下で説明するウィザードの手順に従います。Qodana Cloud からアクセスでき...
![](https://resources.jetbrains.com/help/img/qodana/2024.1/qc-overview-reports.png)
レポートの概要
プロジェクトレポートからの情報が集約され、このイメージでマークされているいくつかのセクションに表示されます。各セクションの説明は次のとおりです。1. プロジェクト名、ブランチ名、最後のインスペクション実行からの経過時間、検出された問題の数とその重大度。2. コードカバレッジとライセンス監査機能を使用した分析結果。3. コンテキストメニューを使用すると、次のことが可能になります。VCS の HTTPS または SSH URL を構成する、プロジェクトの名前を変更する、プロジェクトトークンをコピーまた...
![](https://pleiades.io/icons/jetbrains_logo.png)
SARIF 出力
Qodana レポートは SARIF 仕様に従ってフォーマットされ、JSON ファイルに含まれます。SARIF の Qodana 実装は、一般的な形式規則に従いますが、プロパティバッグに含まれるいくつかのカスタムプロパティも指定します。レポートの構造:Qodana によって生成されるレポートの構造は次のとおりです。{ "version": "2.1.0", "runs": [ { "tool": {...}, "invocations": [...], "language": "en-US",...
![](https://resources.jetbrains.com/help/img/qodana/2024.1/ui-overview.png)
インスペクションレポート
Qodana を使用すると、ローカルまたは Qodana クラウドで、インタラクティブでユーザーフレンドリーな形式でインスペクションレポートを確認できます。各レポートには次のタブが含まれています。実際の問題は、Qodana が最新のインスペクション中に検出した問題を明らかにします、ベースラインには、ベースラインとしてマークされ、それ以降修正されていない問題がリストされます。構成により、将来の使用に備えて Qodana を構成できます、ライセンス監査は
![](https://resources.jetbrains.com/help/img/qodana/2024.1/ide-plugin-intro-tool-window.png)
JetBrains IDE
JetBrains IDE で Qodana を実行して、コードベースをインスペクションできます。Qodana は、JetBrains Toolbox アプリ経由でインストールされたいくつかの JetBrains IDE (IntelliJ IDEA、PhpStorm、WebStorm、Rider、GoLand、PyCharm、Rider など) をサポートします。IDE を使用すると、次のことが可能になります。Qodana をローカルで実行する、Qodana クラウドに接続する、CI パイプライン...