よくある質問

ニーズに応じて、次を使用して Qodana を実行できます。

• CI パイプライン

• JetBrains IDE、Qodana CLI(英語) ツール、または利用可能な Docker イメージ

• ネイティブモードは .NET 用 Qodana リンターで利用可能

Qodana リンターは Linux Docker イメージであるため、Docker をサポートするすべての CI/CD プラットフォームで実行できるはずです。Qodana をさまざまな CI/CD プラットフォームと統合する方法の最良の例を提供するために、ドキュメントの拡張に取り組んでいます。問題が発生した場合は、サポート (qodana-support@jetbrains.com) までご連絡ください。

Qodana のオンプレミスバージョンは現在開発中で、2024 年にリリースする予定です。このソリューションに興味がある場合は、Qodana チームにお問い合わせください。

Qodana クラウドアカウントを作成する必要がないコミュニティライセンスで Qodana を実行することもできます。ただし、このオプションでは提供される機能が制限されます。

Qodana ですでにサポートされているテクノロジーのリストは、リンターページで入手できます。

Qodana は、最終的には JetBrains IDE でサポートされるすべてのテクノロジをカバーする予定です。トラッカーで問題を作成するか、既存の問題に投票して、どのテクノロジーに焦点を当てるべきかを知らせてください。例:

• Scala(英語)

• Dart(英語)

• C/C++(英語)

JetBrains アカウント (JBA) では、複数の会社を作成できます。

設立された各 JBA 会社は、複数の Qodana ライセンスを所有できます。

Qodana Cloud では、特定の JBA 会社内に特定のライセンスに対応する組織を少なくとも 1 つ作成する必要があります。

Qodana Cloud では、オンボーディング段階で JBA 会社を作成することもできます。この場合、JBA 会社と Qodana クラウド組織は同じ名前を共有します。

Qodana は JetBrains アカウントチームを使用しません。

Qodana は、クイックスタートページに従って、さまざまな方法で実行できます。Qodana の構成をできるだけ簡単にするよう努めているため、これらの方法はすべて最小限の準備手順で済みます。

リンターは、特定のテクノロジーを表す Qodana コンポーネントです。例: JVM 用 Qodana リンターを使用すると、Java、Kotlin、Groovy コードを含むコードベースを分析できます。一方、JS 用 Qodana リンターを使用すると、JavaScript および TypeScript コードをチェックできます。リンターページには、利用可能なすべてのリンターのリストと、それぞれの詳細な説明へのリンクがあります。

はい、モノリポジトリプロジェクトをインスペクションするセクションに従って、1 つのプロジェクトで複数のリンターを使用できます。

カスタム YAML プロファイルページの説明に従って、インスペクションプロファイルを構成できます。

既存のインスペクションがニーズに合わない場合は、独自の構造検索インスペクションを開発してインスペクションプロファイルに追加するか、Qodana のインスペクション機能を拡張するプラグインを使用できます。あるいは、独自のプラグイン(英語)を開発し、そのインスペクションを Qodana とともに使用することもできます。

SSH キーを使用すると、Qodana は分析対象プロジェクトのリポジトリに接続し、すべての種類のライセンスの要件であるコントリビューターの数を計算できます。

Qodana インスペクションプロファイルは、状態、構成オプション、適用先のパスを含む、事前構成されたインスペクションのセットです。Qodana インスペクションプロファイルは IntelliJ IDEA インスペクションプロファイルと同じであり、再利用できます。

デフォルトの Qodana インスペクションプロファイルのリストは既存の Qodana プロファイルページにあり、デフォルトのプロファイルの設定方法もここで確認できます。

qodana.recommended プロファイルを使用することをお勧めします。これは、デフォルトの JetBrains IDE プロファイルによって呼び出される最も使用可能なインスペクションがすでに提供されており、追加の構成は必要ないためです。

あるいは、ニーズに最適な独自のプロファイルを作成することもできます。

現在、Qodana UI で外部解析ツールの結果を表示することはできませんが、現在対応中です。

この表は、JetBrains IDE、SARIF、Qodana の重大度の関係を示しています。

インスペクトペディア (英語) Web サイトにアクセスして、インスペクションと Qodana でのその可用性について読むことができます。

はい。ただし、最小請求オプションは 3 人のコントリビューターに対するものです。

コントリビューターカウントのメカニズムについては、このドキュメントのコントリビューターのカウントセクションで説明されています。

はい、次のコマンドを使用してコントリビューターの数を確認できます。

Qodana CLI アプリケーションでは、 contributors (英語) コマンドを使用してアクティブなコントリビューターをカウントできます。例:

• JetBrains Web サイトのサブスクリプションのオプションと価格ページに移動し、使用するサブスクリプションオプションを選択できます。

  コミュニティライセンス、または Ultimate ライセンスまたは Ultimate Plus ライセンスの試用版を選択した場合は、Qodana Cloud オンボーディングページにリダイレクトされます。

  Ultimate または Ultimate Plus ライセンスを購入したい場合は、JetBrains アカウントページにリダイレクトされ、支払いの詳細を入力します。支払いが完了すると、Qodana クラウドオンボーディングページにリダイレクトされます。

• Qodana Cloud Web サイトのオンボーディング段階で、Qodana が接続できるようにリポジトリに追加する公開キーと、最初のプロジェクトに Qodana レポートをアップロードするためのプロジェクトトークンが生成されます。

はい、Ultimate または Ultimate Plus トライアルライセンスを選択し、60 日間のトライアル期間付きで Qodana を無料で使い始めることができます。この期間中、これらのライセンスを 1 回切り替えることができます。60 日後、プロジェクトで Qodana を引き続き使用するには、Ultimate または Ultimate Plus ライセンスを購入する必要があります。

コミュニティライセンスを選択することもできますが、Ultimate ライセンスや Ultimate Plus ライセンスと比べて提供される機能が制限されていることに注意してください。Ultimate または Ultimate Plus ライセンスからコミュニティライセンスに切り替えると、試用版ライセンスが不可逆的に終了することになります。

Qodana リンターと Qodana クラウドは両方とも、Qodana という名前の製品の重要な部分です。Qodana リンターを使用してコードベースをインスペクションでき、Qodana クラウドを使用してプロジェクトとライセンスを管理したり、Qodana レポートを 1 か所に収集したりできます。詳細については、Qodana クラウドドキュメントの Qodana クラウドの使用例ページを参照してください。

すべてのライセンスでは、Qodana Cloud でアカウントを作成し、オンボーディングステージを完了する必要があります (詳細については、この質問を参照してください)。それに加えて、Qodana Cloud を使用すると、Qodana レポートを 1 か所で表示でき、Qodana リンターが提供するすべての機能にアクセスできます。最後に、IDE 内から Qodana レポートを開くには、Qodana Cloud アカウントが必要です。

Qodana Cloud を除外するには、JVM の Qodana コミュニティ、Android のための Qodana コミュニティ、Python のための Qodana コミュニティなどの Qodana のコミュニティリンターをライセンスなしでローカルにダウンロードして実行できます。

必要な手順はすべて、Qodana クラウドドキュメントのクイックスタートセクションで説明されています。

試用版ライセンスは、Ultimate ライセンスまたは Ultimate Plus ライセンスの期間限定バージョンです。各試用ライセンスの期間は 60 日間に制限されており、Ultimate から Ultimate Plus、またはその逆に 1 回だけ変更できます。試用期間が終了すると、このタイプのライセンスは無効になり、使用できなくなります。Qodana を引き続き使用するには、フルバージョンのライセンスを購入する必要があります。

はい、試用期間が終了すると通知が届きます。

有効期限が切れたら、Ultimate または Ultimate Plus ライセンスを購入する必要があります。期限切れの試用ライセンスを延長することはできません。

いいえ、Qodana の Ultimate または Ultimate Plus バージョンのライセンスの購入を決定するまで、支払いの詳細を入力する必要はありません。試用期間終了後に購入することができます。

はい、JetBrains アカウントを使用して、Ultimate ライセンスと Ultimate Plus ライセンスの試用版を切り替えることができますが、これは 1 回しか実行できないことに注意してください。

Ultimate および Ultimate Plus ライセンスの試用版からコミュニティライセンスに 1 回だけ切り替えることもできます。試用版ライセンスをコミュニティライセンスに変換すると、そのプロセスを元に戻すことはできません。情報に基づいた意思決定を行っていることを確認してください。コミュニティライセンスは、Ultimate または Ultimate Plus サブスクリプションで利用可能なすべての機能をサポートするわけではないことに注意してください。変換後に Ultimate または Ultimate Plus サブスクリプションに戻したい場合は、有料サブスクリプションに移行する必要があります。

試用期間が終了すると、この 1 回限りの制限はなくなり、無制限にサブスクリプションプランを切り替えることができます。ただし、この場合、購入したすべてのサブスクリプションは返金されません。

ライセンスの合計コストは、アクティブなコントリビューターの数に基づきます。アクティブなコントリビューターとは、同じ組織内で、単一のライセンスに基づいて、過去 90 日間の任意の時点で任意の数の Qodana Cloud プロジェクトにコミットした個人 / ボットです。オンボーディング段階および新しいプロジェクトの作成中に、Qodana Cloud はコントリビューターを計算するためにリポジトリ URL をリクエストします。ライセンスに使用されるコントリビューターの最小数は 3 です。

実際のコントリビューターの数は、サブスクリプションプランに基づいて計算されます。例: 月次サブスクリプションを使用して、月の初日に 10 人のコントリビューター用のライセンスを購入しました。同じ月内に、Qodana はあなたのプロジェクトに 20 人のアクティブなコントリビューターがいることを発見しました。この場合、翌月のライセンス費用は 20 人の投稿者に対して再計算されます。2 か月目の終わりに、実際のアクティブなコントリビューターの数に基づいてライセンス費用が再計算されます。

詳細については、Qodana 利用規約(英語)の料金と支払いセクションを参照してください。

Qodana 利用規約(英語)から抜粋した請求の説明は次のとおりです。

月間サブスクリプション – 各サブスクリプション期間の開始時に、アクティブなコントリビューターの予想数 (3 人以上) を指定します。サブスクリプション期間の終了時には、決定したアクティブコントリビューターの数に基づいて、サブスクリプションプランに従ってサブスクリプション料金が請求されます。Qodana は、各サブスクリプション期間の終了時にアクティブなコントリビューターの実際の数をチェックします。その数が、そのサブスクリプション期間に指定したアクティブコントリビューターの数よりも多い場合、超過分の料金は請求されません。ただし、次のサブスクリプション期間に指定するアクティブな投稿者の数は、前のサブスクリプション期間の実際の数よりも少なくすることはできません。

年間サブスクリプションの料金には、顧客が選択した一定数のアクティブコントリビューターに対する前払いと、サブスクリプション期間中にその制限を超えて追加のアクティブコントリビューターに対する追加料金 (超過使用量) が含まれます。

• 前払い決済 – アクティブなコントリビューターの予想される月間数 (3 人以上) に基づいて、サブスクリプションの各月のアクティブなコントリビューターごとの月額料金で年間サブスクリプションを前払いします。

• 使い過ぎ・過剰使用 – Qodana は毎月アクティブな投稿者の数を監視します。アクティブな投稿者の数が顧客の月間制限を超えた場合、次の月に追加のアクティブな投稿者ごとにサブスクリプション料金が適用されます。ユーザーには自動的に料金が請求されることはありません。代わりに、提供されたメールリンクを通じて、または JetBrains アカウント内で追加のライセンスを購入できます。

  ユーザーがサブスクリプションの延長料金を支払わない場合、当社は、顧客が追加のコントリビューターの料金を支払うまで、Qodana サービスを 3 か月間一時停止することがあります。サブスクリプションは、当社が規約を終了する権利を行使しない限り、停止後 3 か月後に、顧客が支払ったアクティブなコントリビューターの数に応じて (または顧客がサブスクリプションを延長したとき) 自動的に再アクティブ化されます。

月中のアクティブな投稿者の数が前払い制限を下回った場合、返金やクレジットは発行されません。

Qodana クラウドには、ライセンスに関するすべての情報が保存されます。これは、Qodana を実行する前に Qodana クラウドアカウントを作成する必要がある理由を説明しています。この機能とは別に、Qodana Cloud は他の機能も提供します。

タスクに基づいて、適切なライセンスで Qodana リンターを実行することをお勧めします。

JVM 用 Qodana、JS 用 Qodana、PHP 用の Qodana などの有料リンターは、Ultimate および Ultimate Plus ライセンスを使用した場合のみ実行できます。コミュニティライセンスを使用している場合は、実行することはできません。

JVM の Qodana コミュニティ、Android のための Qodana コミュニティ、Python のための Qodana コミュニティなどのコミュニティリンターは、コミュニティライセンスがあれば、またはライセンスなしで使用できます。

JVM の Qodana コミュニティのようなリンターは既存の機能を拡張しないため、Ultimate または Ultimate Plus ライセンスで実行する必要はありません。

JetBrains アカウントでは最大 5 つのコミュニティライセンスを持つことができます。

Ultimate ライセンスと比較して、Ultimate Plus ライセンスには次の追加機能が提供されます。

• ライセンス監査

• 汚染分析

• 脆弱性チェッカー

いいえ、Qodana コミュニティライセンスは、オープンソースプロジェクトまたは独自プロジェクトの作業に使用できます。

すべての Qodana サブスクリプションは、CI システムとの統合セクションで説明されている CI/CD ソリューションとの統合をサポートしています。

はい、コミュニティ Qodana リンターはコミュニティライセンスに基づいて実行できます。詳しくは各ライセンスで利用可能なリンターのページを参照してください。

何よりもまず、Qodana Cloud は、リポジトリのアクティブなコントリビューターに関する情報とプロジェクトトークンを収集します。この情報は、ライセンスコストの計算と有料機能の有効化に使用されます。

さらに、Qodana は SARIF 形式のインスペクションレポートを Qodana クラウドに転送するため、Qodana クラウド UI を使用してインスペクションの結果を表示できます。

qodana.recommended インスペクションプロファイルを使用します。

qodana.recommended プロファイルが役に立たない場合は、別のリンターを実行してみてください。

問題が解決しない場合は、トラッカーで問題を作成するか、qodana-support@jetbrains.com に連絡して、パスにディレクトリをマウントすることでアクセスできる /data/results ディレクトリのログを添付してください。

はい、キャッシュを使用できます。これは Qodana スキャン GitHub アクションでデフォルトで利用可能です。これで問題が解決しない場合は、トラッカーで問題を作成するか、qodana-support@jetbrains.com に連絡して /data/results ディレクトリのログを添付してください。ログにアクセスするには、ディレクトリをマウントします。GitHub アクションを使用している場合、それらはワークフローアーティファクトにアップロードされます。

Gradle など、一部のプロジェクトやそのプロジェクト内のビルドツールでは、デフォルトの 2 GB よりも多くのメモリが必要になる可能性があるため、Docker デスクトップの設定でより多くのメモリを設定してみてください。

Qodana を起動する前に、ルートフォルダーで ./gradlew コマンドを実行してください。これにより、Qodana はこのダウンロードされたバージョンの Gradle を使用できるようになります。

プロジェクトが Windows で作成された場合は、必ず git update-index --chmod=+x gradlew を実行してファイルを CI 内で実行可能にしてください。