wondernetwork/wondersniffer

PHP Coding Standards for WonderNetwork

v2.0.0 2020-07-27 16:14 UTC

Requires

• squizlabs/php_codesniffer: ^3.2.3

Requires (Dev)

• phpunit/phpunit: ^5.5

GPL-2.0+

• codesniffer
• wondernetwork

README

WonderNetwork uses PHP_CodeSniffer to keep our code pretty. PSR-2 is the base of our standard, with a few extras thrown in. You can see what we've added and removed in the ruleset.xml, and check out our customizations in Sniffs.

(The astute may notice that the code in this repo doesn't conform to our own standard. We don't care.)

How to make your code look like our code

1. Add wondersniffer to your Composer packages:

$ composer require --dev wondernetwork/wondersniffer

1. Update composer:

$ composer update

1. Add the WonderNetwork standard to your ruleset.xml:

<?xml version="1.0"?>
<ruleset>
    <rule ref="vendor/wondernetwork/wondersniffer/WonderNetwork" />
</ruleset>

1. Run the sniffer against your codebase:

$ ./vendor/bin/phpcs --standard=ruleset.xml your-source-code

Credits

• MediaWiki for (unwittingly!) providing the scaffolding for a customized standard.
• CakePHP for providing the template MediaWiki used!