EN FR

Install PHP CodeSniffer with PEAR

This article should be useful for other tools than CodeSniffer. To put some context, I installed PEAR some time ago for PHPUnit, before I read that PHPUnit had moved away from PEAR and can now be installed using Composer or a simple PHAR (PHp ARchive) file. I had troubles with the default PEAR configuration and the various steps to add the right folders in the system $PATH, PHP configuration, ... and my stubbornness to have everything exactly where I want and behave exactly the way I want!

On my Arch Linux system, PEAR install its packages by default in /usr/bin. I prefer to put them in /usr/share/pear/bin to be more restrictive on what folders I include in my PHP configuration and avoid including the whole /usr/bin in the open_basedir directive. As a reminder, PEAR is installed on Arch Linux with

$ yaourt -S php-pear

and should be available on most distributions through their respective package manager.

First, if, like me, you make 20 mistakes before doing something right, this is the command for uninstalling a package:

$ sudo pear uninstall <packageName>

To change the PEAR executables directory globally:

$ sudo pear config-set bin_dir /usr/share/pear/bin/

Don't use sudo if you want to apply the changes locally. In this case, it should create, I think automatically, a hidden file named .pearrc in your home directory.

We can check PEAR configuration with

$ sudo pear config-show

Output of $ pear config-show

We can now install CodeSniffer:

$ sudo pear install PHP_CodeSniffer

and adapt our PATH to find its executable by adding the following in our ~/.bashrc:

PATH=/usr/share/pear/bin:$PATH

We reload our config and check if the CodeSniffer executable is found in the right place:

$ . ~/.bashrc
$ whereis phpcs

Output of $ whereis phpcs

I use the open_basedir directive to add a bit of security. Of course, I don't remember that kind of details but PHP reminds me:

Error thrown by phpcs with open_basedir restriction

We fix this by editing /etc/php/php.ini or wherever your PHP configuration file is by adding the PEAR folder:

open_basedir = /srv/http/:/tmp/:/usr/share/pear/

We can now start refactoring...

$ phpcs path/to/file.php|js|css

or

$ phpcs path/to/folder

Example of output from phpcs

The following command:

  • shows sniff codes, e.g.: (PSR2.Namespaces.UseDeclaration.SpaceAfterLastUse)
  • shows progress
  • specifies that the encoding of the files is utf-8
  • only uses the PSR-2 standard
  • specifies the number of spaces I use as tab
  • ignores the sub folders External and Tests/coverage
  • prints one level of verbosity
  • and processes the current folder.

$ phpcs -sp --encoding=utf-8 --standard=PSR2 --tab-width=4 --ignore={External/,Tests/coverage/} -v .

"Upgrade to Firefox" bannerSupport La Quadrature du Net!Soutenir FramasoftSupport the Gooseberry project, Blender Foundation's 5th Open Movie project