🚀 VS Code で で入手しましょう！

Java のフォーマットとリント

Language Support for Java™ by Red Hat は、フォーマット設定も提供しています。Eclipse フォーマッターファイルをエクスポートして、VS Code でプロジェクトに使用できます。

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

Formatter

Java ファイルをフォーマットするには、ドキュメントのフォーマット コマンドを使用できます。以前にフォーマッタープロファイルを指定していない場合、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",

フォーマッタープロファイルを設定すると、ドキュメントのフォーマット コマンドは、特定のプロファイルを使用して Java ファイルをフォーマットします。

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

Extension Pack for Java は、ユーザーが既存のフォーマッタープロファイルを編集するのに役立つエディターを提供します。Java: Java フォーマッター設定をプレビューで開く コマンドでエディターを開くことができます。エディターでは、フォーマッター設定を変更し、効果をプレビューできます。現在のエディターを保存すると、変更がフォーマッタープロファイルに保存されます。

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

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

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

SonarLint

SonarLint は、コードの記述中にバグやセキュリティの問題を見つけて修正するのに役立つ、使いやすい拡張機能です。この拡張機能はバックグラウンドで実行され、スペルチェッカーのように、品質またはセキュリティ上の懸念を引き起こすソースコードの問題を強調表示します。この拡張機能は、問題の内容だけでなく、なぜ有害なのか、どのように修正するのか、例を挙げてコンテキストに応じたガイダンスを提供します。この拡張機能は、500 以上の Java ルール をサポートしており、特定の品質問題を自動的に修正するための クイック修正 がいくつか含まれています。

その場でのコード分析

問題はエディター内で直接強調表示され、ホバーで詳細な説明が表示されます。

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

ルール文書と是正ガイダンス

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

より多くの品質およびセキュリティルールの有効化

デフォルトでは、SonarLint はバグや脆弱性を検出するための幅広いルールを提供します。SonarLint ルール ビューを通じて、より多くのチェックを有効にできます。

SonarLint for VS Code 拡張機能 の詳細については、SonarLint ウェブサイト を参照してください。

Checkstyle

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

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

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

およびバッチチェック。

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

Checkstyle 構成ファイルの設定

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

Set Checkstyle configuration file

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

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

Checkstyle: Checkstyle 構成の設定 コマンドは、潜在的な Checkstyle 構成ファイルを検出し、それらをリストします。入力ボックスに URL を直接記述して、構成ファイルを指定することもできます。

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

コマンドは、

  • メインリポジトリから最新の Checkstyle バージョンをリストします。
  • ダウンロードされたすべてのバージョンをリストします。
  • サポートされているすべてのバージョンをリストします。
  • 現在使用中のバージョンをチェック記号でマークします。

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

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

スタイルのチェックと違反の修正

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

Fix style violation

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

12/12/2021