2017 © Pedro Peláez
 

library php_codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

image

wambacom/php_codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  • Tuesday, April 19, 2016
  • by wambacom
  • Repository
  • 2 Watchers
  • 0 Stars
  • 52 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 929 Forks
  • 0 Open issues
  • 41 Versions
  • 2 % Grown

The README.md

About

PHP_CodeSniffer is a set of two PHP scripts; the main phpcs script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second phpcbf script to automatically correct coding standard violations. PHP_CodeSniffer is an essential development tool that ensures your code remains clean and consistent., (*1)

Build Status Code consistency, (*2)

Join the chat at https://gitter.im/squizlabs/PHP_CodeSniffer, (*3)

Requirements

PHP_CodeSniffer requires PHP version 5.1.2 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the Configuration Options manual page for a list of these requirements., (*4)

The SVN pre-commit hook requires PHP version 5.2.4 or greater due to its use of the vertical whitespace character., (*5)

Installation

The easiest way to get started with PHP_CodeSniffer is to download the Phar files for each of the commands:, (*6)

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
php phpcs.phar -h

curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
php phpcbf.phar -h

If you use PEAR, you can install PHP_CodeSniffer using the PEAR installer. This will make the phpcs and phpcbf commands immediately available for use. To install PHP_CodeSniffer using the PEAR installer, first ensure you have installed PEAR and then run the following command:, (*7)

pear install PHP_CodeSniffer

If you prefer using Composer you can easily install PHP_CodeSniffer system-wide with the following command:, (*8)

composer global require "squizlabs/php_codesniffer=*"

Make sure you have ~/.composer/vendor/bin/ in your PATH., (*9)

Or alternatively, include a dependency for squizlabs/php_codesniffer in your composer.json file. For example:, (*10)

{
    "require-dev": {
        "squizlabs/php_codesniffer": "2.*"
    }
}

You will then be able to run PHP_CodeSniffer from the vendor bin directory:, (*11)

./vendor/bin/phpcs -h
./vendor/bin/phpcbf -h

You can also download the PHP_CodeSniffer source and run the phpcs and phpcbf commands directly from the Git checkout:, (*12)

git clone git://github.com/squizlabs/PHP_CodeSniffer.git
cd PHP_CodeSniffer
php scripts/phpcs -h
php scripts/phpcbf -h

Documentation

The documentation for PHP_CodeSniffer is available on the Github wiki., (*13)

Information about upcoming features and releases is available on the Squiz Labs blog., (*14)

Issues

Bug reports and feature requests can be submitted on the Github Issue Tracker or the PEAR bug tracker., (*15)

Contributing

See CONTRIBUTING.md for information., (*16)

The Versions

19/04 2016

dev-master

9999999-dev http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

The Development Requires

by Greg Sherwood

phpcs standards

19/04 2016

2.5.1.3

2.5.1.3 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

The Development Requires

by Greg Sherwood

phpcs standards

26/01 2016

2.5.1.2

2.5.1.2 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

The Development Requires

by Greg Sherwood

phpcs standards

26/01 2016

2.5.1.1

2.5.1.1 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

The Development Requires

by Greg Sherwood

phpcs standards

21/01 2016

3.0.x-dev

3.0.9999999.9999999-dev http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.4.0
  • ext-tokenizer *
  • ext-xmlwriter *

 

The Development Requires

by Greg Sherwood

phpcs standards

20/01 2016

2.5.1

2.5.1.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

The Development Requires

by Greg Sherwood

phpcs standards

11/12 2015

2.5.0

2.5.0.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

The Development Requires

by Greg Sherwood

phpcs standards

23/11 2015

2.4.0

2.4.0.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

by Greg Sherwood

phpcs standards

09/09 2015

2.3.4

2.3.4.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

by Greg Sherwood

phpcs standards

24/06 2015

2.3.3

2.3.3.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

by Greg Sherwood

phpcs standards

29/04 2015

2.3.2

2.3.2.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

by Greg Sherwood

phpcs standards

23/04 2015

2.3.1

2.3.1.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

by Greg Sherwood

phpcs standards

04/03 2015

2.3.0

2.3.0.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *
  • ext-xmlwriter *

 

by Greg Sherwood

phpcs standards

21/01 2015

2.2.0

2.2.0.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

18/12 2014

2.1.0

2.1.0.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

05/12 2014

2.0.0

2.0.0.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

04/12 2014

1.5.x-dev

1.5.9999999.9999999-dev http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

04/12 2014

1.5.6

1.5.6.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

06/11 2014

2.0.0RC4

2.0.0.0-RC4 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

16/10 2014

2.0.0RC3

2.0.0.0-RC3 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

26/09 2014

2.0.0RC2

2.0.0.0-RC2 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

25/09 2014

1.5.5

1.5.5.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

06/08 2014

2.0.0RC1

2.0.0.0-RC1 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

06/08 2014

1.5.4

1.5.4.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

01/05 2014

2.0.0a2

2.0.0.0-alpha2 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

01/05 2014

1.5.3

1.5.3.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

05/02 2014

2.0.0a1

2.0.0.0-alpha1 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

05/02 2014

1.5.2

1.5.2.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

12/12 2013

1.5.1

1.5.1.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

27/11 2013

1.5.0

1.5.0.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

25/11 2013

1.4.8

1.4.8.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

26/09 2013

1.5.0RC4

1.5.0.0-RC4 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

26/09 2013

1.4.7

1.4.7.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

25/07 2013

1.5.0RC3

1.5.0.0-RC3 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

25/07 2013

1.4.6

1.4.6.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2
  • ext-tokenizer *

 

by Greg Sherwood

phpcs standards

04/04 2013

1.5.0RC2

1.5.0.0-RC2 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2

 

by Greg Sherwood

phpcs standards

04/04 2013

1.4.5

1.4.5.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2

 

by Greg Sherwood

phpcs standards

08/02 2013

1.5.0RC1

1.5.0.0-RC1 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2

 

by Greg Sherwood

phpcs standards

07/02 2013

1.4.4

1.4.4.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2

 

by Greg Sherwood

phpcs standards

04/12 2012

1.4.3

1.4.3.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2

 

by Greg Sherwood

phpcs standards

09/11 2012

1.4.2

1.4.2.0 http://www.squizlabs.com/php-codesniffer

PHP_CodeSniffer tokenises PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.

  Sources   Download

BSD-3-Clause

The Requires

  • php >=5.1.2

 

by Greg Sherwood

phpcs standards