Issue checkstyle#13693: migrate misc modules to property macros

piyush-1234 · Jan 5, 2024 · e449968 · e449968
1 parent a5d0468
commit e449968
Show file tree

Hide file tree

Showing 19 changed files with 63 additions and 174 deletions.
diff --git a/config/checkstyle-non-main-files-suppressions.xml b/config/checkstyle-non-main-files-suppressions.xml
@@ -253,18 +253,6 @@
   <!-- Properties macro suppressions until https://github.com/checkstyle/checkstyle/issues/13693 -->
   <suppress id="propertiesMacroMustExist"
          files="src[\\/]xdocs[\\/]checks[\\/]imports[\\/]customimportorder.xml.template"/>
-  <suppress id="propertiesMacroMustExist"
-         files="src[\\/]xdocs[\\/]checks[\\/]misc[\\/]orderedproperties.xml.template"/>
-  <suppress id="propertiesMacroMustExist"
-         files="src[\\/]xdocs[\\/]checks[\\/]misc[\\/]todocomment.xml.template"/>
-  <suppress id="propertiesMacroMustExist"
-         files="src[\\/]xdocs[\\/]checks[\\/]misc[\\/]trailingcomment.xml.template"/>
-  <suppress id="propertiesMacroMustExist"
-         files="src[\\/]xdocs[\\/]checks[\\/]misc[\\/]translation.xml.template"/>
-  <suppress id="propertiesMacroMustExist"
-         files="src[\\/]xdocs[\\/]checks[\\/]misc[\\/]uncommentedmain.xml.template"/>
-  <suppress id="propertiesMacroMustExist"
-         files="src[\\/]xdocs[\\/]checks[\\/]misc[\\/]uniqueproperties.xml.template"/>
 
   <!-- no properties by design -->
   <suppress id="propertiesMacroMustExist"

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/OrderedPropertiesCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/OrderedPropertiesCheck.java
@@ -54,7 +54,7 @@
  * <p>Known limitation: The key should not contain a newline.
  * The string compare will work, but not the line number reporting.</p>
  * <ul><li>
- * Property {@code fileExtensions} - Specify file type extension of the files to check.
+ * Property {@code fileExtensions} - Specify the file extensions of the files to process.
  * Type is {@code java.lang.String[]}.
  * Default value is {@code .properties}.
  * </li></ul>

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java
@@ -93,6 +93,11 @@
  * of default translation files in project.
  * </p>
  * <p>
+ * Note: If your project uses preprocessed translation files and the original files do not have the
+ * {@code properties} extension, you can specify additional file extensions
+ * via the {@code fileExtensions} property.
+ * </p>
+ * <p>
  * Attention: the check will perform the validation of ISO codes if the option
  * is used. So, if you specify, for example, "mm" for language code,
  * TranslationCheck will rise violation that the language code is incorrect.
@@ -113,10 +118,7 @@
  * Default value is {@code "^messages.*$"}.
  * </li>
  * <li>
- * Property {@code fileExtensions} - Specify file type extension to identify
- * translation files. Setting this property is typically only required if your
- * translation files are preprocessed and the original files do not have
- * the extension {@code .properties}
+ * Property {@code fileExtensions} - Specify the file extensions of the files to process.
  * Type is {@code java.lang.String[]}.
  * Default value is {@code .properties}.
  * </li>

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/UniquePropertiesCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/UniquePropertiesCheck.java
@@ -46,7 +46,7 @@
  * </p>
  * <ul>
  * <li>
- * Property {@code fileExtensions} - Specify file type extension of the files to check.
+ * Property {@code fileExtensions} - Specify the file extensions of the files to process.
  * Type is {@code java.lang.String[]}.
  * Default value is {@code .properties}.
  * </li>

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/site/SiteUtil.java b/src/main/java/com/puppycrawl/tools/checkstyle/site/SiteUtil.java
@@ -250,6 +250,9 @@ public final class SiteUtil {
         Map.entry("FileTabCharacterCheck.fileExtensions", VERSION_5_0),
         Map.entry("NewlineAtEndOfFileCheck.fileExtensions", "3.1"),
         Map.entry("JavadocPackageCheck.fileExtensions", VERSION_5_0),
+        Map.entry("OrderedPropertiesCheck.fileExtensions", "8.22"),
+        Map.entry("UniquePropertiesCheck.fileExtensions", VERSION_5_7),
+        Map.entry("TranslationCheck.fileExtensions", VERSION_3_0),
         Map.entry("LineLengthCheck.fileExtensions", V824),
         // until https://github.com/checkstyle/checkstyle/issues/14052
         Map.entry("JavadocBlockTagLocationCheck.violateExecutionOnNonTightHtml", V824),

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/OrderedPropertiesCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/OrderedPropertiesCheck.xml
@@ -24,7 +24,7 @@
             <property default-value=".properties"
                       name="fileExtensions"
                       type="java.lang.String[]">
-               <description>Specify file type extension of the files to check.</description>
+               <description>Specify the file extensions of the files to process.</description>
             </property>
          </properties>
          <message-keys>

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/TranslationCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/TranslationCheck.xml
@@ -44,6 +44,11 @@
  of default translation files in project.
  &lt;/p&gt;
  &lt;p&gt;
+ Note: If your project uses preprocessed translation files and the original files do not have the
+ {@code properties} extension, you can specify additional file extensions
+ via the {@code fileExtensions} property.
+ &lt;/p&gt;
+ &lt;p&gt;
  Attention: the check will perform the validation of ISO codes if the option
  is used. So, if you specify, for example, "mm" for language code,
  TranslationCheck will rise violation that the language code is incorrect.
@@ -66,10 +71,7 @@
             <property default-value=".properties"
                       name="fileExtensions"
                       type="java.lang.String[]">
-               <description>Specify file type extension to identify
- translation files. Setting this property is typically only required if your
- translation files are preprocessed and the original files do not have
- the extension {@code .properties}</description>
+               <description>Specify the file extensions of the files to process.</description>
             </property>
             <property default-value=""
                       name="requiredTranslations"

diff --git a/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/UniquePropertiesCheck.xml b/src/main/resources/com/puppycrawl/tools/checkstyle/meta/checks/UniquePropertiesCheck.xml
@@ -16,7 +16,7 @@
             <property default-value=".properties"
                       name="fileExtensions"
                       type="java.lang.String[]">
-               <description>Specify file type extension of the files to check.</description>
+               <description>Specify the file extensions of the files to process.</description>
             </property>
          </properties>
          <message-keys>

diff --git a/src/xdocs/checks/misc/orderedproperties.xml b/src/xdocs/checks/misc/orderedproperties.xml
@@ -43,7 +43,7 @@
             </tr>
             <tr>
               <td>fileExtensions</td>
-              <td>Specify file type extension of the files to check.</td>
+              <td>Specify the file extensions of the files to process.</td>
               <td><a href="../../property_types.html#String.5B.5D">String[]</a></td>
               <td><code>.properties</code></td>
               <td>8.22</td>

diff --git a/src/xdocs/checks/misc/orderedproperties.xml.template b/src/xdocs/checks/misc/orderedproperties.xml.template
@@ -33,22 +33,10 @@
 
       <subsection name="Properties" id="Properties">
         <div class="wrapper">
-          <table>
-            <tr>
-              <th>name</th>
-              <th>description</th>
-              <th>type</th>
-              <th>default value</th>
-              <th>since</th>
-            </tr>
-            <tr>
-              <td>fileExtensions</td>
-              <td>Specify file type extension of the files to check.</td>
-              <td><a href="../../property_types.html#String.5B.5D">String[]</a></td>
-              <td><code>.properties</code></td>
-              <td>8.22</td>
-            </tr>
-          </table>
+          <macro name="properties">
+            <param name="modulePath"
+                   value="src/main/java/com/puppycrawl/tools/checkstyle/checks/OrderedPropertiesCheck.java"/>
+          </macro>
         </div>
       </subsection>
 

diff --git a/src/xdocs/checks/misc/todocomment.xml.template b/src/xdocs/checks/misc/todocomment.xml.template
@@ -20,22 +20,10 @@
 
       <subsection name="Properties" id="Properties">
         <div class="wrapper">
-          <table>
-            <tr>
-              <th>name</th>
-              <th>description</th>
-              <th>type</th>
-              <th>default value</th>
-              <th>since</th>
-            </tr>
-            <tr>
-              <td>format</td>
-              <td>Specify pattern to match comments against.</td>
-              <td><a href="../../property_types.html#Pattern">Pattern</a></td>
-              <td><code>"TODO:"</code></td>
-              <td>3.0</td>
-            </tr>
-          </table>
+          <macro name="properties">
+            <param name="modulePath"
+                   value="src/main/java/com/puppycrawl/tools/checkstyle/checks/TodoCommentCheck.java"/>
+          </macro>
         </div>
       </subsection>
 

diff --git a/src/xdocs/checks/misc/trailingcomment.xml b/src/xdocs/checks/misc/trailingcomment.xml
@@ -90,8 +90,7 @@ d = e / f;        // Another comment for this line
             </tr>
             <tr>
               <td>legalComment</td>
-              <td>Define pattern for text allowed in trailing comments. This
-                  pattern will not be applied to multiline comments.</td>
+              <td>Define pattern for text allowed in trailing comments. This pattern will not be applied to multiline comments.</td>
               <td><a href="../../property_types.html#Pattern">Pattern</a></td>
               <td><code>null</code></td>
               <td>4.2</td>

diff --git a/src/xdocs/checks/misc/trailingcomment.xml.template b/src/xdocs/checks/misc/trailingcomment.xml.template
@@ -73,30 +73,10 @@ d = e / f;        // Another comment for this line
 
       <subsection name="Properties" id="Properties">
         <div class="wrapper">
-          <table>
-            <tr>
-              <th>name</th>
-              <th>description</th>
-              <th>type</th>
-              <th>default value</th>
-              <th>since</th>
-            </tr>
-            <tr>
-              <td>format</td>
-              <td>Specify pattern for strings allowed before the comment.</td>
-              <td><a href="../../property_types.html#Pattern">Pattern</a></td>
-              <td><code>"^[\s});]*$"</code></td>
-              <td>3.4</td>
-            </tr>
-            <tr>
-              <td>legalComment</td>
-              <td>Define pattern for text allowed in trailing comments. This
-                  pattern will not be applied to multiline comments.</td>
-              <td><a href="../../property_types.html#Pattern">Pattern</a></td>
-              <td><code>null</code></td>
-              <td>4.2</td>
-            </tr>
-          </table>
+          <macro name="properties">
+            <param name="modulePath"
+                   value="src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java"/>
+          </macro>
         </div>
       </subsection>
 

diff --git a/src/xdocs/checks/misc/translation.xml b/src/xdocs/checks/misc/translation.xml
@@ -54,6 +54,12 @@ messages.properties: Key 'ok' missing.
           one language code) of required translations the check will also check for
           existence of default translation files in project.
         </p>
+        <p>
+          Note: If your project uses preprocessed translation files and the original files
+          do not have the <code>properties</code> extension,
+          you can specify additional file extensions
+          via the <code>fileExtensions</code> property.
+        </p>
         <p>
           Attention: the check will perform the validation of ISO codes if the option
           is used. So, if you specify, for example, &quot;mm&quot; for language code, TranslationCheck
@@ -79,32 +85,22 @@ messages.properties: Key 'ok' missing.
             </tr>
             <tr>
               <td>baseName</td>
-              <td>Specify
-                <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ResourceBundle.html">
-                Base name</a> of resource bundles which contain message resources. It helps
-                the check to distinguish config and localization resources.
-              </td>
+              <td>Specify <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ResourceBundle.html">
+ Base name</a> of resource bundles which contain message resources. It helps the check to distinguish config and localization resources.</td>
               <td><a href="../../property_types.html#Pattern">Pattern</a></td>
               <td><code>&quot;^messages.*$&quot;</code></td>
               <td>6.17</td>
             </tr>
             <tr>
               <td>fileExtensions</td>
-              <td>
-                Specify file type extension to identify translation files. Setting
-                this property is typically only required if your
-                translation files are preprocessed and the original files
-                do not have the extension <code>.properties</code>
-              </td>
+              <td>Specify the file extensions of the files to process.</td>
               <td><a href="../../property_types.html#String.5B.5D">String[]</a></td>
               <td><code>.properties</code></td>
               <td>3.0</td>
             </tr>
             <tr>
               <td>requiredTranslations</td>
-              <td>
-                Specify language codes of required translations which must exist in project.
-              </td>
+              <td>Specify language codes of required translations which must exist in project.</td>
               <td><a href="../../property_types.html#String.5B.5D">String[]</a></td>
               <td><code>{}</code></td>
               <td>6.11</td>

diff --git a/src/xdocs/checks/misc/translation.xml.template b/src/xdocs/checks/misc/translation.xml.template
@@ -54,6 +54,12 @@ messages.properties: Key 'ok' missing.
           one language code) of required translations the check will also check for
           existence of default translation files in project.
         </p>
+        <p>
+          Note: If your project uses preprocessed translation files and the original files
+          do not have the <code>properties</code> extension,
+          you can specify additional file extensions
+          via the <code>fileExtensions</code> property.
+        </p>
         <p>
           Attention: the check will perform the validation of ISO codes if the option
           is used. So, if you specify, for example, "mm" for language code, TranslationCheck
@@ -69,47 +75,10 @@ messages.properties: Key 'ok' missing.
 
       <subsection name="Properties" id="Properties">
         <div class="wrapper">
-          <table>
-            <tr>
-              <th>name</th>
-              <th>description</th>
-              <th>type</th>
-              <th>default value</th>
-              <th>since</th>
-            </tr>
-            <tr>
-              <td>baseName</td>
-              <td>Specify
-                <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/ResourceBundle.html">
-                Base name</a> of resource bundles which contain message resources. It helps
-                the check to distinguish config and localization resources.
-              </td>
-              <td><a href="../../property_types.html#Pattern">Pattern</a></td>
-              <td><code>"^messages.*$"</code></td>
-              <td>6.17</td>
-            </tr>
-            <tr>
-              <td>fileExtensions</td>
-              <td>
-                Specify file type extension to identify translation files. Setting
-                this property is typically only required if your
-                translation files are preprocessed and the original files
-                do not have the extension <code>.properties</code>
-              </td>
-              <td><a href="../../property_types.html#String.5B.5D">String[]</a></td>
-              <td><code>.properties</code></td>
-              <td>3.0</td>
-            </tr>
-            <tr>
-              <td>requiredTranslations</td>
-              <td>
-                Specify language codes of required translations which must exist in project.
-              </td>
-              <td><a href="../../property_types.html#String.5B.5D">String[]</a></td>
-              <td><code>{}</code></td>
-              <td>6.11</td>
-            </tr>
-          </table>
+          <macro name="properties">
+            <param name="modulePath"
+                   value="src/main/java/com/puppycrawl/tools/checkstyle/checks/TranslationCheck.java"/>
+          </macro>
         </div>
       </subsection>
 

diff --git a/src/xdocs/checks/misc/uncommentedmain.xml b/src/xdocs/checks/misc/uncommentedmain.xml
@@ -35,8 +35,7 @@
             </tr>
             <tr>
               <td>excludedClasses</td>
-              <td>Specify pattern for qualified names of classes which are allowed
-              to have a <code>main</code> method.</td>
+              <td>Specify pattern for qualified names of classes which are allowed to have a <code>main</code> method.</td>
               <td><a href="../../property_types.html#Pattern">Pattern</a></td>
               <td><code>&quot;^$&quot;</code></td>
               <td>3.2</td>

diff --git a/src/xdocs/checks/misc/uncommentedmain.xml.template b/src/xdocs/checks/misc/uncommentedmain.xml.template
@@ -25,23 +25,10 @@
 
       <subsection name="Properties" id="Properties">
         <div class="wrapper">
-          <table>
-            <tr>
-              <th>name</th>
-              <th>description</th>
-              <th>type</th>
-              <th>default value</th>
-              <th>since</th>
-            </tr>
-            <tr>
-              <td>excludedClasses</td>
-              <td>Specify pattern for qualified names of classes which are allowed
-              to have a <code>main</code> method.</td>
-              <td><a href="../../property_types.html#Pattern">Pattern</a></td>
-              <td><code>"^$"</code></td>
-              <td>3.2</td>
-            </tr>
-          </table>
+          <macro name="properties">
+            <param name="modulePath"
+                   value="src/main/java/com/puppycrawl/tools/checkstyle/checks/UncommentedMainCheck.java"/>
+          </macro>
         </div>
       </subsection>
 

diff --git a/src/xdocs/checks/misc/uniqueproperties.xml b/src/xdocs/checks/misc/uniqueproperties.xml
@@ -33,7 +33,7 @@
             </tr>
             <tr>
               <td>fileExtensions</td>
-              <td>Specify file type extension of the files to check.</td>
+              <td>Specify the file extensions of the files to process.</td>
               <td><a href="../../property_types.html#String.5B.5D">String[]</a></td>
               <td><code>.properties</code></td>
               <td>5.7</td>