Qodana 2024.1 ヘルプ

HTML レポートを開く

JetBrains IDE とシェルコマンドを使用して、HTML 形式の Qodana レポートを開くことができます。

Qodana のバージョン 2023.2 以降では、Qodana レポートの概要セクションに従って、IntelliJ IDEA、PhpStorm、WebStorm、Rider、GoLand、PyCharm、Rider を使用して HTML レポートを開くことができます。

この場合、IDE は JetBrains Toolbox アプリ経由でインストールする必要があります。

--save-report オプションを指定して Qodana を実行すると、レポートの HTML バージョンが /data/results/report に保存されます。通常、このディレクトリは Docker を介してマウントされ、Qodana の実行とは関係なく、後で HTML レポートを表示できるようになります。JavaScript のセキュリティ制限により、index.html ファイルをダブルクリックして HTML レポートを参照することはできません。代わりに、HTML レポートは Web サーバー経由で提供される必要があり、Docker 化バージョンの nginx を実行するか、以下に示すように Python または PHP 組み込み Web サーバーを呼び出すことができます。

  1. Qodana を実行した後、report フォルダーに移動し、そこに index.html ファイルが存在することを確認します。

  2. 選択した Web サーバーを使用してレポートを提供します。

    docker run -it --rm -p 8000:80 \ -v $(pwd):/usr/share/nginx/html nginx

    ブラウザーで http://localhost:8000 に移動し、生成されたレポートを確認します。

    python2 -m SimpleHTTPServer

    ブラウザーで http://localhost:8000 に移動し、生成されたレポートを確認します。

    python3 -m http.server

    ブラウザーで http://localhost:8000 に移動し、生成されたレポートを確認します。

    php -S localhost:8000

    ブラウザーで http://localhost:8000 に移動し、生成されたレポートを確認します。

関連ページ:

JetBrains IDE

JetBrains IDE で Qodana を実行して、コードベースをインスペクションできます。Qodana は、JetBrains Toolbox アプリ経由でインストールされたいくつかの JetBrains IDE (IntelliJ IDEA、PhpStorm、WebStorm、Rider、GoLand、PyCharm、Rider など) をサポートします。IDE を使用すると、次のことが可能になります。Qodana をローカルで実行する、Qodana クラウドに接続する、CI パイプライン...

SARIF 出力

Qodana レポートは SARIF 仕様に従ってフォーマットされ、JSON ファイルに含まれます。SARIF の Qodana 実装は、一般的な形式規則に従いますが、プロパティバッグに含まれるいくつかのカスタムプロパティも指定します。レポートの構造:Qodana によって生成されるレポートの構造は次のとおりです。{ "version": "2.1.0", "runs": [ { "tool": {...}, "invocations": [...], "language": "en-US",...

インスペクトペディア

場合によっては、特定のインスペクションが何を報告するか、それがコードベースで問題となる理由について、さらに詳しい情報が必要になることがあります。インスペクトペディアは、説明、重大度レベル、対象言語など、インスペクションに関する詳細を提供します。目次を使用して、利用可能なすべてのインスペクションを調べることができます。あるいは、具体的なインスペクションを名前または識別子で検索することもできます。HTML レポートを開く機能...