chefsplate / sniffer-rules

Official ChefsPlate Sniffer Rules for the PHP Dev Team.

phpcs 2.0+ Laravel 4/5 Command

This is a Laravel 4/5 package that hooks up SquizLabs CodeSniffer 2 into Laravel-based apps. It can also be used manually, so read on.

Detect violations of a defined coding standard. It helps your code remain clean and consistent. Available options are: PSR2, PSR1, Zend, PEAR, Squiz, PHPCS and ChefsPlate.

Setup

Require this package in composer:

$ composer require chefsplate/sniffer-rules

Laravel 4/5

In your config/app.php add ChefsPlate\SnifferRules\ServiceProvider:class to $providers array:

'providers' => [
    ...

    ChefsPlate\SnifferRules\ServiceProvider::class,

    ...
],

Laravel 5: Publish the configuration file

$ php artisan vendor:publish

Laravel 4: Manually create config

Copy config to app/config/sniffer-rules.php

Edit configuration file config/sniffer-rules.php to tweak the sniffer behavior.

Manual

Install our Standard by configuring PHP_CodeSniffer to look for it.

$ php ./vendor/bin/phpcs --config-set installed_paths ./vendor/chefsplate/src/ChefsPlate/SnifferRules/Standard/

Usage

Laravel

$ php artisan sniff

To run the sniffer in a CI environment, the -n option should be set to remove interaction:

$ php artisan sniff -n

Manual

$ php ./vendor/bin/phpcs --standard=ChefsPlate path/to/code

It's encouraged to add a Makefile to your project that makes it trivial for other developers. Use Makefile in this directory and adjust as needed to fit your project requirements.

ChefsPlate Coding Standards

Coding standards

• PSR 2 Coding Style Guide
• PSR 1 Coding Standards
• PSR 0 Coding Standards

Addendum and Clarifications

• namespace should be on the same line as opening php tag. e.g.: <?php namespace ChefsPlate\Amazing
• Property names should be snake_case
• Test names should use underscores, not camelCase. e.g.: test_cats_love_catnip

License

MIT

sniffer-rules's Issues

Allow for compound operators

A few compound operators such as =& trip the rule that enforces spaces around equal signs. It should support all such compound assignment operators.

Add automatic fix for operator spacing sniff

It should be a matter of parsing and adding spaces before and after an operator token as it's found. Since it's really easy to slip off of the spacebar, an automatic fix could help with mass styling issues.

Allow passing --no-patch option

Some environments don't have access to a fully featured patch implementation e.g. Alpine Linux. We should allow users to pass the --no-patch option and then pass that along to the phpcbf process when we execute it so that fixes can be auto-applied even if their environment's patch implementation lacks the required behaviour and functionality.

Update operator prefix sniff to allow for negative numerals

Right now it parses a statement like -1 * $value as a code style issue even though it's a perfectly valid way of flipping an integer's sign.

Update operator spacing sniff to account for prefix increment operators

Right now it's flagging that spaces need to occur in a token ++$i when the correct syntax for pre-increment operators is for the plus signs to be concatenated together.

Add automatic fix for the namespace declaration sniff

It's a whitespace change, non-destructive; could do with an automated fix to help with mass style violations.

Forbid script-halting functions

I think we can safely assume leaving in dd() or die() anywhere in your application code should warrant at the very least a warning.

I'll add these in over the weekend.

References:

https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties#genericphpforbiddenfunctions

https://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties#squizphpdiscouragedfunctions