phpcs.xml.dist 5.6 KB
Newer Older
Luís Cobucci's avatar
Luís Cobucci committed
1
<?xml version="1.0"?>
Sergei Morozov's avatar
Sergei Morozov committed
2 3 4 5
<ruleset
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
>
Luís Cobucci's avatar
Luís Cobucci committed
6 7 8 9
    <arg name="basepath" value="."/>
    <arg name="extensions" value="php"/>
    <arg name="parallel" value="80"/>
    <arg name="cache" value=".phpcs-cache"/>
10
    <arg name="colors"/>
Luís Cobucci's avatar
Luís Cobucci committed
11

12 13
    <!-- Ignore warnings, show progress of the run and show sniff names -->
    <arg value="nps"/>
Luís Cobucci's avatar
Luís Cobucci committed
14

15
    <file>bin</file>
16
    <file>src</file>
Luís Cobucci's avatar
Luís Cobucci committed
17 18
    <file>tests</file>

19 20
    <rule ref="Doctrine">
        <exclude name="SlevomatCodingStandard.TypeHints.DeclareStrictTypes"/>
21 22
        <exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming"/>
        <exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming"/>
23
        <exclude name="SlevomatCodingStandard.Classes.DisallowLateStaticBindingForConstants.DisallowedLateStaticBindingForConstant"/>
Sergei Morozov's avatar
Sergei Morozov committed
24
        <exclude name="SlevomatCodingStandard.ControlStructures.ControlStructureSpacing.IncorrectLinesCountAfterLastControlStructure"/>
25
        <exclude name="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceEqualOperator"/>
Sergei Morozov's avatar
Sergei Morozov committed
26

27
        <exclude name="PSR2.Methods.MethodDeclaration.Underscore"/>
Sergei Morozov's avatar
Sergei Morozov committed
28 29 30 31 32
        <!-- https://github.com/slevomat/coding-standard/issues/867 -->
        <exclude name="SlevomatCodingStandard.ControlStructures.JumpStatementsSpacing.IncorrectLinesCountAfterLastControlStructure"/>
        <!-- See https://github.com/squizlabs/PHP_CodeSniffer/issues/2937 -->
        <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNoNewline"/>
        <exclude name="Squiz.NamingConventions.ValidVariableName.PublicHasUnderscore"/>
33
    </rule>
Luís Cobucci's avatar
Luís Cobucci committed
34

Sergei Morozov's avatar
Sergei Morozov committed
35 36 37 38 39
    <!-- Disable the rules that will require PHP 7.4 -->
    <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint">
        <properties>
            <property name="enableNativeTypeHint" value="false"/>
        </properties>
40
    </rule>
Luís Cobucci's avatar
Luís Cobucci committed
41

Sergei Morozov's avatar
Sergei Morozov committed
42
    <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint">
43
        <exclude-pattern>*/src/*</exclude-pattern>
Sergei Morozov's avatar
Sergei Morozov committed
44 45 46
    </rule>

    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint">
47
        <exclude-pattern>*/src/*</exclude-pattern>
48 49
    </rule>

Luís Cobucci's avatar
Luís Cobucci committed
50 51 52 53
    <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

54 55 56 57
    <rule ref="Squiz.Classes.ClassFileName.NoMatch">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

Luís Cobucci's avatar
Luís Cobucci committed
58
    <rule ref="Generic.NamingConventions.UpperCaseConstantName.ClassConstantNotUpperCase">
59
        <exclude-pattern>src/Events.php</exclude-pattern>
Luís Cobucci's avatar
Luís Cobucci committed
60
    </rule>
61 62

    <rule ref="SlevomatCodingStandard.Classes.UnusedPrivateElements.UnusedProperty">
63
        <exclude-pattern>tests/Tools/TestAsset/*</exclude-pattern>
64
    </rule>
65

66 67
    <!-- see https://github.com/squizlabs/PHP_CodeSniffer/issues/2099 -->
    <rule ref="Squiz.Commenting.FunctionComment.InvalidNoReturn">
68 69
        <exclude-pattern>src/Platforms/AbstractPlatform.php</exclude-pattern>
        <exclude-pattern>src/Schema/AbstractSchemaManager.php</exclude-pattern>
70
        <exclude-pattern>tests/Platforms/AbstractPlatformTestCase.php</exclude-pattern>
71 72
    </rule>

Sergei Morozov's avatar
Sergei Morozov committed
73 74
    <!-- see https://github.com/squizlabs/PHP_CodeSniffer/issues/2838 -->
    <rule ref="Squiz.Commenting.FunctionComment.SpacingAfter">
75
        <exclude-pattern>src/Driver/AbstractMySQLDriver.php</exclude-pattern>
Sergei Morozov's avatar
Sergei Morozov committed
76 77 78 79
    </rule>

    <rule ref="Squiz.NamingConventions.ValidVariableName.MemberNotCamelCaps">
        <!-- This test contains a fixture class that should use snake case  -->
80
        <exclude-pattern>tests/Functional/DataAccessTest.php</exclude-pattern>
Sergei Morozov's avatar
Sergei Morozov committed
81 82 83 84 85
    </rule>

    <!-- https://github.com/squizlabs/PHP_CodeSniffer/issues/2837 -->
    <rule ref="Squiz.NamingConventions.ValidVariableName.NotCamelCaps">
        <!--
86 87
            These files use the underlying driver APIs that don't comply with the coding standard
            phpcs wrongly complains about them, and that has been reported here:
Sergei Morozov's avatar
Sergei Morozov committed
88 89
            https://github.com/squizlabs/PHP_CodeSniffer/issues/2950
        -->
90
        <exclude-pattern>src/Driver/IBMDB2/Connection.php</exclude-pattern>
91
        <exclude-pattern>src/Driver/Mysqli/Exception/ConnectionFailed.php</exclude-pattern>
Sergei Morozov's avatar
Sergei Morozov committed
92
        <!-- See https://github.com/squizlabs/PHP_CodeSniffer/issues/2837 -->
93 94 95 96
        <exclude-pattern>src/SQLParserUtils.php</exclude-pattern>
        <exclude-pattern>src/Tools/Dumper.php</exclude-pattern>
        <exclude-pattern>tests/Driver/StatementIteratorTest.php</exclude-pattern>
        <exclude-pattern>tests/Tools/DumperTest.php</exclude-pattern>
Sergei Morozov's avatar
Sergei Morozov committed
97 98
    </rule>

99 100
    <!-- some statement classes close cursor using an empty while-loop -->
    <rule ref="Generic.CodeAnalysis.EmptyStatement.DetectedWhile">
101
        <exclude-pattern>src/Driver/SQLSrv/Result.php</exclude-pattern>
102 103
    </rule>

104
    <!-- See https://github.com/slevomat/coding-standard/issues/770 -->
105
    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
106
        <exclude-pattern>src/Driver/ExceptionConverterDriver.php</exclude-pattern>
107
    </rule>
108

109
    <!-- see https://github.com/doctrine/dbal/issues/3377 -->
110
    <rule ref="SlevomatCodingStandard.Operators.DisallowEqualOperators.DisallowedNotEqualOperator">
111
        <exclude-pattern>src/Schema/Comparator.php</exclude-pattern>
112
    </rule>
113

114 115
    <!-- The SQLSRV_* functions are defined in the upper case by the sqlsrv extension and violate the standard
         see https://docs.microsoft.com/en-us/sql/connect/php/constants-microsoft-drivers-for-php-for-sql-server -->
116
    <rule ref="Squiz.PHP.LowercasePHPFunctions">
117
        <exclude-pattern>src/Driver/SQLSrv/Statement.php</exclude-pattern>
118
    </rule>
Luís Cobucci's avatar
Luís Cobucci committed
119
</ruleset>