bytic/phpqaconfig

Meta package for configuration files for PHP QA tools

1.0.13 2024-04-02 19:35 UTC

Requires

• php: ^7.4 || ^8
• dealerdirect/phpcodesniffer-composer-installer: ^0.7.0||^1.0.0
• phpcsstandards/phpcsextra: ^1.0
• phpcsstandards/phpcsutils: ^1.0
• slevomat/coding-standard: ^7.0||^8.0
• squizlabs/php_codesniffer: ^3.5

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.8 || ^3.0

MIT

• Solomon Gabriel

• php
• unittest
• quality
• qa
• code quality
• stylecheck

README

PHP Code Sniffer

Configuration file: bytic.phpcs.xml

Usage

1. Link bytic/qaconfig repo as composer dependency

   $ composer require bytic/qaconfig:^1.0

2. Extend provided configuration to adapt it to your project.

    <?xml version="1.0" encoding="UTF-8"?>
    <ruleset name="DEMO-PHP project code style checker config">
        <rule ref="./vendor/bytic/qaconfig/bytic.phpcs.xml">
            <exclude name="PSR2.Classes.PropertyDeclaration.Underscore"/>
        </rule>
        <rule ref="PSR1.Classes.ClassDeclaration">
            <exclude-pattern>*/_stubs.php</exclude-pattern>
        </rule>
        <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement.Found">
            <exclude-pattern>*/_stubs.php</exclude-pattern>
        </rule>
    </ruleset>

Inspiration

• https://github.com/jmolivas/phpqa
• https://github.com/Dealerdirect/php-qa-tools
• https://github.com/lovullo/phpqatools
• https://github.com/ramsey/coding-standard
• https://github.com/endroid/quality