How to use PHPCS and PHPCBF with a single WordPress file

PHPCS and PHPCBF are two well-know PHP scripts used in the PHP development to (PHPCS) detect violations of a defined coding standard, and (PHPCBF) to automatically correct coding standard violations. 

I usually use both with composer in my WordPress projects, adding them as dependency in the composer.json file.

But sometimes I need to check some individual PHP file without adding PHPCS and PHPCBF as dependency. In this post, I am going to explain how I do this.

Documenting GlotPress with phpDocumentor

The current GlotPress API documentation (October 2021) was generated by ApiGen. Last commit was made on April 4th, 2016.

The last ApiGen commit was made on 23 Apr 2018, so I think this tool is deprecated. Furthermore, I was not able to use it with PHP 7.4 and GlotPress, so I look for another tool. The most PHP used tool is phpDocumentor. In this post I explain how to use it with GlotPress.

Install phpDocumentor globally on the machine, using the .phar tool.

cd ~/code/utils
mkdir phpDocumentor
cd phpDocumentor

Get the last .phar URL.

wget https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.1.2/phpDocumentor.phar

To run phpDocumentor, execute:

php phpDocumentor.phar run \ 
-d ~/code/wordpress/glotpress-env/glotpress.git \ 
-t ~/code/wordpress/glotpress-env/gp-docs \
--ignore "vendor/"

Where:

  • ~/code/wordpress/glotpress-env/glotpress.git is the GlotPress folder.
  • ~/code/wordpress/glotpress-env/gp-docs is the documentation folder.
  • vendor/ is the folder where Composer stores all the information. It is located in the root folder of the project.