VS Codeのエージェントモードを拡張するには、を試してください!

Java のフォーマットとリンティング

Red Hat による Java™ 言語サポートには、フォーマット設定も用意されています。Eclipse フォーマッターファイルをエクスポートし、VS Code でプロジェクトに使用できます。

さらに、Checkstyle for Java および SonarLint 拡張機能もあり、ライブリンティングとコード分析の機能を提供します。

フォーマッター

Java ファイルのフォーマットには、Format Document コマンドを使用できます。フォーマッタープロファイルを事前に指定していない場合、Java ファイルは既定の設定を使用してフォーマットされます。

フォーマッター設定の適用

Eclipse スキームの既存のフォーマッタープロファイルから、フォーマッター設定を簡単に適用できます。たとえば、Java プロジェクトにGoogle スタイルを適用したい場合は、settings.json に次のプロパティを設定できます。

"java.format.settings.url": "https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml",

このプロパティには、URL またはローカルファイルパスを設定できます。フォーマッター XML ファイルに複数のプロファイルが含まれている場合は、プロファイル名を指定できます。

"java.format.settings.profile": "GoogleStyle",

フォーマッタープロファイルを設定すると、Format Document コマンドは指定されたプロファイルを使用して Java ファイルをフォーマットします。

フォーマッター設定の編集

Extension Pack for Java には、既存のフォーマッタープロファイルを編集するためのエディターが用意されています。コマンド Java: Open Java Formatter Settings with Preview を使用してエディターを開くことができます。エディターで、フォーマッター設定を変更し、効果をプレビューできます。現在のエディターを保存すると、変更はフォーマッタープロファイルに保存されます。

注: フォーマッター設定エディターは、ローカルのフォーマッタープロファイルのみをサポートします。ワークスペースにリモートフォーマッタープロファイルが含まれている場合、.vscode フォルダーにダウンロードするようにガイドされます。

エディターで設定を編集する際、右側のプレビューパネルで変更の効果をプレビューできます。

変更を元に戻したり、やり直したりすることもできます。

SonarLint

SonarLint は、コード記述中にバグやセキュリティ問題を見つけて修正するのに役立つ、使いやすい拡張機能です。この拡張機能はバックグラウンドで実行され、スペルチェッカーのように、品質やセキュリティ上の懸念となるソースコードの問題を強調表示します。この拡張機能は、問題が何であるかを伝えるだけでなく、なぜそれが有害であるか、どのように修正するかについての文脈に沿ったガイダンスを例とともに提供します。この拡張機能は、500 を超える Java ルールをサポートし、特定の品質問題を自動的に修正するためのいくつかのクイック修正を含んでいます。

コードのリアルタイム分析

問題はエディター内で直接ハイライト表示され、ホバーで詳細な説明が提供されます。

開いているファイルで見つかった問題は、VS Code の [問題] パネルからも確認できます。該当する場合、問題の発生源 (例: バグにつながったコードパス) を理解できるように、二次的なコードの場所も記載されます。

ルールのドキュメントと修復ガイド

検出されたすべての問題について、SonarLint は違反したルールに関する完全なドキュメントと、関連する最適なコーディングプラクティスを提供します。これにより、問題が発生する理由と、その修正方法を理解できます。

その他の品質およびセキュリティルールの有効化

既定では、SonarLint はバグや脆弱性を検出するための幅広いルールを提供します。その他のチェックは、SonarLint ルール ビューから有効にできます。

VS Code 向け SonarLint 拡張機能の詳細については、SonarLint Web サイトを参照してください。

Checkstyle

Checkstyle for Java 拡張機能を使用すると、既存の checkstyle 構成 (Google または Sun の Check) または独自のカスタマイズされたファイルをプロジェクトに使用できます。Java ファイルを編集する際、この拡張機能はファイル形式をチェックし、可能であればリアルタイムでクイック修正を提供します。

Checkstyle: Set the Checkstyle Configuration File コマンドを使用して Checkstyle 構成ファイルを設定し、ドロップダウンから Checkstyle ファイルを選択します。

Checkstyle for Java 拡張機能は、ライブリンティングをサポートしています。

およびバッチチェック。

ステータスバーの Checkstyle ステータスアイコンをクリックすると、[問題] パネルが開きます。

Checkstyle 構成ファイルの設定

構成ファイルを設定するには、.xml ファイルを右クリックし、Set the Checkstyle Configuration File を選択します。

Set Checkstyle configuration file

また、Checkstyle: Set Checkstyle Configuration File コマンドを実行して、ファイルエクスプローラーで構成ファイルを選択することもできます。この拡張機能は、Checkstyle の構成を容易にするために、ワークスペース内の checkstyle.xml ファイルを探します。2 つの組み込み構成も表示されます。

  • Google のチェック
  • Sun のチェック

コマンド Checkstyle: Set the Checkstyle Configuration は、潜在的な Checkstyle 構成ファイルを検出し、それらを一覧表示します。入力ボックスに URL を直接書き込むことで、構成ファイルを指定することもできます。

また、Checkstyle: Set the Checkstyle Version コマンドを使用して、Checkstyle のバージョンを設定することもできます。

このコマンドは次の操作を行います。

  • メインリポジトリから最新の Checkstyle バージョンを一覧表示します。
  • ダウンロード済みのすべてのバージョンを一覧表示します。
  • サポートされているすべてのバージョンを一覧表示します。
  • 現在使用中のバージョンにチェック記号を付けます。

さらに、パスを設定することで、Checkstyle のサードパーティモジュールを追加することもできます。たとえば、以下の構成を使用した後に、checkstyle.xml<module name="SingleBreakOrContinueCheck"/> または <module name="com.github.sevntu.checkstyle.checks.naming.SingleBreakOrContinueCheck"/> を追加して、それらのチェックを使用できます。

"java.checkstyle.modules": [ "${workspaceFolder}/src/main/resources/sevntu-checks-1.35.0.jar" ]

スタイルの確認と違反の修正

Java ファイルを編集する際、この拡張機能はファイル形式をチェックし、可能であればクイック修正を提供します。エディターの電球ボタンをクリックすると、利用可能なクイック修正が表示されます。

Fix style violation

Checkstyle for Java の詳細については、そのGitHub リポジトリを参照してください。