bamboohr/phpcs

Coding standards for all things BambooHR

This package's canonical repository appears to be gone and the package has been frozen as a result.

Maintainers

Details

github.com/BambooHR/phpcs

Source

Issues

Installs: 52 906

Dependents: 5

Suggesters: 0

Security: 0

Stars: 1

Watchers: 36

Forks: 0

Open Issues: 0

Type:phpcodesniffer-standard

1.0.2 2019-05-14 16:01 UTC

Requires

Requires (Dev)

Apache-2.0 01b060907a6cca395af4e3007f0c79cfed47875f

codesniffer

This package is not auto-updated.

Last update: 2019-09-14 16:56:26 UTC

README

Latest Stable Version

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