doc: udpate BeforeExecutionExclusionFileFilter to show example of neg…

…ative lookahead
checkstyle · Jan 30, 2021 · b0c8153 · b0c8153
1 parent 247e3a3
commit b0c8153
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 0 deletions.
diff --git a/.ci/jsoref-spellchecker/whitelist.words b/.ci/jsoref-spellchecker/whitelist.words
@@ -807,6 +807,7 @@ localhost
 localvariablename
 Loggable
 lombok
+lookaround
 Loughran
 lparen
 lpb

diff --git a/.../java/com/puppycrawl/tools/checkstyle/filefilters/BeforeExecutionExclusionFileFilter.java b/.../java/com/puppycrawl/tools/checkstyle/filefilters/BeforeExecutionExclusionFileFilter.java
@@ -62,6 +62,18 @@
  * &lt;/module&gt;
  * </pre>
  * <p>
+ * To configure the filter to run only on required files for example that ends with "Remote"
+ * or end with "Client" in names or named as "Remote.java" or "Client.java"
+ * use <a href="https://www.regular-expressions.info/lookaround.html">negative lookahead</a>:
+ * </p>
+ *
+ * <pre>
+ * &lt;module name=&quot;BeforeExecutionExclusionFileFilter&quot;&gt;
+ *   &lt;property name=&quot;fileNamePattern&quot;
+ *  value=&quot;^(?!.*(Remote\.java|Client\.java|[\\/]Remote\.java|[\\/]Client\.java)).*$&quot;/&gt;
+ * &lt;/module&gt;
+ * </pre>
+ * <p>
  * Parent is {@code com.puppycrawl.tools.checkstyle.Checker}
  * </p>
  *

diff --git a/src/xdocs/config_filefilters.xml b/src/xdocs/config_filefilters.xml
@@ -66,6 +66,17 @@
         <source>
 &lt;module name=&quot;BeforeExecutionExclusionFileFilter&quot;&gt;
   &lt;property name=&quot;fileNamePattern&quot; value=&quot;module\-info\.java$&quot;/&gt;
+&lt;/module&gt;
+        </source>
+        <p>
+          To configure the filter to run only on required files for example that ends with "Remote"
+          or end with "Client" in names or named as "Remote.java" or "Client.java"
+          use <a href="https://www.regular-expressions.info/lookaround.html">negative lookahead</a>:
+        </p>
+        <source>
+&lt;module name=&quot;BeforeExecutionExclusionFileFilter&quot;&gt;
+  &lt;property name=&quot;fileNamePattern&quot;
+    value=&quot;^(?!.*(Remote\.java|Client\.java|[\\/]Remote\.java|[\\/]Client\.java)).*$&quot;/&gt;
 &lt;/module&gt;
         </source>
       </subsection>