rabbit-stream/phpcs.xml.dist at main · Prisha38/rabbit-stream · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?xml version="1.0"?>
<ruleset name="RabbitStream">
    <description>RabbitStream coding standard based on PSR-12 with Slevomat additions</description>

    <!-- Scan src, tests, examples, and bin directories -->
    <file>src</file>
    <file>tests</file>
    <file>examples</file>
    <file>bin</file>

    <!-- Exclude vendor and cache -->
    <exclude-pattern>vendor/*</exclude-pattern>
    <exclude-pattern>*.cache</exclude-pattern>

    <!-- Use PSR-12 standard as base -->
    <rule ref="PSR12"/>

    <!-- Example scripts mirror the docs snippets: they define helper classes and run logic in one file -->
    <rule ref="PSR1.Files.SideEffects.FoundWithSymbols">
        <exclude-pattern>examples/*</exclude-pattern>
    </rule>
    <rule ref="PSR1.Classes.ClassDeclaration.MissingNamespace">
        <exclude-pattern>examples/*</exclude-pattern>
    </rule>

    <!-- Slevomat: Require strict_types=1 declaration -->
    <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
        <properties>
            <property name="spacesCountAroundEqualsSign" value="0"/>
        </properties>
    </rule>

    <!-- Slevomat: Alphabetically sorted use statements -->
    <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses"/>

    <!-- Slevomat: No unused imports -->
    <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
        <properties>
            <property name="searchAnnotations" value="true"/>
        </properties>
    </rule>

    <!-- Slevomat: Require trailing comma in multi-line arrays -->
    <rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>

    <!-- Slevomat: Require null coalesce operator when possible -->
    <rule ref="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceOperator"/>

    <!-- kb-lint is a CLI entrypoint that intentionally defines helpers and executes main. -->
    <rule ref="PSR1.Files.SideEffects">
        <exclude-pattern>bin/kb-lint.php</exclude-pattern>
    </rule>

    <!-- Show progress -->
    <arg value="p"/>

    <!-- Show sniff codes in report -->
    <arg value="s"/>

    <!-- Use colors in output -->
    <arg name="colors"/>
</ruleset>