exbico/coding-standard

1.0.1 2024-04-23 14:00 UTC

Requires

• php: >=8.1
• mediawiki/mediawiki-codesniffer: ^43.0
• slevomat/coding-standard: ^8.0

MIT

• backend

• phpcs
• dev

README

Установка

composer require --dev exbico/coding-standard

После установки пакета необходимо подключить его в конфигурацию phpcs (обычно это файл phpcs.xml.dist):

<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">

    ...
    
    <rule ref="ExbicoCodingStandard"/>

    ...

</ruleset>

Разработка

Для создания собственной проверки необходимо добавить класс, удовлетворяющий следующим требованиям:

• Должен располагаться по пути ExbicoCodingStandard/Sniffs/НазваниеКатегории/
• Название класса должно иметь постфикс Sniff
• Должен реализовывать интерфейс PHP_CodeSniffer\Sniffs\Sniff

Пример: ExbicoCodingStandard/Sniffs/WhiteSpace/CustomExbicoSniff.php

Если указанные выше требования выполнены, то проверка будет автоматически включена в состав ExbicoCodingStandard

Подробная инструкция