Qodana 2024.1 ヘルプ

Qodana について

official project

Qodana は、チームでの作業に最適な JetBrains によるスマートコード品質プラットフォームです。Java、JavaScript、TypeScript、PHP、Kotlin、Python、Go、C# など 60 以上の言語で記述されたコードを分析できます。

Qodana を CI/CD パイプラインまたはローカルで実行する

Qodana は、Azure パイプラインCircleCIGitHubTeamCity のネイティブソリューションを提供します。他の CI/CD システムでは、Docker イメージを使用できます。

Qodana をローカルで実行するには、Docker イメージQodana CLI(英語) ツール、JetBrains IDE を使用できます。

デフォルトのインスペクションプロファイルを使用してコードをインスペクションできます。これには構成手順が不要で、すぐに Qodana を実行できます。デフォルトのインスペクションプロファイルを構成したり、YAML および XML 形式で独自のインスペクションプロファイルを作成したりすることもできます。

最後に、既存のインスペクションを超えて Qodana を拡張できます。

ソフトウェアの品質を向上させる

Qodana レポートには、具体的な問題と、そのような問題を含むコードフラグメントの詳細な説明、およびそのような問題の解決方法に関する推奨事項が提供されます。これらの推奨事項を使用すると、製造中のバグを防ぎ、プロセスから学習することで、製品の品質を向上させることができます。詳細については、インスペクションレポートセクションを参照してください。

コードレビューを最適化する

Qodana は、レビューとテストのフェーズに入る前に、コードが正常であることを確認します。バグ、脆弱性、ライセンスの競合を減らすなどの短期的な成果を達成し、新機能のリリースや変更の実装を容易にする保守可能なコードなどの長期的なゴールを達成します。

インスペクションレポートは Qodana クラウドにアップロードされ、詳細を表示できます。また、JetBrains IDEVisual Studio Code を使用して Qodana レポートを確認することもできます。

それに加えて、GitHub では Qodana はプルリクエストをインスペクションできます。

コーディング標準を強制する

Qodana を品質ゲートとして使用すると、ビルド失敗の原因となる問題の数を決定したり、問題をすぐに解決するように計画し、問題をベースラインに設定して延期したり、提案されたクイックフィックスを自動的に適用してチームの時間を節約したりできます。

他のチームメンバーとレポートを共有する

Qodana クラウド(英語)は、Qodana レポートを蓄積し、プロジェクトの進捗状況を 1 か所から追跡できます。このようなレポートは、チームのすべてのメンバーが利用できます。Qodana クラウドについてさらに詳しく知るには、Qodana クラウドページにアクセスしてください。

料金モデルを活用する

Ultimate ライセンスおよび Ultimate Plus ライセンスに基づく Qodana ライセンスのコストは、アクティブなコントリビューターの数によって異なります。これにより、無制限の数のコード行をインスペクションできます。

無料のコミュニティライセンスに基づいて Qodana を実行することもできます。ただし、この場合、Qodana の機能は制限されます。Qodana ライセンスを比較するには、価格モデルページにアクセスしてください。

次のステップ

お問い合わせ

新しい機能を提案したい場合、または予期しない動作が発生した場合は、問題トラッカー(英語)を使用するか、サポートチーム (qodana-support@jetbrains.com) にメールを送信してください。

Qodana コミュニティに積極的に参加するには、GitHub ディスカッションフォーラム(英語)に参加してください。

関連ページ:

Azure パイプライン

Qodana スキャンは、Qodana でコードをスキャンするために Qodana Azure パイプライン拡張内にパックされた Azure パイプラインタスクです。使用箇所:基本構成 Qodana Azure パイプライン拡張を組織にインストールした後、Qodana スキャンタスクを構成するには、ファイルを編集します。# Start with a minimal pipeline that you can customize to build and deploy your code. # Ad...

TeamCity

Qodana は、TeamCity でビルドランナーとして使用できます。使用を開始するには、次の前提条件を満たす必要があります。TeamCity をプロジェクトのビルドサーバーとして使用します。そうでない場合は、TeamCity のドキュメントでその方法を学習してください。プロジェクト言語は、完全にサポートされているテクノロジのリストに含まれています。独自の TeamCity エージェントを使用する場合は、Docker がエージェントマシンにインストールされており、TeamCity を実行してい...

JetBrains IDE

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

インスペクションレポート

Qodana を使用すると、ローカルまたは Qodana クラウドで、インタラクティブでユーザーフレンドリーな形式でインスペクションレポートを確認できます。各レポートには次のタブが含まれています。実際の問題は、Qodana が最新のインスペクション中に検出した問題を明らかにします、ベースラインには、ベースラインとしてマークされ、それ以降修正されていない問題がリストされます。構成により、将来の使用に備えて Qodana を構成できます、ライセンス監査は

Visual Studio Code

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

ベースライン

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