Qodana 2024.1 ヘルプ

JetBrains IDE

JetBrains IDE で Qodana を実行して、コードベースをインスペクションできます。Qodana は、JetBrains Toolbox アプリ経由でインストールされたいくつかの JetBrains IDE (IntelliJ IDEA、PhpStorm、WebStorm、Rider、GoLand、PyCharm、Rider など) をサポートします。

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

UI の概要

IDE で、ツール | Qodana に移動します。

The Qodana menu

IDE の問題 | サーバーサイド解析ツールウィンドウを使用して Qodana にアクセスすることもできます。

The Server-Side Analysis tool window

Qodana をローカルで実行する

Qodana をローカルで実行し、保管と分析の目的でインスペクションレポートを Qodana クラウドに転送できます。

  1. IDE で、ツール | Qodana | Qodana でコード分析を試してみるに移動します。

  2. Qodana の実行ダイアログでは、次の設定を行うことができます。

    Configuring Qodana in the Run Qodana dialog

    コードをインスペクションするには、「実行」をクリックします。

  3. 問題ツールウィンドウのサーバーサイド解析タブで、インスペクションの結果を確認します。

Qodana クラウドに接続する

Qodana Cloud にログインし、IDE で開いたプロジェクトを特定の Qodana Cloud プロジェクトに接続して、最新の Qodana レポートを取得して表示することができます。

  1. IDE で、ツール | Qodana | Qodana にログインに移動します。

  2. 設定ダイアログで、ログインをクリックします。

    Connecting to Qodana Cloud

    これにより、認証ページにリダイレクトされます。

  3. ローカルプロジェクトをリンクする Qodana クラウドプロジェクトを選択します。

    Linking the project to Qodana Cloud
  4. 最も関連性の高い Qodana レポートを常にロードしますオプションを有効にすると、Qodana クラウドから実際のレポートを自動的に取得できます。

    Enabling to load the most relevant reports

    この場合、IDE は現在のリビジョン ID (HEAD) に対応するリビジョン ID を持つレポートを Qodana クラウドから検索して取得します。このレポートが見つからなかった場合、IDE は現在のリビジョン ID (HEAD) に最も近いリビジョンを持つ前のレポートを選択します。それ以外の場合、IDE は Qodana クラウドから利用可能な最新のレポートを取得します。

  5. 問題ツールウィンドウのサーバーサイド解析タブで、インスペクションの結果を確認します。

Qodana を CI 用に構成する

Qodana クラウド(英語)にログインすると、CI パイプラインで Qodana を構成できます。

  1. IDE で、ツール | Qodana | CI に Qodana を追加に移動します。

  2. CI に Qodana を追加ダイアログで、CI/CD ソリューションに適用される推奨事項に従います。

    The Add Qodana to CI pipeline dialog

ローカルレポートを開く

IDE で SARIF 形式の Qodana レポートを開いて確認できます。

  1. IDE で、ツール | Qodana | ローカルレポートを開くに移動します。

  2. 開きたい SARIF 形式のレポートファイルを選択します。

  3. 問題ツールウィンドウのサーバーサイド解析タブで、インスペクションの結果を表示できます。

Qodana レポートの概要

IDE のサーバーサイド解析タブを使用すると、Qodana レポートを表示し、そのような問題を含むコードフラグメントに移動できます。

Navigating to problems in the IDE

上部には、プロジェクトとブランチ名、インスペクションの日付、問題の数に関する情報が表示されます。サーバーサイド解析タブの左側には、いくつかのボタンがあります。

Functionalities of the Server-Side Analysis tab

次の表では、各ボタンを上から下に説明しています。

ボタン

説明

レポートを閉じる

以前に開いていたレポートを閉じます

レポートをリフレッシュする

Qodana Cloud からレポートの更新バージョンをダウンロードします。これには、最初にプロジェクトを Qodana クラウドにリンクする必要があります

Qodana にログイン /Qodana にログイン

Qodana Cloud にログインするか、ログアウトします。このアクションは、プロジェクトを Qodana クラウドベースのレポートにリンクするための前提条件です。

プロジェクトとクラウドを連携 / クラウドと連携

プロジェクトを特定の Qodana クラウドベースのプロジェクトにリンクするか、リンクを解除します。これには、最初に Qodana クラウドにログインする必要があります。

表示オプション

コードの問題を重大度によって除外し、並べ替えを構成します。グループ化または並べ替えのオプションが選択されていない場合、問題はファイル内に表示される順序でリストされます。すべての問題をベースラインでフィルタリングすることもできます

エディターのプレビューを開く

プレビューパネルを開いて、選択した問題をソースコンテキストで表示します。このプレビューでは、コードを変更したり、利用可能なクイックフィックスを適用したりできます。

すべて展開

すべてのノードを展開すると、展開された形式ですべての問題が表示されます

すべて折りたたむ

以前に展開されたすべてのノードを折りたたむ

Qodana をブラウザーで表示

デフォルトのブラウザーを使用してインスペクションレポートを開きます

その他

ツール | Qodana メニューの機能

Qodana ログの概要

IDE で、ヘルプ | ログと診断データを収集に移動します。これにより、必要なデータがすべて収集され、特定のディレクトリに保存されます。

関連ページ:

Qodana について

Qodana は、チームでの作業に最適な JetBrains によるスマートコード品質プラットフォームです。Java、JavaScript、TypeScript、PHP、Kotlin、Python、Go、C# など 60 以上の言語で記述されたコードを分析できます。Qodana を CI/CD パイプラインまたはローカルで実行する:Qodana は、Azure パイプライン、CircleCI、GitHub、TeamCity のネイティブソリューションを提供します。他の CI/CD システムでは、D...

Qodana クラウド

Qodana を複数のプロジェクトまたはリポジトリで実行する場合、特にコードベースが複数のサーバーと仮想プライベートネットワークに分散されていて、各チームが独立して作業している場合は、すべての分析レポートを 1 か所に読み込んで集約すると便利です。このような場合、すべての Qodana インスタンスからレポート情報を収集して表示するための集中型ソリューションが役立ちます。Qodana クラウドは、さまざまな Qodana レポートを蓄積し、プロジェクトの進捗状況を一元的に追跡するのに役立つクラウ...

プロジェクト

プロジェクトは、Qodana レポートを蓄積します。各プロジェクトは、プロジェクトトークンによって一意に識別されます。このトークンは、Qodana レポートのアップロードに使用されます。プロジェクトの作成:オンボーディング段階では、Qodana Cloud がすでに最初のプロジェクトの作成を支援しているため、これらの手順は追加のプロジェクトを作成する場合にのみ適用されます。チームページで、ボタンをクリックします。以下で説明するウィザードの手順に従います。Qodana Cloud からアクセスでき...

フォワードレポート

このセクションでは、このソフトウェアを使用して Qodana レポートを Qodana クラウドに転送する方法について説明します。Docker および Qodana CLI、Azure パイプライン、Bitbucket クラウド、CircleCI、GitHub アクション、GitLab CI/CD、Jenkins、Space Automation、TeamCity、これらすべての場合において、このドキュメント

ベースライン

ベースラインは、特定の Qodana 実行時に取得され、ファイルに含まれているコードベースの問題のスナップショットです。ベースライン機能を使用すると、現在のコードとベースラインの状態を比較し、新しい問題、変更されていない問題、解決された問題を確認できます。この機能は、Community、Ultimate、Ultimate Plus ライセンスとその試用版で利用可能なすべてのリンターでサポートされています。使い方:ベースラインなしで Qodana を実行すると、現在の実行時に検出された問題を確認...

Visual Studio Code

Visual Studio Code は、Windows、macOS、Linux で使用できるソースコードエディターです。このセクションでは、Visual Studio Code バージョン 1.81 以降を使用して Qodana クラウドからの Qodana レポートを表示する方法を示します。始める前に:Qodana クラウドプロジェクトがあり、このプロジェクトに Visual Studio Code によって開かれたプロジェクトに関連する分析レポートが少なくとも 1 つあることを確認します。...