source: josm/trunk/tools/checkstyle/josm_checks.xml @ 12582

Last change on this file since 12582 was 12582, checked in by bastiK, 6 years ago

see #14794 - add checkstyle check

File size: 5.3 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
3
4<!--
5    This configuration file was written by the eclipse-cs plugin configuration editor
6-->
7<!--
8    Checkstyle-Configuration: JOSM
9    Description:
10JOSM Checkstyle rules
11-->
12<module name="Checker">
13  <property name="severity" value="warning"/>
14  <property name="charset" value="UTF-8"/>
15  <module name="TreeWalker">
16    <module name="BooleanExpressionComplexity">
17      <property name="max" value="7"/>
18    </module>
19    <module name="CatchParameterName">
20      <property name="format" value="^(e[1-9]?|t|ex[1-9]?|[a-z][a-z][a-zA-Z]+)$"/>
21    </module>
22    <module name="CommentsIndentation"/>
23    <module name="FileContentsHolder"/>
24    <module name="MissingDeprecated"/>
25    <module name="MissingOverride"/>
26    <module name="PackageAnnotation"/>
27    <module name="AnnotationLocation">
28      <property name="allowSamelineMultipleAnnotations" value="true"/>
29    </module>
30    <module name="AnnotationUseStyle"/>
31    <module name="JavadocStyle">
32      <property name="checkFirstSentence" value="false"/>
33      <property name="checkHtml" value="false"/>
34    </module>
35    <module name="NonEmptyAtclauseDescription"/>
36    <module name="AtclauseOrder"/>
37    <module name="AvoidStarImport"/>
38    <module name="RedundantImport"/>
39    <module name="UnusedImports">
40      <property name="processJavadoc" value="true"/>
41    </module>
42    <module name="AnonInnerLength">
43      <property name="max" value="50"/>
44    </module>
45    <module name="ExecutableStatementCount">
46      <property name="max" value="150"/>
47      <property name="tokens" value="INSTANCE_INIT,STATIC_INIT,METHOD_DEF,CTOR_DEF"/>
48    </module>
49    <module name="LineLength">
50      <property name="max" value="145"/>
51      <property name="tabWidth" value="4"/>
52    </module>
53    <module name="MethodLength">
54      <property name="max" value="300"/>
55    </module>
56    <module name="ParameterNumber">
57      <property name="max" value="10"/>
58    </module>
59    <module name="OuterTypeNumber"/>
60    <module name="GenericWhitespace"/>
61    <module name="EmptyForInitializerPad"/>
62    <module name="EmptyForIteratorPad"/>
63    <module name="NoWhitespaceAfter"/>
64    <module name="NoWhitespaceBefore"/>
65    <module name="SingleSpaceSeparator"/>
66    <module name="MethodParamPad"/>
67    <module name="ParenPad"/>
68    <module name="TypecastParenPad">
69      <property name="tokens" value="RPAREN,TYPECAST"/>
70    </module>
71    <module name="WhitespaceAfter"/>
72    <module name="WhitespaceAround">
73      <property name="tokens" value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV_ASSIGN,DO_WHILE,EQUAL,GE,GT,LAND,LCURLY,LE,LITERAL_ASSERT,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE,LOR,LT,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR_ASSIGN,TYPE_EXTENSION_AND"/>
74      <property name="allowEmptyConstructors" value="true"/>
75      <property name="allowEmptyMethods" value="true"/>
76      <property name="allowEmptyTypes" value="true"/>
77    </module>
78    <module name="EmptyLineSeparator">
79      <property name="tokens" value="CLASS_DEF,ENUM_DEF,INTERFACE_DEF,CTOR_DEF,METHOD_DEF,STATIC_INIT"/>
80      <property name="allowNoEmptyLineBetweenFields" value="true"/>
81      <property name="allowMultipleEmptyLines" value="false"/>
82    </module>
83    <module name="ModifierOrder"/>
84    <module name="RedundantModifier"/>
85    <module name="AvoidNestedBlocks">
86      <property name="allowInSwitchCase" value="true"/>
87    </module>
88    <module name="EmptyBlock">
89      <property name="tokens" value="LITERAL_TRY,LITERAL_CATCH,LITERAL_FINALLY,LITERAL_DO,LITERAL_ELSE,LITERAL_FOR,INSTANCE_INIT,STATIC_INIT,LITERAL_SWITCH"/>
90    </module>
91    <module name="EmptyCatchBlock"/>
92    <module name="LeftCurly">
93      <property name="maxLineLength" value="140"/>
94    </module>
95    <module name="RightCurly"/>
96    <module name="NeedBraces">
97      <property name="tokens" value="LITERAL_DO,LITERAL_FOR,LITERAL_WHILE"/>
98      <property name="allowSingleLineStatement" value="true"/>
99    </module>
100    <module name="ArrayTypeStyle"/>
101    <module name="UpperEll"/>
102    <module name="OuterTypeFilename"/>
103    <module name="FinalClass"/>
104    <module name="HideUtilityClassConstructor"/>
105    <module name="org.openstreetmap.josm.TopLevelJavadocCheck"/>
106  </module>
107  <module name="Header">
108    <property name="header" value="// License: GPL. For details, see LICENSE file."/>
109    <property name="fileExtensions" value=".java"/>
110  </module>
111  <module name="FileLength">
112    <property name="fileExtensions" value=".java"/>
113  </module>
114  <module name="SuppressionCommentFilter">
115    <property name="offCommentFormat" value="CHECKSTYLE\.OFF\: ([\w\|]+)"/>
116    <property name="onCommentFormat" value="CHECKSTYLE\.ON\: ([\w\|]+)"/>
117    <property name="checkFormat" value="$1"/>
118  </module>
119  <module name="FileTabCharacter"/>
120  <module name="NewlineAtEndOfFile">
121    <property name="lineSeparator" value="lf"/>
122  </module>
123  <module name="SuppressionFilter">
124    <property name="file" value="${basedir}/tools/checkstyle/josm_filters.xml" default="tools/checkstyle/josm_filters.xml"/>
125    <property name="optional" value="true"/>
126  </module>
127</module>
Note: See TracBrowser for help on using the repository browser.