com.puppycrawl.tools.checkstyle.meta.checks.naming.PackageNameCheck.xml Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard

There is a newer version: 8.8

<?xml version="1.0" encoding="UTF-8"?>
<checkstyle-metadata>
   <module>
      <check fully-qualified-name="com.puppycrawl.tools.checkstyle.checks.naming.PackageNameCheck"
             name="PackageName"
             parent="com.puppycrawl.tools.checkstyle.TreeWalker">
         <description>&lt;div&gt;
 Checks that package names conform to a specified pattern.
 &lt;/div&gt;

 &lt;p&gt;
 The default value of {@code format} for module {@code PackageName} has been chosen to match
 the requirements in the
 &lt;a href="https://docs.oracle.com/javase/specs/jls/se8/html/jls-6.html#jls-6.5.3"&gt;
 Java Language specification&lt;/a&gt;
 and the Sun coding conventions. However, both underscores and uppercase letters are rather
 uncommon, so most configurations should probably assign value
 {@code ^[a-z]+(\.[a-z][a-z0-9]*)*$} to {@code format} for module {@code PackageName}.
 &lt;/p&gt;</description>
         <properties>
            <property default-value="^[a-z]+(\.[a-zA-Z_]\w*)*$"
                      name="format"
                      type="java.util.regex.Pattern">
               <description>Control the pattern to match valid identifiers.</description>
            </property>
         </properties>
         <message-keys>
            <message-key key="name.invalidPattern"/>
         </message-keys>
      </check>
   </module>
</checkstyle-metadata>