mirror of
https://github.com/osm-search/Nominatim.git
synced 2024-12-25 22:12:45 +03:00
153 lines
4.5 KiB
XML
153 lines
4.5 KiB
XML
<?xml version="1.0"?>
|
|
<ruleset name="Nominatim Standard">
|
|
|
|
<description>Nominatim coding standard</description>
|
|
|
|
<!-- based on another standard, you can find it here -->
|
|
<!-- /usr/share/php/PHP/CodeSniffer/Standards/PSR2/ruleset.xml -->
|
|
<!-- https://github.com/squizlabs/PHP_CodeSniffer/blob/master/CodeSniffer/Standards/PSR2/ruleset.xml -->
|
|
<rule ref="PSR2"/>
|
|
|
|
<rule ref="Generic.Files.LineLength">
|
|
<properties>
|
|
<property name="lineLimit" value="194"/>
|
|
<property name="absoluteLineLimit" value="194"/>
|
|
</properties>
|
|
</rule>
|
|
|
|
|
|
<!-- "A file should declare new symbols (classes, functions, constants, etc.) and cause no
|
|
other side effects, or it should execute logic with side effects, but should not do both."
|
|
... we have too many script and includes to be able to enforce that.
|
|
-->
|
|
<rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
|
|
|
|
<!-- **************************************************************
|
|
DOCUMENTATION
|
|
************************************************************** -->
|
|
|
|
<rule ref="PEAR.Commenting.FunctionComment.Missing">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
|
|
|
|
|
|
<!-- **************************************************************
|
|
COMMENTS
|
|
************************************************************** -->
|
|
|
|
<!-- any comments in the lines before function() are better than forcing
|
|
a PHPdoc style right now -->
|
|
<rule ref="PEAR.Commenting.FunctionComment.WrongStyle">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
<!-- We allow comments after statements -->
|
|
<rule ref="Squiz.Commenting.PostStatementComment.Found">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<!-- ... even without space e.g. //some words -->
|
|
<rule ref="Squiz.Commenting.InlineComment.NoSpaceBefore">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<!-- blank lines after inline comments are fine -->
|
|
<rule ref="Squiz.Commenting.InlineComment.SpacingAfter">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
<!-- Comments don't have to start uppercase -->
|
|
<rule ref="Squiz.Commenting.InlineComment.NotCapital">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<!-- Comments don't have to end with one of .!? -->
|
|
<rule ref="Squiz.Commenting.InlineComment.InvalidEndChar">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<!-- Empty comments are fine -->
|
|
<rule ref="Squiz.Commenting.InlineComment.Empty">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
|
|
|
|
|
|
<!-- **************************************************************
|
|
INDENTATION, SPACING
|
|
************************************************************** -->
|
|
|
|
<!-- We don't need 2 blank lines after function -->
|
|
<rule ref="Squiz.WhiteSpace.FunctionSpacing.After">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
<!-- Aligned looks nicer, but causes too many warnings currently -->
|
|
<rule ref="Generic.Formatting.MultipleStatementAlignment.NotSame">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Generic.Formatting.MultipleStatementAlignment.NotSameWarning">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
<!-- Aligned looks nicer, but causes too many warnings currently -->
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- **************************************************************
|
|
VARIABLES
|
|
************************************************************** -->
|
|
|
|
<!-- CONST_this_var is fine, we don't need ConstThisVar -->
|
|
<rule ref="Generic.NamingConventions.UpperCaseConstantName.ConstantNotUpperCase">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
<!-- simply disagree with "Each line in an array declaration must end in a comma" -->
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.NoComma">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
<!-- We allow "$abc = array($aPoint[1], $aPoint[2])" -->
|
|
<rule ref="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
|
|
|
|
|
|
<!-- **************************************************************
|
|
CONTROL STRUCTURES
|
|
************************************************************** -->
|
|
|
|
<!-- we allow "if (a) echo 'b'" without brackets -->
|
|
<rule ref="Generic.ControlStructures.InlineControlStructure.NotAllowed">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
<!-- We allow "if (a)". No need for "if (a === TRUE)" -->
|
|
<rule ref="Squiz.Operators.ComparisonOperatorUsage.ImplicitTrue">
|
|
<severity>0</severity>
|
|
</rule>
|
|
<!-- ... same for "if (!a)" -->
|
|
<rule ref="Squiz.Operators.ComparisonOperatorUsage.NotAllowed">
|
|
<severity>0</severity>
|
|
</rule>
|
|
|
|
|
|
|
|
</ruleset>
|