From d486bd0b755f8b9800ad92d0803a8920e3281fb6 Mon Sep 17 00:00:00 2001 From: kenjiyoshid-a <181298858+kenjiyoshid-a@users.noreply.github.com> Date: Tue, 28 Jan 2025 14:07:49 +0900 Subject: [PATCH] =?UTF-8?q?checkstyle.xml=E3=81=AB=E6=B1=8E=E7=94=A8?= =?UTF-8?q?=E6=A4=9C=E6=9F=BB=E4=BE=8B=E5=A4=96=E3=81=AE=E3=82=AD=E3=83=A3?= =?UTF-8?q?=E3=83=83=E3=83=81=E3=82=92=E7=A6=81=E6=AD=A2=E3=81=99=E3=82=8B?= =?UTF-8?q?=E8=A8=AD=E5=AE=9A=E3=82=92=E8=BF=BD=E5=8A=A0=20(#1874)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * IllegalCatchの設定を追加 * AzureADB2CのcheckstyleにIllegalCatchを追加 * カスタマイズしている規約を追記 * テストクラスでは汎用的な例外のキャッチを許容するよう修正 * 指摘事項に対応 --- .../conventions/coding-conventions.md | 18 ++++++++++++++++++ .../config/checkstyle/checkstyle.xml | 1 + .../config/checkstyle/suppressions.xml | 2 ++ .../config/checkstyle/checkstyle.xml | 1 + .../config/checkstyle/suppressions.xml | 2 ++ 5 files changed, 24 insertions(+) diff --git a/documents/contents/guidebooks/conventions/coding-conventions.md b/documents/contents/guidebooks/conventions/coding-conventions.md index e3b0de499..e3e1426c7 100644 --- a/documents/contents/guidebooks/conventions/coding-conventions.md +++ b/documents/contents/guidebooks/conventions/coding-conventions.md @@ -51,3 +51,21 @@ SpotBugs を利用して、 SpotBugs が提供するバグパターンに該当 - [SpotBugs プラグイン](../how-to-develop/java/common-project-settings.md#spotbugs-plugin) - [Java formatting and linting :material-open-in-new:](https://code.visualstudio.com/docs/java/java-linting){ target=_blank } - [静的コード分析とフォーマット(Vue.js)](../how-to-develop/vue-js/static-verification-and-format.md) + +## AlesInfiny Maia でカスタマイズしている規約 {#custom-conventions} + +AlesInfiny Maia では上記に示した基本のコーディング規約に加えて、以下に示すカスタマイズした規約を採用しています。 + +- Java アプリケーション + + - Checkstyle プラグイン + + Checkstyle の規約をカスタマイズする場合、 Checkstyle プラグインが読み込むインプットファイルを編集します。具体的な方法については [こちら](../how-to-develop/java/common-project-settings.md#checkstyle-plugin) を参照ください。 + Checkstyle プラグインでカスタマイズする規約は以下の通りです。 + + - [IllegalCatch :material-open-in-new:](https://checkstyle.sourceforge.io/checks/coding/illegalcatch.html){ target=_blank } + + 汎用検査例外を含む特定の例外のキャッチを禁止します。 + + 汎用的な例外をキャッチしてしまうと、具体的な例外が隠蔽されてしまい、原因の特定が難しくなります。 + 汎用的な例外ではなく、具体的な例外のみをキャッチするように本規約を設けます。 diff --git a/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/checkstyle.xml b/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/checkstyle.xml index 2816202db..341a9e2ae 100644 --- a/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/checkstyle.xml +++ b/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/checkstyle.xml @@ -283,5 +283,6 @@ + \ No newline at end of file diff --git a/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/suppressions.xml b/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/suppressions.xml index a1a5f6efd..34aeae35c 100644 --- a/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/suppressions.xml +++ b/samples/azure-ad-b2c-sample/auth-backend/config/checkstyle/suppressions.xml @@ -9,4 +9,6 @@ + + \ No newline at end of file diff --git a/samples/web-csr/dressca-backend/config/checkstyle/checkstyle.xml b/samples/web-csr/dressca-backend/config/checkstyle/checkstyle.xml index 2816202db..341a9e2ae 100644 --- a/samples/web-csr/dressca-backend/config/checkstyle/checkstyle.xml +++ b/samples/web-csr/dressca-backend/config/checkstyle/checkstyle.xml @@ -283,5 +283,6 @@ + \ No newline at end of file diff --git a/samples/web-csr/dressca-backend/config/checkstyle/suppressions.xml b/samples/web-csr/dressca-backend/config/checkstyle/suppressions.xml index ebac9e64c..40fd52aba 100644 --- a/samples/web-csr/dressca-backend/config/checkstyle/suppressions.xml +++ b/samples/web-csr/dressca-backend/config/checkstyle/suppressions.xml @@ -11,4 +11,6 @@ + + \ No newline at end of file