bamboohr/phpcs

Coding standards for all things BambooHR

1.0.2 2019-05-14 16:01 UTC

Requires

• php: >=5.5.0
• bamboohr/variable-analysis: ~0.1.0
• squizlabs/php_codesniffer: ^3.0

Requires (Dev)

• phpunit/phpunit: <6.0

Apache-2.0

• codesniffer

README

BambooHR Code Sniffer

This code works with phpcs and checks code against the coding standards used in BambooHR products.

Installation

You should install this codesniffer with composer:

composer require --dev "bamboohr/phpcs"
vendor/bin/phpcs --config-set installed_paths /path/to/your/app/vendor/bamboohr/phpcs

The second command lets phpcs know where to find your new sniffs. Ensure that you do not overwrite any existing installed_paths value.

Usage

Depending on how you installed the code sniffer changes how you run it. If you have installed phpcs, and this package with PEAR, you can do the following:

vendor/bin/phpcs --standard=BambooHR /path/to/code

⚠️ Warning when these sniffs are installed with composer, ensure that you have configured the CodeSniffer installed_paths setting.

Releasing BambooHR Code Sniffer Rules

• Create a signed tag
• Write the changelog in the tag commit