swivl/php-coding-standard

Swivl Coding Standard for PHP_CodeSniffer

Maintainers

Details

github.com/Swivl/php-coding-standard

Homepage

Source

Issues

Installs: 39 195

Dependents: 7

Suggesters: 0

Security: 0

Stars: 3

Watchers: 9

Forks: 3

Open Issues: 0

Type:phpcodesniffer-standard

v1.5.0 2024-04-19 17:22 UTC

Requires

Conflicts

MIT d3f810ab6983627dc65b5c18c438688e54c0202e

symfonyphpcsCoding StandardSwivl

This package is auto-updated.

Last update: 2024-10-19 18:15:58 UTC

README

This coding standard is much more strict version of PSR-12.

Installation

Install coding standard using composer:

composer require --dev swivl/php-coding-standard

Configuration

Create file phpcs.xml.dist in the root of your project with the content similar to:

<?xml version="1.0" encoding="UTF-8"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">

    <arg name="basepath" value="."/>
    <arg name="cache" value=".phpcs-cache"/>
    <arg name="colors"/>
    <arg value="p"/>
    <arg name="extensions" value="php"/>
    <arg name="tab-width" value="4"/>
    <arg name="report-width" value="120"/>

    <rule ref="vendor/swivl/php-coding-standard/Swivl/ruleset.xml"/>

    <rule ref="Generic.Files.LineLength.TooLong">
        <exclude-pattern>*/src/Migrations/*</exclude-pattern>
    </rule>

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

    <exclude-pattern>*/Resources/*</exclude-pattern>

</ruleset>

Configure your IDE to use phpcs.xml.dist as the default ruleset for PHP_CodeSniffer.

Checking code style in your project

Check the whole project:

bin/phpcs

Check a single file or directory:

bin/phpcs path/to/file/or/directory

Automatically fix errors:

bin/phpcbf

Advanced configuration

Swivl.Commenting.DoctrineEntity

This sniff provides the following options:

<rule ref="Swivl.Commenting.DoctrineEntity">
    <properties>
        <property name="concreteTypeToBaseTypeMap" type="array">
            <element key="FeedItemComment" value="CommentInterface"/>
        </property>
        <property name="useDynamicalCalculationForEnumColumnType" value="true"/>
    </properties>
</rule>
  • concreteTypeToBaseTypeMap - when column is mapped to concrete type FeedItemComment, but modification methods are type hinted with base class CommentInterface
  • useDynamicalCalculationForEnumColumnType - when enum is mapped to some PHP type. For example, type="auth_enum_type" is mapped to PHP AuthType.

Swivl.Commenting.FunctionComment

This sniff provides the option:

<rule ref="Swivl.Commenting.FunctionComment">
    <properties>
        <property name="requiredPhpdoc" value="always"/>
        <property name="minimumVisibility" value="private"/>
    </properties>
</rule>
  • requiredPhpdoc - configures when PHPDoc is required for a method. Possible values:
    • always - PHPDoc is required for all methods.
    • map - PHPDoc is required for a method if at least 1 type hint or return type is in the list which is defined in the sniff in FunctionCommentSniff::REQUIRED_PHPDOC_MAP. It is the default behavior.
    • never - PHPDoc isn't required for all methods.

Swivl.Functions.ConstructorPropertyPromotion

This sniff provides the following options:

<rule ref="Swivl.Functions.ConstructorPropertyPromotion">
    <properties>
        <property name="indent" value="4"/>
    </properties>
</rule>

Swivl.Commenting.UselessFunctionComment

This sniff provides the following options:

<rule ref="Swivl.Commenting.UselessFunctionComment">
    <properties>
        <property name="ignoreClasses" value="false"/>
        <property name="ignoreInterfaces" value="false"/>
        <property name="ignoreTraits" value="false"/>
        <property name="includeNames" type="array">
            <element value="__construct"/>
        </property>
        <property name="excludeNames" type="array">
            <element value="__serialize"/>
        </property>
        <property name="maxDescriptionLines" value="1"/>
    </properties>
</rule>

Swivl.Commenting.UselessClassComment

This sniff provides the following options:

<rule ref="Swivl.Commenting.UselessClassComment">
    <properties>
        <property name="maxDescriptionLines" value="1"/>
        <property name="uselessTags" type="array">
            <element value="@package"/>
        </property>
        <property name="uselessDescriptions" type="array">
            <element value="Doctrine migration"/>
        </property>
    </properties>
</rule>

Dependencies update

Some sniffs from Swivl Coding Standard override sniffs from libraries which are in dependencies list. The following sniffs should be synchronized with the original code during dependencies update: