Checkstyle

Gradleで外部コマンドを実行する(Checkstyleを実行する)

Gradleでは、タスクの中で外部コマンドを実行することができる。 Gradle CheckStyle Pluginは、JavaコードだけしかCheckしないため、他のファイルに対してチェックを行うために、外部コマンドでチェックを実行する時の実装を紹介する。 以下のコードでは、ソ…

Gradle Checkstyle Pluginで日本語エラーメッセージが文字化けする問題の解決方法

事象 Gradle Checkstyle PluginでCheckstyleのタスクを実行した際に、 チェックエラーがあった場合、コマンドプロンプト上にエラーメッセージが表示される。 特に何も設定していない場合、下記の画像のように、エラーメッセージが文字化けしてしまうという事…

Checkstyle チェック項目ーWhitespace

Checkstyleチェック項目:Whitespace CheckStyle公式ドキュメント ver 10.3.1 EmptyForInitializerPad for文の空の初期化式に空白を許可するかどうかをチェックする。 forの初期化式後に改行されている場合はチェックが実行されない。 〇forの初期化式とは f…

Checkstyle チェック項目ーSize Violations

Checkstyleチェック項目:Size Violations CheckStyle公式ドキュメント ver 10.3.1 AnonInnerLength checkstyle-java.hatenablog.com ExecutableStatementCount checkstyle-java.hatenablog.com FileLength checkstyle-java.hatenablog.com LambdaBodyLength…

Checkstyle チェック項目ーRegexp

Checkstyleチェック項目:Regexp チェック実行例をより詳しく知りたい場合は公式を参照のこと。 ver 10.3.1 Regexp 指定されたパターンがファイル内に存在するか、存在する回数が設定値以下か、存在しないかをチェックする。 プロパティ プロパティ 型 デフ…

Checkstyle チェック項目ーNaming Conventions

Checkstyleチェック項目:Naming Conventions CheckStyle公式ドキュメント ver 10.3.1 AbbreviationAsWordInName checkstyle-java.hatenablog.com AbstractClassName checkstyle-java.hatenablog.com CatchParameterName checkstyle-java.hatenablog.com Cla…

Checkstyle チェック項目ーModifiers

Checkstyleチェック項目:Modifiers CheckStyle公式ドキュメント ver 10.3.1 ClassMemberImpliedModifier クラスおよびレコードのネストされた型に対する暗黙の修飾子をチェックする。 クラスやレコードのネストされた型の修飾子をチェックし、特定の修飾子…

Checkstyle チェック項目ーMiscellaneous

Checkstyleチェック項目:Miscellaneous CheckStyle公式ドキュメント ver 10.3.1 ArrayTypeStyle 配列の型定義のスタイルをチェックする。 JavaスタイルとCスタイルから選択可能。 Javaスタイル(デフォルト):public static void main(String args) Cスタ…

Checkstyle チェック項目ーMetrics

Checkstyleチェック項目:Metrics CheckStyle公式ドキュメント ver 10.3.1 BooleanExpressionComplexity 式中のboolean演算子(&&、 ||、 &、 |、 ^)の数を制限する。 プロパティ プロパティ 型 デフォルト値 説明 max int 3 1つの式で許可されるboolean演…

Checkstyle チェック項目ーJavadoc Comments

Checkstyleチェック項目:Javadoc Comments CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 AtclauseOrder checkstyle-java.hatenablog.com InvalidJavadocPosition checkstyle-java.hatenablog.com JavadocBlockTag…

Checkstyle チェック項目ーImports

Checkstyleチェック項目:Imports CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 AvoidStarImport checkstyle-java.hatenablog.com AvoidStaticImport checkstyle-java.hatenablog.com CustomImportOrder checkstyl…

Checkstyle チェック項目ーHeaders

Checkstyleチェック項目:Headers CheckStyle公式ドキュメント ver 10.3.1 RegexpHeader ソースファイルのヘッダを、ソースヘッダの各行に対応するパターンを含むヘッダと照合してチェックする。 プロパティ プロパティ 型 デフォルト値 説明 headerFile URI…

Checkstyle チェック項目ーCoding

Checkstyleチェック項目:Coding CheckStyle公式ドキュメント ver 10.3.1 ArrayTrailingComma 配列の初期化時に、末尾にコンマが含まれているかどうかをチェックする。 デフォルトでは、配列の最後の要素と同じ行に左中括弧も右中括弧もない場合、最後にコン…

Checkstyle チェック項目ーClass Design

Checkstyleチェック項目:Class Design CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 DesignForExtension checkstyle-java.hatenablog.com FinalClass checkstyle-java.hatenablog.com HideUtilityClassConstructo…

Checkstyle チェック項目ーBlock Checks

Checkstyleチェック項目:Block Checks CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 AvoidNestedBlocks checkstyle-java.hatenablog.com EmptyBlock checkstyle-java.hatenablog.com EmptyCatchBlock checkstyle-…

Checkstyle チェック項目ーAnnotation

Checkstyleチェック項目:Annotation CheckStyle公式ドキュメント 検証環境 Checkstyleバージョン:10.3.3 Javaバージョン:17 AnnotationLocation checkstyle-java.hatenablog.com AnnotationOnSameLine checkstyle-java.hatenablog.com AnnotationUseStyle…