]> git.openstreetmap.org Git - nominatim.git/blob - phpcs.xml
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / phpcs.xml
1 <?xml version="1.0"?>
2 <ruleset name="Nominatim Standard">
3
4   <description>Nominatim coding standard</description>
5
6   <!-- based on another standard, you can find it here -->
7   <!-- /usr/share/php/PHP/CodeSniffer/Standards/PSR2/ruleset.xml -->
8   <!-- https://github.com/squizlabs/PHP_CodeSniffer/blob/master/CodeSniffer/Standards/PSR2/ruleset.xml -->
9   <rule ref="PSR2"/>
10
11   <exclude-pattern>./lib/template/*html*</exclude-pattern>
12   <exclude-pattern>./lib/template/includes/</exclude-pattern>
13   <exclude-pattern>./module/</exclude-pattern>
14   <exclude-pattern>./website/css</exclude-pattern>
15   <exclude-pattern>./website/js</exclude-pattern>
16
17   <rule ref="Generic.Files.LineLength">
18     <properties>
19      <property name="lineLimit" value="194"/>
20      <property name="absoluteLineLimit" value="194"/>
21     </properties>
22   </rule>
23
24
25   <!-- "A file should declare new symbols (classes, functions, constants, etc.) and cause no
26     other side effects, or it should execute logic with side effects, but should not do both."
27     ... we have too many script and includes to be able to enforce that.
28      -->
29   <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
30     <severity>0</severity>
31   </rule>
32
33
34
35   <!-- **************************************************************
36        DOCUMENTATION
37        ************************************************************** -->
38
39   <rule ref="PEAR.Commenting.FunctionComment.Missing">
40     <severity>0</severity>
41   </rule>
42
43
44
45
46   <!-- **************************************************************
47        COMMENTS
48        ************************************************************** -->
49
50   <!-- any comments in the lines before function() are better than forcing
51        a PHPdoc style right now -->
52   <rule ref="PEAR.Commenting.FunctionComment.WrongStyle">
53     <severity>0</severity>
54   </rule>
55
56   <!-- We allow comments after statements -->
57   <rule ref="Squiz.Commenting.PostStatementComment.Found">
58     <severity>0</severity>
59   </rule>
60   <!-- ... even without space e.g. //some words -->
61   <rule ref="Squiz.Commenting.InlineComment.NoSpaceBefore">
62     <severity>0</severity>
63   </rule>
64   <!-- blank lines after inline comments are fine -->
65   <rule ref="Squiz.Commenting.InlineComment.SpacingAfter">
66     <severity>0</severity>
67   </rule>
68
69   <!-- Comments don't have to start uppercase -->
70   <rule ref="Squiz.Commenting.InlineComment.NotCapital">
71     <severity>0</severity>
72   </rule>
73   <!-- Comments don't have to end with one of .!? -->
74   <rule ref="Squiz.Commenting.InlineComment.InvalidEndChar">
75     <severity>0</severity>
76   </rule>
77   <!-- Empty comments are fine -->
78   <rule ref="Squiz.Commenting.InlineComment.Empty">
79     <severity>0</severity>
80   </rule>
81
82
83
84
85   <!-- **************************************************************
86        INDENTATION, SPACING
87        ************************************************************** -->
88
89   <!-- Aligned looks nicer, but causes too many warnings currently -->
90   <rule ref="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned">
91     <severity>0</severity>
92   </rule>
93
94
95
96
97
98
99
100   <!-- **************************************************************
101        VARIABLES
102        ************************************************************** -->
103
104   <!-- CONST_this_var is fine, we don't need ConstThisVar -->
105   <rule ref="Generic.NamingConventions.UpperCaseConstantName.ConstantNotUpperCase">
106     <severity>0</severity>
107   </rule>
108
109   <!-- simply disagree with "Each line in an array declaration must end in a comma" -->
110   <rule ref="Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast">
111     <severity>0</severity>
112   </rule>
113   <rule ref="Squiz.Arrays.ArrayDeclaration.NoComma">
114     <severity>0</severity>
115   </rule>
116
117   <!-- We allow "$abc = array($aPoint[1], $aPoint[2])" -->
118   <rule ref="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed">
119     <severity>0</severity>
120   </rule>
121
122
123
124
125
126   <!-- **************************************************************
127        STRING QUOTING
128        ************************************************************** -->
129
130   <!-- Prefer single quoted strings -->
131   <rule ref="Squiz.Strings.DoubleQuoteUsage" />
132
133   <!-- We allow variabled inside double-quoted strings "abc $somevar" -->
134   <rule ref="Squiz.Strings.DoubleQuoteUsage.ContainsVar">
135     <severity>0</severity>
136   </rule>
137
138
139
140
141
142   <!-- **************************************************************
143        CONTROL STRUCTURES
144        ************************************************************** -->
145
146   <!-- we allow "if (a) echo 'b'" without brackets -->
147   <rule ref="Generic.ControlStructures.InlineControlStructure.NotAllowed">
148     <severity>0</severity>
149   </rule>
150
151   <!-- We allow "if (a)". No need for "if (a === TRUE)" -->
152   <rule ref="Squiz.Operators.ComparisonOperatorUsage.ImplicitTrue">
153     <severity>0</severity>
154   </rule>
155   <!-- ... same for "if (!a)" -->
156   <rule ref="Squiz.Operators.ComparisonOperatorUsage.NotAllowed">
157     <severity>0</severity>
158   </rule>
159
160
161
162 </ruleset>