Issue #13345: enabling tests for RegexpCheckExampleTest

checkstyle · Jan 25, 2025 · 69c4c65 · 69c4c65
1 parent 05b2a32
commit 69c4c65
Show file tree

Hide file tree

Showing 28 changed files with 468 additions and 691 deletions.
diff --git a/config/checkstyle-checks.xml b/config/checkstyle-checks.xml
@@ -61,7 +61,11 @@
     <property name="lineRange" value="1"/>
     <property name="idPattern" value="lineLengthXml"/>
   </module>
-
+  <module name="SuppressWithNearbyTextFilter">
+    <property name="nearbyTextPattern" value="violation above 'Trailing whitespace'"/>
+    <property name="lineRange" value="-1"/>
+    <property name="checkPattern" value="RegexpSingleline"/>
+  </module>
   <!-- Headers -->
   <module name="Header">
     <property name="headerFile" value="${checkstyle.header.file}"/>

diff --git a/config/checkstyle-examples-checks.xml b/config/checkstyle-examples-checks.xml
@@ -12,7 +12,11 @@
   <module name="SuppressionFilter">
     <property name="file" value="${checkstyle.examples-suppressions.file}"/>
   </module>
-
+  <module name="SuppressWithNearbyTextFilter">
+    <property name="nearbyTextPattern" value="violation above 'Trailing whitespace'"/>
+    <property name="lineRange" value="-1"/>
+    <property name="checkPattern" value="RegexpSingleline"/>
+  </module>
   <!-- Regexp -->
   <module name="RegexpOnFilename">
     <property name="id" value="exampleFileName"/>

diff --git a/config/checkstyle-examples-suppressions.xml b/config/checkstyle-examples-suppressions.xml
@@ -6,6 +6,10 @@
 
 <suppressions>
 
+  <!-- private class used to show violation on it -->
+  <suppress id="exampleClassName"
+    files="regexp[\\/]Example4.java"/>
+
   <!-- The files have no exampleClassName by design. -->
   <suppress id="exampleClassName"
     files="outertypefilename[\\/]Example3.java"/>

diff --git a/config/jsoref-spellchecker/whitelist.words b/config/jsoref-spellchecker/whitelist.words
@@ -917,7 +917,6 @@ NODESET
 noembed
 noenumtrailingcomma
 nofinalizer
-NOI
 noinspection
 noinspectionreason
 nojavadoc
@@ -1048,7 +1047,6 @@ Perror
 pgjdbc
 Pgpg
 Pgpgv
-pguyot
 php
 picocli
 pid
@@ -1147,7 +1145,6 @@ returnsreceiver
 reviewdog
 revwalk
 rfc
-rfe
 Rgb
 rgba
 rhs
@@ -1199,7 +1196,6 @@ SEO
 separatorwrap
 SERIALVERSIONUID
 servlet
-SETPOINT
 severitymatchfilter
 sevntu
 shanegenschaw

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/regexp/RegexpCheck.java
@@ -90,6 +90,19 @@
  * if you want to match a &lt; symbol you need to enter &amp;lt;.
  * The regular expression should be entered on one line.
  * </p>
+ *
+ * <p>
+ * <b>Note:</b> To search for parentheses () in a regular expression
+ * you must escape them like \(\). This is required by the regexp engine,
+ * otherwise it will think they are special instruction characters.
+ * </p>
+ *
+ * <p>
+ * <b>Note:</b> To search for things that mean something in XML, like
+ * &lt; you need to escape them like &amp;lt;. This is required so the
+ * XML parser does not act on them, but instead passes the correct
+ * character to the regexp engine.
+ * </p>
  * <ul>
  * <li>
  * Property {@code duplicateLimit} - Control whether to check for duplicates

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/regexp/RegexpCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/regexp/RegexpCheck.xml
@@ -62,6 +62,19 @@
  the XML config file you must also take into account the XML rules. e.g.
  if you want to match a &amp;lt; symbol you need to enter &amp;amp;lt;.
  The regular expression should be entered on one line.
+ &lt;/p&gt;
+
+ &lt;p&gt;
+ &lt;b&gt;Note:&lt;/b&gt; To search for parentheses () in a regular expression
+ you must escape them like \(\). This is required by the regexp engine,
+ otherwise it will think they are special instruction characters.
+ &lt;/p&gt;
+
+ &lt;p&gt;
+ &lt;b&gt;Note:&lt;/b&gt; To search for things that mean something in XML, like
+ &amp;lt; you need to escape them like &amp;amp;lt;. This is required so the
+ XML parser does not act on them, but instead passes the correct
+ character to the regexp engine.
  &lt;/p&gt;</description>
          <properties>
             <property default-value="0" name="duplicateLimit" type="int">