From ea20c2abbd127a7dc110e1d6da2733e13b2d12e2 Mon Sep 17 00:00:00 2001
From: HARSH <harshsennn@gmail.com>
Date: Wed, 15 Jan 2025 13:55:43 +0530
Subject: [PATCH] checkstyle for Common-API

---
 .github/workflows/checkstyle.yml | 13 +++++++
 checkstyle.xml                   | 65 ++++++++++++++++++++++++++++++++
 pom.xml                          | 28 ++++++++++++++
 3 files changed, 106 insertions(+)
 create mode 100644 .github/workflows/checkstyle.yml
 create mode 100644 checkstyle.xml

diff --git a/.github/workflows/checkstyle.yml b/.github/workflows/checkstyle.yml
new file mode 100644
index 00000000..bcae2b38
--- /dev/null
+++ b/.github/workflows/checkstyle.yml
@@ -0,0 +1,13 @@
+name: Call Checkstyle
+
+on:
+  pull_request:
+    branches: ["master", "develop"]
+    paths:
+      - '**/*.java'
+
+jobs:
+  style-check:
+    uses: PSMRI/.github/.github/workflows/checkstyle.yml@main
+    with:
+      java-version: '17'
\ No newline at end of file
diff --git a/checkstyle.xml b/checkstyle.xml
new file mode 100644
index 00000000..1893aaef
--- /dev/null
+++ b/checkstyle.xml
@@ -0,0 +1,65 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <property name="severity" value="error" />
+    <property name="fileExtensions" value="java" />
+
+    <!-- Checks for Size Violations -->
+    <module name="FileLength">
+        <property name="max" value="500" />
+    </module>
+    <module name="LineLength">
+        <property name="max" value="120" />
+    </module>
+
+    <module name="TreeWalker">
+        <!-- Checks for Naming Conventions -->
+        <module name="MethodName" />
+        <module name="PackageName" />
+        <module name="TypeName" />
+        <module name="ParameterName" />
+        <module name="LocalVariableName" />
+        <module name="MemberName" />
+
+        <!-- Checks for imports -->
+        <module name="AvoidStarImport" />
+        <module name="IllegalImport" />
+        <module name="RedundantImport" />
+        <module name="UnusedImports" />
+
+        <!-- Checks for Size Violations -->
+        <module name="MethodLength">
+            <property name="max" value="50" />
+        </module>
+
+        <!-- Checks for whitespace -->
+        <module name="EmptyLineSeparator" />
+        <module name="GenericWhitespace" />
+        <module name="MethodParamPad" />
+        <module name="NoWhitespaceAfter" />
+        <module name="NoWhitespaceBefore" />
+        <module name="ParenPad" />
+        <module name="TypecastParenPad" />
+        <module name="WhitespaceAfter" />
+        <module name="WhitespaceAround" />
+
+        <!-- Modifier Checks -->
+        <module name="ModifierOrder" />
+        <module name="RedundantModifier" />
+
+        <!-- Checks for blocks -->
+        <module name="EmptyBlock" />
+        <module name="LeftCurly" />
+        <module name="RightCurly" />
+        <module name="NeedBraces" />
+
+        <!-- Checks for common coding problems -->
+        <module name="EmptyStatement" />
+        <module name="EqualsHashCode" />
+        <module name="IllegalInstantiation" />
+        <module name="MissingSwitchDefault" />
+        <module name="SimplifyBooleanExpression" />
+        <module name="SimplifyBooleanReturn" />
+    </module>
+</module>
\ No newline at end of file
diff --git a/pom.xml b/pom.xml
index 1606baea..7a7457ba 100644
--- a/pom.xml
+++ b/pom.xml
@@ -613,6 +613,34 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-checkstyle-plugin</artifactId>
+				<version>3.3.1</version>
+				<dependencies>
+					<dependency>
+						<groupId>com.puppycrawl.tools</groupId>
+						<artifactId>checkstyle</artifactId>
+						<version>10.12.7</version>
+					</dependency>
+				</dependencies>
+				<configuration>
+					<configLocation>checkstyle.xml</configLocation>
+					<encoding>UTF-8</encoding>
+					<consoleOutput>true</consoleOutput>
+					<failsOnError>true</failsOnError>
+					<linkXRef>false</linkXRef>
+				</configuration>
+				<executions>
+					<execution>
+						<id>validate</id>
+						<phase>validate</phase>
+						<goals>
+							<goal>check</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 	<reporting>