Paper/paper-api/checkstyle.xml
2024-08-12 21:26:44 +10:00

108 lines
4.5 KiB
XML

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<module name="Checker">
<!-- See https://checkstyle.org/checks/misc/newlineatendoffile.html#NewlineAtEndOfFile -->
<module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="lf_cr_crlf"/>
</module>
<!-- See https://checkstyle.org/checks/whitespace/filetabcharacter.html#FileTabCharacter -->
<module name="FileTabCharacter"/>
<!-- See https://checkstyle.org/checks/regexp/regexpsingleline.html -->
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
</module>
<!-- See SPIGOT-7676: Enforce Locale, to prevent issues with turkish 'I' and similar -->
<module name="RegexpSingleline">
<property name="format" value="\.toUpperCase\(\s*\)"/>
<property name="message" value="Use toUpperCase(Locale.ROOT) instead of toUpperCase()"/>
</module>
<module name="RegexpSingleline">
<property name="format" value="\.toLowerCase\(\s*\)"/>
<property name="message" value="Use toLowerCase(Locale.ROOT) instead of toLowerCase()"/>
</module>
<!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage -->
<module name="JavadocPackage"/>
<!-- See https://checkstyle.org/filters/suppressionsinglefilter.html#SuppressionSingleFilter -->
<module name="SuppressionSingleFilter">
<property name="message" value="'(implNote|implSpec|apiNote)'\."/>
</module>
<!-- Don't check for missing package-info in tests -->
<module name="SuppressionSingleFilter">
<property name="checks" value="JavadocPackage"/>
<property name="files" value=".*[\\/]src[\\/]test[\\/].*\.java$"/>
</module>
<module name="TreeWalker">
<!-- See https://checkstyle.org/checks/javadoc/index.html -->
<module name="AtclauseOrder"/>
<module name="InvalidJavadocPosition"/>
<module name="JavadocBlockTagLocation"/>
<module name="JavadocContentLocationCheck"/>
<module name="JavadocMethod"/>
<module name="JavadocType"/>
<module name="MissingJavadocPackage"/>
<module name="NonEmptyAtclauseDescription"/>
<!-- See https://checkstyle.org/filters/index.html -->
<module name="SuppressionCommentFilter"/>
<!-- See https://checkstyle.org/checks/imports/index.html -->
<module name="AvoidStarImport">
<property name="allowStaticMemberImports" value="true"/>
</module>
<module name="ImportOrder">
<property name="option" value="above"/>
<property name="ordered" value="true"/>
<property name="separatedStaticGroups" value="true"/>
<property name="sortStaticImportsAlphabetically" value="true"/>
</module>
<module name="RedundantImport"/>
<module name="UnusedImports"/>
<!-- See https://checkstyle.org/checks/whitespace/index.html -->
<module name="GenericWhitespace"/>
<module name="MethodParamPad"/>
<module name="NoLineWrap"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore">
<property name="allowLineBreaks" value="true"/>
</module>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<module name="SingleSpaceSeparator"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround">
<property name="allowEmptyCatches" value="true"/>
<property name="allowEmptyConstructors" value="true"/>
<property name="allowEmptyMethods" value="true"/>
<property name="allowEmptyTypes" value="true"/>
</module>
<!-- See https://checkstyle.org/checks/modifier/index.html -->
<module name="ModifierOrder"/>
<!-- See https://checkstyle.org/checks/blocks/index.html -->
<module name="AvoidNestedBlocks"/>
<module name="LeftCurly"/>
<module name="RightCurly"/>
<!-- See https://checkstyle.org/checks/design/index.html -->
<module name="FinalClass"/>
<!-- See https://checkstyle.org/checks/misc/index.html -->
<module name="ArrayTypeStyle"/>
<module name="UpperEll"/>
</module>
</module>