bigbite/phpcs-config

Big Bite's PHP Coding Standards.

v2.0.1 2024-02-19 17:56 UTC

Requires

• php: >=7.2
• automattic/vipwpcs: ^3.0
• dealerdirect/phpcodesniffer-composer-installer: ^1.0.0
• phpcsstandards/phpcsextra: ^1.1
• phpcsstandards/phpcsutils: ^1.0.8
• squizlabs/php_codesniffer: ^3.9
• wp-coding-standards/wpcs: ^3.0

Requires (Dev)

• php-parallel-lint/php-parallel-lint: ^1.3.2
• phpcompatibility/php-compatibility: ^9.3.5
• phpcsstandards/phpcsdevtools: ^1.1.0
• phpstan/phpstan: ^1.5
• phpunit/phpunit: ^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0

MIT

• Paul Taylor
• Jon McPartland

• static analysis
• standards
• phpcs

README

This package contains the PHPCS configuration Big Bite use for all projects. It is primarily based upon WPCS and VIP WPCS, but is more strict, and contains additional Sniffs not included by those standards.

Installation

Run the following command in terminal:

composer require --dev bigbite/phpcs-config

Then run:

$ composer update

Create a .phpcs.xml.dist file in your project and add the following, replacing {PROJECT} with your project name:

<?xml version="1.0"?>
<ruleset name="{PROJECT} Rules">
	<rule ref="./vendor/bigbite/phpcs-config/BigBite" />
</ruleset>

Alternatively, you can install the standard globally:

composer global require --dev bigbite/phpcs-config

And reference the standard directly within your .phpcs.xml.dist:

<?xml version="1.0"?>
<ruleset name="{PROJECT} Rules">
	<rule ref="BigBite" />
</ruleset>

Developing

Please note that the PHPUnit test suite is not yet compatible with PHP 8.*.

Clone this repository, and then run composer install && composer install-cs.
Please run the following command prior to creating a PR, and ensure that there are no errors:

• composer run all-checks

If you're feeling especially nice, you can run this command instead:

• composer run all-checks-strict