👷 添加 checkstyle 插件（暂时只校验 header）

ballcat-projects · Jan 20, 2024 · 7375115 · 7375115
1 parent bb98c62
commit 7375115
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 0 deletions.
diff --git a/.etc/checkstyle/checkstyle-suppressions.xml b/.etc/checkstyle/checkstyle-suppressions.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC
+		"-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+		"https://checkstyle.org/dtds/suppressions_1_2.dtd">
+<suppressions>
+	<suppress files="org.bson.types.ObjectId" checks="io.spring.javaformat.checkstyle.check.SpringHeaderCheck" />
+	<suppress files="com.alibaba.excel.*.*\.java" checks="io.spring.javaformat.checkstyle.check.SpringHeaderCheck" />
+</suppressions>
diff --git a/.etc/checkstyle/checkstyle.xml b/.etc/checkstyle/checkstyle.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
+<module name="com.puppycrawl.tools.checkstyle.Checker">
+	<!-- Root Checks -->
+	<module name="io.spring.javaformat.checkstyle.check.SpringHeaderCheck">
+		<property name="fileExtensions" value="java"/>
+		<property name="headerType" value="apache2"/>
+		<property name="headerCopyrightPattern" value="20\d\d-20\d\d"/>
+		<property name="packageInfoHeaderType" value="none"/>
+	</module>
+</module>
diff --git a/pom.xml b/pom.xml
@@ -341,6 +341,40 @@
 					</execution>
 				</executions>
 			</plugin>
+			<!-- checkstyle 配置 -->
+			<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>9.3</version>
+					</dependency>
+					<dependency>
+						<groupId>io.spring.javaformat</groupId>
+						<artifactId>spring-javaformat-checkstyle</artifactId>
+						<version>${spring-javaformat-checkstyle.version}</version>
+					</dependency>
+				</dependencies>
+				<executions>
+					<execution>
+						<id>checkstyle-validation</id>
+						<phase>validate</phase>
+						<configuration>
+							<configLocation>.etc/checkstyle/checkstyle.xml</configLocation>
+							<suppressionsLocation>.etc/checkstyle/checkstyle-suppressions.xml</suppressionsLocation>
+							<consoleOutput>true</consoleOutput>
+							<failsOnError>true</failsOnError>
+							<includeTestSourceDirectory>true</includeTestSourceDirectory>
+						</configuration>
+						<goals>
+							<goal>check</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 	<developers>