danger-php_codesniffer
Danger plugin for PHP_CodeSniffer.
Installation
$ gem install danger-php_codesniffer
Usage
Detect your PHP violations of a defined coding standard. The plugin will post a comment on PR/MR on your Github or Gitlab project.
Add this to your Dangerfile to run CodeSniffer:
php_codesniffer.exec
You can modify how the plugin behaves by adding one or more of the following options before the php_codesniffer.exec
call:
Ignore file/path:
php_codesniffer.ignore = "./vendor"
Use specific coding standard:
php_codesniffer.standard = "CodeIgniter"
Only check new and modified file:
php_codesniffer.filtering = true
Fail the pipeline if CodeSniffer reports any errors (you also have to run Danger with the --fail-on-errors
flag set to true):
php_codesniffer.fail_on_error = true
Development
- Clone this repo
- Run
bundle install
to setup dependencies. - Run
bundle exec rake spec
to run the tests. - Use
bundle exec guard
to automatically have tests run as you make changes. - Make your changes.