brainbits/phpcs-standard

Brainbits Coding Style

7.0.1 2024-02-23 09:43 UTC

Requires

• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• doctrine/coding-standard: ^12.0
• slevomat/coding-standard: ^8.14
• squizlabs/php_codesniffer: ^3.9

Requires (Dev)

• phpunit/phpunit: ^10.5

MIT

• Stephan Wentz

• code
• style
• standard
• sniffer
• coding
• cs
• brainbits

README

Global

1. Clone repository
2. Install dependencies

   composer install

3. Configure standard:

   {install-dir}/vendor/bin/phpcs --config-set default_standard BrainbitsCodingStandard
   

4. Execute:

   {install-dir}/vendor/bin/phpcs {src-dir}

In Project

1. Add the standard to your project:

   composer require brainbits/phpcs-standard

2. Configure standard:

   vendor/bin/phpcs --config-set default_standard BrainbitsCodingStandard

3. Execute:

   vendor/bin/phpcs {src-dir}

In Project with Ruleset Customization

1. Add the standard to your project:

   composer require brainbits/phpcs-standard

2. Create phpcs.xml (See https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage)
   1. Include brainbits ruleset:

      <rule ref="BrainbitsCodingStandard" />

   2. Add default src-dir:

      <file>{src-dir}</file>

   3. Tweak to your needs, for example add rules or disable rules included in the brainbits standard.
3. Execute:

   vendor/bin/phpcs

Docker

1. docker run -it --rm -v $PWD:/app brainbits/phpcs-standard {src-dir}

Used Code Styles

• Slevomat https://github.com/slevomat/coding-standard
• Doctrine https://github.com/doctrine/coding-standard