Issue checkstyle#6570: Exclude module-info.java from Google and Sun c…

…onfigurations
mkroening · Mar 19, 2019 · 706bcd2 · 706bcd2
1 parent f0d5b51
commit 706bcd2
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 0 deletions.
diff --git a/src/main/resources/google_checks.xml b/src/main/resources/google_checks.xml
@@ -21,6 +21,11 @@
     <property name="severity" value="warning"/>
 
     <property name="fileExtensions" value="java, properties, xml"/>
+    <!-- Excludes all 'module-info.java' files              -->
+    <!-- See https://checkstyle.org/config_filefilters.html -->
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value="module\-info\.java$"/>
+    </module>
     <!-- Checks for whitespace                               -->
     <!-- See http://checkstyle.sf.net/config_whitespace.html -->
     <module name="FileTabCharacter">

diff --git a/src/main/resources/sun_checks.xml b/src/main/resources/sun_checks.xml
@@ -41,6 +41,12 @@
 
     <property name="fileExtensions" value="java, properties, xml"/>
 
+    <!-- Excludes all 'module-info.java' files              -->
+    <!-- See https://checkstyle.org/config_filefilters.html -->
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value="module\-info\.java$"/>
+    </module>
+
     <!-- Checks that a package-info.java file exists for each package.     -->
     <!-- See http://checkstyle.sourceforge.net/config_javadoc.html#JavadocPackage -->
     <module name="JavadocPackage"/>

diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsPagesTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsPagesTest.java
@@ -1380,6 +1380,7 @@ else if (path.toFile().getName().contains("sun")) {
             }
 
             // these modules aren't documented, but are added to the config
+            styleChecks.remove("BeforeExecutionExclusionFileFilter");
             styleChecks.remove("TreeWalker");
             styleChecks.remove("Checker");
 

diff --git a/src/xdocs/config_filefilters.xml b/src/xdocs/config_filefilters.xml
@@ -75,6 +75,14 @@
       </subsection>
       <subsection name="Example of Usage" id="BeforeExecutionExclusionFileFilter_Example_of_Usage">
         <ul>
+          <li>
+            <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Agoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+BeforeExecutionExclusionFileFilter">
+              Google Style</a>
+          </li>
+          <li>
+            <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources+filename%3Asun_checks.xml+repo%3Acheckstyle%2Fcheckstyle+BeforeExecutionExclusionFileFilter">
+              Sun Style</a>
+          </li>
           <li>
             <a href="https://github.com/search?q=path%3Aconfig+filename%3Acheckstyle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+BeforeExecutionExclusionFileFilter">
             Checkstyle Style</a>