|
| 1 | +<!-- |
| 2 | + ~ Licensed to the Apache Software Foundation (ASF) under one or more |
| 3 | + ~ contributor license agreements. See the NOTICE file distributed with |
| 4 | + ~ this work for additional information regarding copyright ownership. |
| 5 | + ~ The ASF licenses this file to You under the Apache License, Version 2.0 |
| 6 | + ~ (the "License"); you may not use this file except in compliance with |
| 7 | + ~ the License. You may obtain a copy of the License at |
| 8 | + ~ |
| 9 | + ~ http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + ~ |
| 11 | + ~ Unless required by applicable law or agreed to in writing, software |
| 12 | + ~ distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + ~ See the License for the specific language governing permissions and |
| 15 | + ~ limitations under the License. |
| 16 | + --> |
| 17 | + |
| 18 | +<!DOCTYPE module PUBLIC |
| 19 | + "-//Puppy Crawl//DTD Check Configuration 1.3//EN" |
| 20 | + "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> |
| 21 | + |
| 22 | +<!-- |
| 23 | +
|
| 24 | + Checkstyle configuration based on the Google coding conventions from: |
| 25 | +
|
| 26 | + - Google Java Style |
| 27 | + https://google-styleguide.googlecode.com/svn-history/r130/trunk/javaguide.html |
| 28 | +
|
| 29 | + with Spark-specific changes from: |
| 30 | +
|
| 31 | + http://spark.apache.org/contributing.html#code-style-guide |
| 32 | +
|
| 33 | + Checkstyle is very configurable. Be sure to read the documentation at |
| 34 | + http://checkstyle.sf.net (or in your downloaded distribution). |
| 35 | +
|
| 36 | + Most Checks are configurable, be sure to consult the documentation. |
| 37 | +
|
| 38 | + To completely disable a check, just comment it out or delete it from the file. |
| 39 | +
|
| 40 | + Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. |
| 41 | +
|
| 42 | + --> |
| 43 | + |
| 44 | +<module name = "Checker"> |
| 45 | + <property name="charset" value="UTF-8"/> |
| 46 | + |
| 47 | + <property name="severity" value="error"/> |
| 48 | + |
| 49 | + <property name="fileExtensions" value="java, properties, xml"/> |
| 50 | + |
| 51 | + <!-- Checks for whitespace --> |
| 52 | + <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
| 53 | + <module name="FileTabCharacter"> |
| 54 | + <property name="eachLine" value="true"/> |
| 55 | + </module> |
| 56 | + |
| 57 | + <module name="RegexpSingleline"> |
| 58 | + <!-- \s matches whitespace character, $ matches end of line. --> |
| 59 | + <property name="format" value="\s+$"/> |
| 60 | + <property name="message" value="No trailing whitespace allowed."/> |
| 61 | + </module> |
| 62 | + |
| 63 | + <module name="NewlineAtEndOfFile"> |
| 64 | + <property name="lineSeparator" value="lf"/> |
| 65 | + </module> |
| 66 | + <module name="SuppressWarningsFilter" /> |
| 67 | + |
| 68 | + <module name="TreeWalker"> |
| 69 | + <module name="SuppressWarningsHolder" /> |
| 70 | + <module name="OuterTypeFilename"/> |
| 71 | + <module name="IllegalTokenText"> |
| 72 | + <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/> |
| 73 | + <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/> |
| 74 | + <property name="message" value="Avoid using corresponding octal or Unicode escape."/> |
| 75 | + </module> |
| 76 | + <module name="AvoidEscapedUnicodeCharacters"> |
| 77 | + <property name="allowEscapesForControlCharacters" value="true"/> |
| 78 | + <property name="allowByTailComment" value="true"/> |
| 79 | + <property name="allowNonPrintableEscapes" value="true"/> |
| 80 | + </module> |
| 81 | + <module name="LineLength"> |
| 82 | + <property name="max" value="100"/> |
| 83 | + <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/> |
| 84 | + </module> |
| 85 | + <module name="NoLineWrap"/> |
| 86 | + <module name="EmptyBlock"> |
| 87 | + <property name="option" value="TEXT"/> |
| 88 | + <property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/> |
| 89 | + </module> |
| 90 | + <module name="NeedBraces"> |
| 91 | + <property name="allowSingleLineStatement" value="true"/> |
| 92 | + </module> |
| 93 | + <module name="OneStatementPerLine"/> |
| 94 | + <module name="ArrayTypeStyle"/> |
| 95 | + <module name="FallThrough"/> |
| 96 | + <module name="UpperEll"/> |
| 97 | + <module name="ModifierOrder"/> |
| 98 | + <module name="SeparatorWrap"> |
| 99 | + <property name="tokens" value="DOT"/> |
| 100 | + <property name="option" value="nl"/> |
| 101 | + </module> |
| 102 | + <module name="SeparatorWrap"> |
| 103 | + <property name="tokens" value="COMMA"/> |
| 104 | + <property name="option" value="EOL"/> |
| 105 | + </module> |
| 106 | + <module name="PackageName"> |
| 107 | + <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/> |
| 108 | + <message key="name.invalidPattern" |
| 109 | + value="Package name ''{0}'' must match pattern ''{1}''."/> |
| 110 | + </module> |
| 111 | + <module name="ClassTypeParameterName"> |
| 112 | + <property name="format" value="([A-Z][a-zA-Z0-9]*$)"/> |
| 113 | + <message key="name.invalidPattern" |
| 114 | + value="Class type name ''{0}'' must match pattern ''{1}''."/> |
| 115 | + </module> |
| 116 | + <module name="MethodTypeParameterName"> |
| 117 | + <property name="format" value="([A-Z][a-zA-Z0-9]*)"/> |
| 118 | + <message key="name.invalidPattern" |
| 119 | + value="Method type name ''{0}'' must match pattern ''{1}''."/> |
| 120 | + </module> |
| 121 | + <module name="GenericWhitespace"> |
| 122 | + <message key="ws.followed" |
| 123 | + value="GenericWhitespace ''{0}'' is followed by whitespace."/> |
| 124 | + <message key="ws.preceded" |
| 125 | + value="GenericWhitespace ''{0}'' is preceded with whitespace."/> |
| 126 | + <message key="ws.illegalFollow" |
| 127 | + value="GenericWhitespace ''{0}'' should followed by whitespace."/> |
| 128 | + <message key="ws.notPreceded" |
| 129 | + value="GenericWhitespace ''{0}'' is not preceded with whitespace."/> |
| 130 | + </module> |
| 131 | + |
| 132 | + <module name="Indentation"> |
| 133 | + <property name="basicOffset" value="2"/> |
| 134 | + <property name="braceAdjustment" value="0"/> |
| 135 | + <property name="caseIndent" value="2"/> |
| 136 | + <property name="throwsIndent" value="2"/> |
| 137 | + <property name="lineWrappingIndentation" value="2"/> |
| 138 | + <property name="arrayInitIndent" value="2"/> |
| 139 | + </module> |
| 140 | + |
| 141 | + |
| 142 | + <module name="MethodParamPad"/> |
| 143 | + <module name="AnnotationLocation"> |
| 144 | + <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/> |
| 145 | + </module> |
| 146 | + <module name="AnnotationLocation"> |
| 147 | + <property name="tokens" value="VARIABLE_DEF"/> |
| 148 | + <property name="allowSamelineMultipleAnnotations" value="true"/> |
| 149 | + </module> |
| 150 | + <module name="MethodName"> |
| 151 | + <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/> |
| 152 | + <message key="name.invalidPattern" |
| 153 | + value="Method name ''{0}'' must match pattern ''{1}''."/> |
| 154 | + </module> |
| 155 | + <module name="EmptyCatchBlock"> |
| 156 | + <property name="exceptionVariableName" value="expected"/> |
| 157 | + </module> |
| 158 | + <module name="CommentsIndentation"/> |
| 159 | + <module name="UnusedImports"/> |
| 160 | + <module name="RedundantImport"/> |
| 161 | + <module name="RedundantModifier"/> |
| 162 | + </module> |
| 163 | +</module> |
0 commit comments