artfocus/codestyle

ArtFocus Coding Standards for PHP CodeSniffer

Maintainers

Details

bitbucket.org/artfocus/codestyle

Installs: 10 707

Dependents: 3

Suggesters: 0

v3.0.1 2016-05-11 11:34 UTC

README

  • Based on Consistence, so read it carefully.
  • But it differs in some cases:
    • Arrays: Arrays without key are allowed also when the first key is specified (Nette\Database $criteria).
    • Comments: Inline comments are allowed (code conditions, code folding).
    • Comments: Type parameters are not checked (allow shortcuts like int, bool).
    • Constants: Uppercase constants including TRUE, FALSE, NULL (Nette Code Style).
    • Formatting: There is not space after type cast.
    • Formatting: Heredoc syntax is allowed (eg. in tests).
    • Functions: Opening brace of function with multiline arguments must be on the same line as closing parenthesis.
    • Strings: Double quotes are permitted when contains a variable.
    • Whitespace: There is no space after type cast.
    • and some other differences.

Example Usage

Install into your project the best via Composer:

$ composer require artfocus/codestyle

Run PHP CodeSniffer like this:

$ vendor/bin/phpcs --standard=/path/to/Artfocus/ruleset.xml -sp src tests

Versioning

This packages uses semver.org.