From abbc5c550de40e1e1eca6c4efcb85f925371fe6c Mon Sep 17 00:00:00 2001
From: blablubbabc <lukas@wirsindwir.de>
Date: Sat, 19 Feb 2022 09:33:06 +1100
Subject: [PATCH] #730: Added a checkstyle rule to check for missing package
 declarations.

Added a suppression to ignore the test sources.
---
 checkstyle-suppressions.xml | 9 +++++++++
 checkstyle.xml              | 3 +++
 pom.xml                     | 1 +
 3 files changed, 13 insertions(+)
 create mode 100644 checkstyle-suppressions.xml

diff --git a/checkstyle-suppressions.xml b/checkstyle-suppressions.xml
new file mode 100644
index 00000000..94366ef6
--- /dev/null
+++ b/checkstyle-suppressions.xml
@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<!DOCTYPE suppressions PUBLIC
+          "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+          "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+    <!-- Don't check for missing package declarations in tests-->
+    <suppress checks="JavadocPackage" files=".*[\\/]src[\\/]test[\\/].*\.java$"/>
+</suppressions>
diff --git a/checkstyle.xml b/checkstyle.xml
index 8b624164..c658f38f 100644
--- a/checkstyle.xml
+++ b/checkstyle.xml
@@ -20,6 +20,9 @@
         <property name="message" value="Line has trailing spaces."/>
     </module>
 
+    <!-- See https://checkstyle.sourceforge.io/config_javadoc.html#JavadocPackage-->
+    <module name="JavadocPackage"/>
+
     <module name="TreeWalker">
         <!-- See https://checkstyle.org/config_javadoc.html -->
         <module name="AtclauseOrder"/>
diff --git a/pom.xml b/pom.xml
index b8c80195..298e00fe 100644
--- a/pom.xml
+++ b/pom.xml
@@ -217,6 +217,7 @@
                         </executions>
                         <configuration>
                             <configLocation>checkstyle.xml</configLocation>
+                            <suppressionsLocation>checkstyle-suppressions.xml</suppressionsLocation>
                             <includeTestSourceDirectory>true</includeTestSourceDirectory>
                         </configuration>
                         <dependencies>