gitlab-com-adeattwood-yii2-addon/ruleset.xml

<?xml version="1.0"?>
<ruleset name="Yii_Addon">
    <description>Yii addon coding standards</description>

    <file>./src</file>
    <file>./tests</file>

    <exclude-pattern>*/_output/*</exclude-pattern>
    <exclude-pattern>*/_data/*</exclude-pattern>
    <exclude-pattern>**.*.css</exclude-pattern>
    <exclude-pattern>**.*.js</exclude-pattern>
    
    <arg name="colors"/>

    <rule ref="PSR1"/>
    
    <rule ref="PSR2">
        <exclude name="PSR2.Classes.ClassDeclaration.CloseBraceAfterBody"/>
    </rule>

    <rule ref="Squiz.Classes.ValidClassName.NotCamelCaps">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter.Found">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="PSR1.Classes.ClassDeclaration.MissingNamespace">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="PEAR.Commenting.FunctionComment.MissingParamTag">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>
    
    <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="PEAR.Commenting.FunctionComment.Missing">
        <exclude-pattern>*/tests/*</exclude-pattern>
    </rule>

    <rule ref="Generic.Commenting.Todo.CommentFound">
        <type>warning</type>
    </rule>
    
    <rule ref="Generic.Formatting.MultipleStatementAlignment"/>

    <rule ref="Generic.CodeAnalysis"/>

    <rule ref="Zend.Debug.CodeAnalyzer"/>

    <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
    
    <rule ref="Squiz.Arrays.ArrayDeclaration">
        <exclude name="Squiz.Arrays.ArrayDeclaration.NoKeySpecified"/>
        <exclude name="Squiz.Arrays.ArrayDeclaration.KeySpecified"/>
        <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNotAligned"/>
        <exclude name="Squiz.Arrays.ArrayDeclaration.KeyNotAligned"/>
        <exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned"/>
        <exclude name="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed"/>
        <exclude name="Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast"/>
    </rule>
    
    <rule ref="Generic.PHP">
        <exclude name="Generic.PHP.ClosingPHPTag.NotFound"/>
        <exclude name="Generic.PHP.UpperCaseConstant.Found"/>
    </rule>

    <rule ref="Squiz.PHP">
        <exclude name="Squiz.PHP.DisallowComparisonAssignment.AssignedComparison"/>
        <exclude name="Squiz.PHP.Heredoc.NotAllowed"/>
        <exclude name="Squiz.PHP.DisallowInlineIf"/>
        <exclude name="Squiz.PHP.DisallowMultipleAssignments.Found"/>
        <exclude name="Squiz.PHP.DisallowBooleanStatement.Found"/>
    </rule>
    
    <rule ref="Squiz.Strings">
        <exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
    </rule>
    
    <rule ref="Generic.Strings"/>

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

    <rule ref="PEAR.Commenting">
        <exclude name="PEAR.Commenting.FileComment"/>
        <exclude name="PEAR.Commenting.ClassComment.InvalidPackage"/>
    </rule>

    <rule ref="PEAR.Commenting.FileComment.MissingCategoryTag">
        <type>warning</type>
    </rule>

    <rule ref="PEAR.Commenting.FileComment.InvalidPackage">
        <type>warning</type>
    </rule>
    
    <rule ref="PEAR.Commenting.FileComment.MissingPackageTag">
        <type>warning</type>
    </rule>
    
    <rule ref="PEAR.Commenting.FileComment.MissingLicenseTag">
        <type>warning</type>
    </rule>
    
    <rule ref="PEAR.Commenting.FileComment.MissingLinkTag">
        <type>warning</type>
    </rule>

    <rule ref="PEAR.Commenting.ClassComment.MissingCategoryTag">
        <type>warning</type>
    </rule>

    <rule ref="PEAR.Commenting.ClassComment.InvalidPackage">
        <type>warning</type>
    </rule>
    
    <rule ref="PEAR.Commenting.ClassComment.MissingPackageTag">
        <type>warning</type>
    </rule>
    
    <rule ref="PEAR.Commenting.ClassComment.MissingLicenseTag">
        <type>warning</type>
    </rule>
    
    <rule ref="PEAR.Commenting.ClassComment.MissingLinkTag">
        <type>warning</type>
    </rule>
    
    <rule ref="Squiz.Commenting.VariableComment"/>
    
        
    <rule ref="Squiz.ControlStructures">
        <exclude name="Squiz.ControlStructures"/>
    </rule>
    
    <rule ref="Squiz.Functions">
        <exclude name="Squiz.Functions"/>
    </rule>
     
    <rule ref="Generic.Files.LineLength">
        <properties>
            <property name="lineLimit" value="120"/>
            <property name="absoluteLineLimit" value="0"/>
        </properties>
    </rule>

    <rule ref="Squiz.WhiteSpace.FunctionSpacing">
        <properties>
            <property name="spacing" value="1"/>
        </properties>
    </rule>

    <rule ref="Generic.Files.LineEndings">
        <properties>
            <property name="eolChar" value="\n"/>
        </properties>
    </rule>

    <rule ref="Generic.Formatting.MultipleStatementAlignment">
        <properties>
            <property name="maxPadding" value="20"/>
            <property name="error" value="true"/>
        </properties>
    </rule>
    
</ruleset>