Skip to content

djoos-cookbooks/phpcs

Repository files navigation

Build Status

phpcs cookbook

## Description

This cookbook provides an easy way to install phpcs, PHP Code Sniffer.

More information? https://github.com/squizlabs/PHP_CodeSniffer

## Requirements

Cookbooks:

  • php
  • composer
  • git

Platforms:

  • Ubuntu
  • Debian
  • RHEL
  • CentOS
  • Fedora
  • Scientific
  • Amazon

Attributes

default.rb:

  • node['phpcs']['install_method'] - Installation method, "pear" or "composer", defaults to "pear"
  • node['phpcs']['version'] - The phpcs version that will be installed, defaults to "latest"

composer.rb:

  • node['phpcs']['prefix'] - The composer.json bin-dir, defaults to "/usr/bin" (composer install method only)

coding_standard.rb:

  • node['phpcs']['coding_standards'] - Hash of optional additional coding standard(s), eg. "Symfony2" => { "repository" => "git://github.com/opensky/Symfony2-coding-standard.git", "reference" => "master" }

Usage

  1. include recipe[phpcs] in a run list
  2. change the attributes --- OR --- override the attribute on a higher level

## References

License and Authors

Author: David Joos [email protected] Copyright: 2016, David Joos

Author: David Joos [email protected] Author: Escape Studios Development [email protected] Copyright: 2013-2015, Escape Studios

Unless otherwise noted, all files are released under the MIT license, possible exceptions will contain licensing information in them.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.