|
| 1 | +<?xml version="1.0"?> |
| 2 | +<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> |
| 3 | + |
| 4 | +<!-- |
| 5 | + finmath lib checkstyle configuration. |
| 6 | + Adapted from the sun coding conventions. |
| 7 | + Currently many checks are disabled as we are slowing adding our own conventions. |
| 8 | + For updates check the finmath lib project home page. |
| 9 | +--> |
| 10 | + |
| 11 | +<module name="Checker"> |
| 12 | + <!-- If you set the basedir property below, then all reported file names |
| 13 | + will be relative to the specified directory. See http://checkstyle.sourceforge.net/5.x/config.html#Checker |
| 14 | + <property name="basedir" value="${basedir}"/> --> |
| 15 | + |
| 16 | + <property name="fileExtensions" value="java, properties, xml" /> |
| 17 | + |
| 18 | + <!-- Checks that a package-info.java file exists for each package. --> |
| 19 | + <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage --> |
| 20 | + <module name="JavadocPackage" /> |
| 21 | + |
| 22 | + <!-- Checks whether files end with a new line. --> |
| 23 | + <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> |
| 24 | + <!-- |
| 25 | + <module name="NewlineAtEndOfFile"> |
| 26 | + <property name="lineSeparator" value="lf" /> |
| 27 | + </module> |
| 28 | + --> |
| 29 | + |
| 30 | + <!-- Checks that property files contain the same keys. --> |
| 31 | + <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> |
| 32 | + <!-- <module name="Translation" /> --> |
| 33 | + |
| 34 | + <!-- Checks for Size Violations. --> |
| 35 | + <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| 36 | + <!-- <module name="FileLength" /> --> |
| 37 | + |
| 38 | + <!-- Checks for whitespace --> |
| 39 | + <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| 40 | + <!-- <module name="FileTabCharacter" /> --> |
| 41 | + |
| 42 | + <!-- Miscellaneous other checks. --> |
| 43 | + <!-- See http://checkstyle.sf.net/config_misc.html --> |
| 44 | + <module name="RegexpSingleline"> |
| 45 | + <!-- Lines should not have trailing whitespace, only exception is a single |
| 46 | + empty JavaDoc line --> |
| 47 | + <property name="format" value="^(?!\s+\* $).*?\s+$" /> |
| 48 | + <property name="minimum" value="0" /> |
| 49 | + <property name="maximum" value="0" /> |
| 50 | + <property name="message" value="Line has trailing spaces." /> |
| 51 | + </module> |
| 52 | + |
| 53 | + <!-- <module name="LineLength"> <property name="max" value="400" /> </module> --> |
| 54 | + |
| 55 | + <!-- Checks for Headers --> |
| 56 | + <!-- See http://checkstyle.sf.net/config_header.html --> |
| 57 | + <!-- <module name="Header"> --> |
| 58 | + <!-- <property name="headerFile" value="${checkstyle.header.file}"/> --> |
| 59 | + <!-- <property name="fileExtensions" value="java"/> --> |
| 60 | + <!-- </module> --> |
| 61 | + |
| 62 | + <module name="TreeWalker"> |
| 63 | + |
| 64 | + <!-- Checks for Javadoc comments. --> |
| 65 | + <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
| 66 | + <!-- <module name="JavadocMethod" /> --> |
| 67 | + <module name="JavadocType"> |
| 68 | + <property name="scope" value="public" /> |
| 69 | + <property name="allowUnknownTags" value="true" /> |
| 70 | + <!-- Add ENUM_DEF, ANNOTATION_DEF in future version. --> |
| 71 | + <property name="tokens" value="INTERFACE_DEF, CLASS_DEF" /> |
| 72 | + </module> |
| 73 | + <!-- <module name="JavadocVariable" /> --> |
| 74 | + <!-- <module name="JavadocStyle" /> --> |
| 75 | + |
| 76 | + <!-- Checks for Naming Conventions. --> |
| 77 | + <!-- See http://checkstyle.sf.net/config_naming.html --> |
| 78 | + <!-- <module name="ConstantName" /> --> |
| 79 | + <!-- <module name="LocalFinalVariableName" /> --> |
| 80 | + |
| 81 | + <!-- THE FOLLOWING WILL BECOME ACTIVE SOON. --> |
| 82 | + <!-- <module name="LocalVariableName"> <property name="allowOneCharVarInForLoop" |
| 83 | + value="true"/> </module> --> |
| 84 | + |
| 85 | + <module name="MemberName" /> |
| 86 | + |
| 87 | + <!-- THE FOLLOWING WILL BECOME ACTIVE SOON. --> |
| 88 | + <!-- <module name="MethodName" /> --> |
| 89 | + |
| 90 | + <module name="PackageName" /> |
| 91 | + <module name="ParameterName" /> |
| 92 | + <module name="StaticVariableName" /> |
| 93 | + |
| 94 | + <!-- THE FOLLOWING WILL BECOME ACTIVE without underscores SOON. --> |
| 95 | + <module name="TypeName"> |
| 96 | + <property name="format" value="^[A-Z][a-zA-Z0-9_]*$" /> |
| 97 | + </module> |
| 98 | + |
| 99 | + <!-- Checks for imports --> |
| 100 | + <!-- See http://checkstyle.sf.net/config_import.html --> |
| 101 | + <module name="AvoidStarImport" /> |
| 102 | + <module name="IllegalImport" /> <!-- defaults to sun.* packages --> |
| 103 | + <module name="RedundantImport" /> |
| 104 | + <module name="UnusedImports"> |
| 105 | + <property name="processJavadoc" value="true" /> |
| 106 | + </module> |
| 107 | + |
| 108 | + <!-- Checks for Size Violations. --> |
| 109 | + <!-- See http://checkstyle.sf.net/config_sizes.html --> |
| 110 | + <module name="MethodLength"> |
| 111 | + <property name="tokens" value="METHOD_DEF" /> |
| 112 | + <property name="max" value="350" /> |
| 113 | + </module> |
| 114 | + <module name="ParameterNumber"> |
| 115 | + <property name="max" value="15" /> |
| 116 | + </module> |
| 117 | + |
| 118 | + <!-- Checks for whitespace --> |
| 119 | + <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| 120 | + <!-- <module name="EmptyForIteratorPad" /> <module name="GenericWhitespace" |
| 121 | + /> <module name="MethodParamPad" /> <module name="NoWhitespaceAfter" /> <module |
| 122 | + name="NoWhitespaceBefore" /> <module name="OperatorWrap" /> <module name="ParenPad" |
| 123 | + /> <module name="TypecastParenPad" /> <module name="WhitespaceAfter" /> <module |
| 124 | + name="WhitespaceAround" /> --> |
| 125 | + |
| 126 | + <!-- Modifier Checks --> |
| 127 | + <!-- See http://checkstyle.sf.net/config_modifiers.html --> |
| 128 | + <module name="ModifierOrder" /> |
| 129 | + <module name="RedundantModifier" /> |
| 130 | + |
| 131 | + <!-- Checks for blocks. You know, those {}'s --> |
| 132 | + <!-- See http://checkstyle.sf.net/config_blocks.html --> |
| 133 | + <module name="AvoidNestedBlocks"> |
| 134 | + <property name="allowInSwitchCase" value="true" /> |
| 135 | + </module> |
| 136 | + <module name="EmptyBlock" /> |
| 137 | + <!-- <module name="LeftCurly"/> --> |
| 138 | + |
| 139 | + <module name="NeedBraces"> |
| 140 | + <property name="allowSingleLineStatement" value="true" /> |
| 141 | + </module> |
| 142 | + <!-- <module name="RightCurly" /> --> |
| 143 | + |
| 144 | + <!-- Checks for common coding problems --> |
| 145 | + <!-- See http://checkstyle.sf.net/config_coding.html --> |
| 146 | + <!-- <module name="AvoidInlineConditionals" /> --> |
| 147 | + <module name="EmptyStatement" /> |
| 148 | + <module name="EqualsHashCode" /> |
| 149 | + <!-- <module name="HiddenField"> <property name="ignoreConstructorParameter" |
| 150 | + value="true" /> <property name="ignoreSetter" value="true" /> <property name="setterCanReturnItsClass" |
| 151 | + value="true" /> </module> --> |
| 152 | + <module name="IllegalInstantiation" /> |
| 153 | + <module name="InnerAssignment" /> |
| 154 | + <!-- <module name="MagicNumber" /> --> |
| 155 | + <module name="MissingSwitchDefault" /> |
| 156 | + <!-- <module name="SimplifyBooleanExpression" /> --> |
| 157 | + <module name="SimplifyBooleanReturn" /> |
| 158 | + |
| 159 | + <!-- Checks for class design --> |
| 160 | + <!-- See http://checkstyle.sf.net/config_design.html --> |
| 161 | + <!-- <module name="DesignForExtension" /> <module name="FinalClass" /> |
| 162 | + <module name="HideUtilityClassConstructor" /> <module name="InterfaceIsType" |
| 163 | + /> --> |
| 164 | + |
| 165 | + <module name="VisibilityModifier"> |
| 166 | + <property name="allowPublicImmutableFields" value="true" /> |
| 167 | + </module> |
| 168 | + |
| 169 | + <!-- Miscellaneous other checks. --> |
| 170 | + <!-- See http://checkstyle.sf.net/config_misc.html --> |
| 171 | + <module name="ArrayTypeStyle" /> |
| 172 | + <!-- |
| 173 | + <module name="FinalParameters"> |
| 174 | + <property name="ignorePrimitiveTypes" value="true" /> |
| 175 | + </module> |
| 176 | + --> |
| 177 | + <module name="TodoComment" /> |
| 178 | + <module name="UpperEll" /> |
| 179 | + |
| 180 | + <module name="RegexpSinglelineJava"> |
| 181 | + <property name="format" value="^\t*(?! \*) " /> |
| 182 | + <property name="message" |
| 183 | + value="Indent must use tab characters" /> |
| 184 | + </module> |
| 185 | + </module> |
| 186 | +</module> |
0 commit comments