dolibarr/dev/setup/codesniffer/ruleset.xml

<?xml version="1.0"?>
<!DOCTYPE ruleset SYSTEM "ruleset.dtd">
<ruleset name="Dolibarr">
	<description>Dolibarr coding standard.</description>
	<arg name="tab-width" value="4"/>

	<exclude-pattern type="relative">build/html</exclude-pattern>
	<exclude-pattern type="relative">build/aps</exclude-pattern>
	<exclude-pattern type="relative">dev/namespacemig</exclude-pattern>
	<exclude-pattern type="relative">dev/initdata/dbf/includes</exclude-pattern>
	<exclude-pattern type="relative">documents</exclude-pattern>
	<exclude-pattern type="relative">htdocs/core/class/lessc.class.php</exclude-pattern>
	<exclude-pattern type="relative">htdocs/custom</exclude-pattern>
	<exclude-pattern type="relative">htdocs/includes</exclude-pattern>
	<exclude-pattern type="relative">htdocs/install/doctemplates/websites</exclude-pattern>
	<exclude-pattern type="relative">htdocs/conf.php</exclude-pattern>
	<exclude-pattern type="relative">*/nltechno*</exclude-pattern>
	<exclude-pattern type="relative">*/htdocs/includes</exclude-pattern>
	<exclude-pattern type="relative">*/htdocs/includes</exclude-pattern>

	<!-- List of all tests -->


	<!-- Rules from Internal Standard -->

	<rule ref="Internal.NoCodeFound">
		<severity>0</severity>
	</rule>


	<!-- Rules from Generic Standard -->

	<rule ref="Generic.CodeAnalysis.EmptyStatement">
        <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedIf"/>
        <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedElse"/>
        <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedElseif"/>
        <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCatch"/>
        <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedForeach"/>
    </rule>

    <!-- <rule ref="Generic.CodeAnalysis.ForLoopShouldBeWhileLoop" /> -->

    <rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall" />

    <rule ref="Generic.CodeAnalysis.JumbledIncrementer" />

    <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement" />

    <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier" />

    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter" />
    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter.Found">
		<severity>0</severity>
    </rule>
    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter.FoundBeforeLastUsed">
		<severity>0</severity>
    </rule>
    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed">
		<severity>0</severity>
    </rule>
    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClass">
		<severity>0</severity>
    </rule>
    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassAfterLastUsed">
		<severity>0</severity>
    </rule>
    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter.FoundInExtendedClassBeforeLastUsed">
		<severity>0</severity>
    </rule>


    <!--
    <rule ref="Generic.Commenting.Todo" />
    -->

	<!-- Warning if action on same line than if -->
	<!--
		<rule ref="Generic.ControlStructures.InlineControlStructure">
		<properties>
			<property name="error" value="false"/>
		</properties>
		</rule>
	-->


    <!-- PHP code MUST use only UTF-8 without BOM. -->
    <rule ref="Generic.Files.ByteOrderMark"/>

	<!-- Lines can be 85 chars long, but never show errors -->
	<rule ref="Generic.Files.LineLength">
		<properties>
			<property name="lineLimit" value="500" />
			<property name="absoluteLineLimit" value="0" />
		</properties>
	</rule>

	<!-- Use Unix newlines -->
	<rule ref="Generic.Files.LineEndings">
		<properties>
			<property name="eolChar" value="\n" />
		</properties>
	</rule>

    <!-- Disallow several statements on same line -->
	<!--  We want to allow 'if () { ...small code... }' on same line for better code compacity and readability -->
	<rule ref="Generic.Formatting.DisallowMultipleStatements">
		<severity>0</severity>
	</rule>

	<!-- Have 2 chars padding maximum and always show as errors -->
	<!--
		<rule ref="Generic.Formatting.MultipleStatementAlignment">
		<properties> <property name="maxPadding" value="2"/> <property
		name="ignoreMultiLine" value="true"/> </properties> </rule>
	-->

	<rule ref="Generic.Formatting.SpaceAfterCast" />

    <rule ref="Generic.Functions.CallTimePassByReference" />

	<rule ref="Generic.Functions.FunctionCallArgumentSpacing" />

    <!-- Disallow several spaces after comma -->
	<!-- We want to allow this because we want to be able to align params on several similare functions on different lines -->
	<rule ref="Generic.Functions.FunctionCallArgumentSpacing.TooMuchSpaceAfterComma">
		<severity>0</severity>
	</rule>

    <!-- Tweaks to metrics -->
    <rule ref="Generic.Metrics.CyclomaticComplexity">
        <properties>
            <property name="complexity" value="150" />
            <property name="absoluteComplexity" value="300" />
        </properties>
    </rule>
    <rule ref="Generic.Metrics.NestingLevel">
        <properties>
            <property name="nestingLevel" value="12" />
            <property name="absoluteNestingLevel" value="50" />
        </properties>
    </rule>

	<rule ref="Generic.NamingConventions.ConstructorName" />
	<!-- Check if we use PHP4 constructor instead of __construct() -->
	<rule ref="Generic.NamingConventions.ConstructorName.OldStyle" />

	<rule ref="Generic.NamingConventions.UpperCaseConstantName" />

    <rule ref="Generic.PHP.DeprecatedFunctions" />
    <rule ref="Generic.PHP.DeprecatedFunctions.Deprecated">
        <severity>0</severity>
    </rule>

	<rule ref="Generic.PHP.DisallowShortOpenTag" />

    <rule ref="Generic.PHP.ForbiddenFunctions" />

    <!-- Warning when using @ before functions -->
    <!-- We want this. Some features need this -->
    <rule ref="Generic.PHP.NoSilencedErrors">
        <severity>0</severity>
    </rule>

	<!-- Say if null, true, false must be uppercase (Rule 2.5 of PSR2 https://www.php-fig.org/psr/psr-2/) -->
	<rule ref="Generic.PHP.LowerCaseConstant" />

	<rule ref="Generic.Strings.UnnecessaryStringConcat" />

	<rule ref="Generic.Strings.UnnecessaryStringConcat.Found">
	</rule>

	<!-- Disallow usage of tab -->
	<!--  <rule ref="Generic.WhiteSpace.DisallowTabIndent" /> -->

	<!-- Check indent are done with spaces and with correct number -->
	<!-- Disabled as this does not support tab -->
	<!-- <rule ref="Generic.WhiteSpace.ScopeIndent" /> -->

	<rule ref="Generic.WhiteSpace.ScopeIndent">
	  <properties>
	    <property name="indent" value="4"/>
	    <property name="tabIndent" value="true"/>
	  </properties>
	</rule>


    <rule ref="Squiz.WhiteSpace.ScopeClosingBrace.Indent" />

    <!-- There MUST NOT be trailing whitespace at the end of non-blank lines. -->
    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
        <properties>
            <property name="ignoreBlankLines" value="false"/>
        </properties>
    </rule>
    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.StartFile">
        <severity>0</severity>
    </rule>
    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EndFile">
        <severity>0</severity>
    </rule>
    <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines">
        <severity>0</severity>
    </rule>

    <rule ref="Squiz.WhiteSpace.ControlStructureSpacing.SpacingAfterOpen" />
    <rule ref="Squiz.WhiteSpace.ControlStructureSpacing.SpacingBeforeClose" />

    <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.SpaceAfterOpen" />
    <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.SpaceBeforeClose" />

    <rule ref="Squiz.Functions.MultiLineFunctionDeclaration" />
	<rule ref="Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction">
        <severity>0</severity>
	</rule>
    <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
        <properties>
            <property name="equalsSpacing" value="1"/>
        </properties>
    </rule>
    <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing.SpacingAfterHint">
        <severity>0</severity>
    </rule>
    <rule ref="Squiz.Scope.MethodScope.Missing" />

    <!-- Rules from PEAR Standard -->

    <rule ref="PEAR.Classes.ClassDeclaration" />

    <!-- Check for duplicate class names -->
    <!-- <rule ref="Generic.Classes.DuplicateClassName" /> -->

    <rule ref="PEAR.Commenting.ClassComment" />

    <!-- TODO Remove this and fix reported errors -->
    <rule ref="PEAR.Commenting.ClassComment.Missing">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.ClassComment.MissingTag">
		<severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.ClassComment.MissingAuthorTag">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.ClassComment.MissingCategoryTag">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.ClassComment.MissingLicenseTag">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.ClassComment.MissingLinkTag">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.ClassComment.MissingPackageTag">
        <severity>0</severity>
    </rule>



    <!--
    <rule ref="PEAR.Commenting.FileComment" />
    <rule ref="PEAR.Commenting.FileComment.WrongStyle">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Commenting.FileComment.MissingVersion">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Commenting.FileComment.MissingTag">
        <severity>0</severity>
    </rule>
    -->

    <rule ref="PEAR.Commenting.FunctionComment" />

    <rule ref="PEAR.Commenting.FunctionComment.Empty">
        <severity>5</severity>
    </rule>

	<!--<rule ref="PEAR.Commenting.FunctionComment.MissingReturn">
        <severity>0</severity>
    </rule>-->
    <!--<rule ref="PEAR.Commenting.FunctionComment.Missing">
        <severity>0</severity>
    </rule>-->

    <rule ref="PEAR.Commenting.FunctionComment.SpacingAfterParamType" />

    <rule ref="PEAR.Commenting.FunctionComment.SpacingAfterParamName">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.FunctionComment.SpacingAfterParamType">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.FunctionComment.SpacingAfterParamName" />

    <rule ref="PEAR.Commenting.FunctionComment.ReturnNotRequired">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.FunctionComment.WrongStyle">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.FunctionComment.SpacingBeforeParamType">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Commenting.FunctionComment.SpacingAfterLongType">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Commenting.FunctionComment.SpacingAfterLongName">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Commenting.FunctionComment.SpacingAfterParams">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Commenting.FunctionComment.ParameterCommentsNotAligned">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Commenting.FunctionComment.ParameterNamesNotAligned">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.Commenting.InlineComment" />

	<!-- Check position of { after a control structure like if (), while (), etc... -->
	<!--
	<rule ref="PEAR.ControlStructures.ControlSignature" />
	-->

	<!-- <rule ref="PEAR.ControlStructures.MultiLineCondition" /> -->

	<!-- Test if () are removed for includes -->
	<rule ref="PEAR.Files.IncludingFile" />

    <!-- Disable some error messages that we do not want. -->

    <rule ref="PEAR.Files.IncludingFile.UseInclude">
        <severity>0</severity>
    </rule>
    <!-- TODO Enable this test. We should use require for include in prior of include when out of if -->
    <rule ref="PEAR.Files.IncludingFile.UseIncludeOnce">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Files.IncludingFile.UseRequire">
        <severity>0</severity>
    </rule>
    <!-- TODO Enable this test. We should use require for include in prior of include when out of if -->
    <rule ref="PEAR.Files.IncludingFile.UseRequireOnce">
        <severity>0</severity>
    </rule>

	<rule ref="PEAR.Formatting.MultiLineAssignment" />

	<rule ref="PEAR.Functions.FunctionCallSignature" />

    <!-- TODO Enable this test. -->
    <rule ref="PEAR.Functions.FunctionCallSignature.CloseBracketLine">
        <severity>0</severity>
    </rule>
    <!-- TODO Enable this test. -->
    <rule ref="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket">
        <severity>0</severity>
    </rule>

	<rule ref="PEAR.Functions.FunctionCallSignature.EmptyLine">
	    <severity>0</severity>
	</rule>
	<rule ref="PEAR.Functions.FunctionCallSignature.Indent">
	    <severity>0</severity>
	</rule>
    <rule ref="PEAR.Functions.FunctionCallSignature.SpaceBeforeOpenBracket">
        <severity>0</severity>
    </rule>
    <rule ref="PEAR.Functions.FunctionCallSignature.SpaceAfterCloseBracket">
        <severity>0</severity>
    </rule>

	<rule ref="PEAR.Functions.ValidDefaultValue" />

	<rule ref="PEAR.NamingConventions.ValidClassName" />
	<rule ref="PEAR.NamingConventions.ValidClassName.Invalid">
        <severity>0</severity>
	</rule>

	<rule ref="PEAR.NamingConventions.ValidClassName.StartWithCapital">
        <severity>0</severity>
	</rule>
	<!-- some phpcs have a typo error in rule, so we add it too -->
	<rule ref="PEAR.NamingConventions.ValidClassName.StartWithCaptial">
        <severity>0</severity>
	</rule>

	<rule ref="PEAR.NamingConventions.ValidFunctionName" />

	<rule ref="PEAR.NamingConventions.ValidFunctionName.FunctionDoubleUnderscore">
        <severity>0</severity>
	</rule>
	<rule ref="PEAR.NamingConventions.ValidFunctionName.FunctionNameInvalid">
        <severity>0</severity>
	</rule>
	<rule ref="PEAR.NamingConventions.ValidFunctionName.FunctionNoCapital">
        <severity>0</severity>
	</rule>
	<!-- some phpcs have a typo error in rule, so we add it too -->
	<rule ref="PEAR.NamingConventions.ValidFunctionName.FunctionNoCaptial">
        <severity>0</severity>
	</rule>

    <!--<rule ref="PEAR.NamingConventions.ValidFunctionName.NotCamelCaps">
        <severity>0</severity>
    </rule>-->
	<!--<rule ref="PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps">
        <severity>0</severity>
	</rule>-->
	<rule ref="PEAR.NamingConventions.ValidFunctionName.PrivateNoUnderscore">
        <severity>0</severity>
	</rule>
	<rule ref="PEAR.NamingConventions.ValidVariableName" />

    <rule ref="PSR2.Classes.ClassDeclaration" />
    <rule ref="PSR2.Methods.FunctionClosingBrace" />
    <rule ref="PSR2.ControlStructures.ElseIfDeclaration.NotAllowed" />

	<!-- This is not in PSR2 -->
	<rule ref="PEAR.NamingConventions.ValidVariableName.PrivateNoUnderscore">
        <severity>0</severity>
    </rule>

	<rule ref="PEAR.WhiteSpace.ObjectOperatorIndent" />

	<!-- Need to be commented to be disabled
	<rule ref="PEAR.WhiteSpace.ScopeClosingBrace">
        <severity>0</severity>
    </rule>

    <rule ref="PEAR.WhiteSpace.ScopeClosingBrace.Line">
        <severity>0</severity>
    </rule>
	-->

    <!-- Already found as a Generic rule -->
	<!-- <rule ref="PEAR.WhiteSpace.ScopeIndent" /> -->


	<!-- Rules from Zend Standard-->

    <!-- The closing ?> tag MUST be omitted from files containing only PHP. -->
    <rule ref="Zend.Files.ClosingTag"/>

    <rule ref="PSR2.Classes.ClassDeclaration" />
    <rule ref="PSR2.Methods.FunctionClosingBrace" />
    <rule ref="PSR2.Files.EndFileNewline.TooMany" />
	<rule ref="PSR2.Files.EndFileNewline.NoneFound" />
	<rule ref="PSR2.Methods.FunctionCallSignature.SpaceBeforeOpenBracket" />
	<rule ref="PSR2.Classes.PropertyDeclaration.VarUsed" />
</ruleset>