Opinion

プレッシャー下におけるコード品質確保: IntelliJ ベース IDE での Qodana 統合で開発者をサポート

Read this post in other languages:

開発者への要求は絶えず増え続けています。常に少ない時間でより多くの作業を完了するように求められる一方で、締め切りが切迫しているほど品質よりも量が優先されてしまうことがよくあります。

このような場合、CI ソリューションと IDE などの複数のアプリケーションを切り替える際にコンテキスト切り替えの問題が発生します。 これを踏まえると、コード品質のように重要なものでさえ見過ごされる可能性があることは容易に理解できます。

では、どうすれば現実的に締め切りを守りながら作業に集中し、コードの品質を重視して優先するのに必要な支援を得られるのでしょうか? その答えは、JetBrains Qodana を使用することにあります。

Qodana とは?

Qodana は IDE 内で直接コードの品質を改善するのに役立つ静的コード解析プラットフォームです。 コードスキャンを CI パイプラインに組み込んで自動化することで、プロのソフトウェア開発者が時間を節約できるようにします。

これにより、Qodana はこのようなパイプラインでより簡単にクオリティゲートを使用し、チームが定義した標準にコードを確実に準拠できるようにしています。 Qodana には JetBrains の 20 年を超えるソフトウェア開発の経験を基に作られたコードインスペクションが備わっています。

このようなインスペクションにはセキュリティスキャンとサードパーティライセンスの監査などが含まれているため、開発者はプロジェクトの状態を俯瞰し、素早くトリアージし、優先順位を付け、重大な課題から先に解決することができます。

静的解析は簡単に始められます。 Qodana を初めて使用する場合は IDE から直接初回のスキャンを実行し、ローカルチェックの結果を素早く確認することができます。 次に、CI ウィザードを使用して Qodana をパイプラインに追加できます。 それでは、その手順を見てみましょう。

Qodana IDE プラグインによるセットアップの合理化 

以下の動画では、Anton Arhipov(JetBrains のデベロッパーアドボケイト)が Qodana のセットアッププロセスを説明しています。 詳細な手順を確認したい方はこの動画をご覧ください。

Anton のデモで使用されている IDE は IntelliJ IDEA です。 ただし、Qodana は IDE の多くに初期状態でバンドルされています。 現在は IntelliJ IDEAPhpStormGoLandRiderWebStormPyCharm をサポートしています。 その他の JetBrains IDE も近日中に追加される予定です!

Qodana を CI/CD パイプラインに追加することも可能

Qodana IDE プラグインを使用すると、Qodana を CI パイプラインに追加して課題を早期に検出することができます。 Tools(ツール)メニューを開き、Qodana を選択して、CI パイプラインに Add Qodana(Qodana を追加)します。 すると、ウィザードによって選択した CI サーバー用の構成ファイルが生成されます。 たとえば、GitHub Actions の Add (追加)ボタンをクリックするだけでワークフロー構成ファイルがプロジェクトに作成されます。 TeamCity、GitLab CI/CD、Jenkins など、その他の CI サーバー用のヘルパーもあります。

IDE 内で課題にアクセスし、より素早く修正を実装

Qodana IDE プラグインは結果を IDE に直接送信します。課題レポートを確認すると、直接コードに問題がハイライトされているのが分かります。 Qodana を使用して失敗したチェックと脆弱性をすぐに確認することもできます。

Qodana では CI パイプラインで新しいコードスキャンレポートの準備が完了した際に通知を受け取り、IDE 内でフラグのついた課題の修正に着手することもできます。

コンテキストとアプリの切り替え操作回数を減らして集中力をアップ

タブの切り替えによって集中力が途切れ、特に納品のプレッシャーがかかっている場合にはパフォーマンスが低下することがあるとのフィードバックをいただきました。 集中できなければ作業の完了にかかる時間が増えるため、時間の無駄にもなります。また、企業が品質関連のフィードバックを得てそれを取り込む時間を考慮していないこともよくあります。

ToDo リストに多数の項目があり、厳しい締め切りが設定されている場合は解決策が限られているように思えるかもしれません。 しかし、プラグインを使用して Qodana にすぐにアクセスすればマルチタスクに起因する雑音を消せるため、作業中に完全に「ゾーン状態」を維持できます。 どちらのツールも常にすぐに使用できるため、IDE から離れる必要はありません。

Qodana のレポートは GitHub Actions などの CI/CD システム内または Qodana Cloud 内からでもアクセス可能で、Open in IDE(IDE で開く)ボタンを使用して素早くアクセスできます。 このように、単純なワークフローでコーディングタスクに集中してコード品質を重視する方法は豊富にあります。

始める準備はできましたか? 

Qodana の無料 60 日間体験版をお試しください! または、Qodana Ultimate Plus を 50% オフで入手できます。開発者 1 人あたりわずか ¥900 からご利用いただけます。 ご質問がある場合や作業中にサポートが必要になった場合は、画面の右上にある New Issue(新しい課題)をクリックして YouTrack の課題トラッカーにチケットを提出してください。コメント欄でも受け付けています。 X(旧 Twitter) で弊社をタグ付けするか、qodana-support@jetbrains.com にお問い合わせいただくことも可能です。

Qodana を無料で試す!

オリジナル(英語)ブログ投稿記事の作者:

image description