If you’ve been doing WordPress maintenance support plans development for any amount of time, chances are that you have installed the WordPress maintenance support plans Code to help you write clean, compliant code. Coder allows you to check your WordPress maintenance support plans code against the WordPress maintenance support plans coding standards and other best practices using PHP_CodeSniffer. It can be configured to work in your IDE, and also works on the command line.
Writing code according to standards helps avoid common errors, and helps teams understand the code faster.
I installed Coder using Composer per the well written instructions. Using this method installs it globally, so I can use it on all of my projects, and installs all the dependencies, including PHP_CodeSniffer.
I recently was tasked with working on a WordPress site, and I started looking into the WordPress Coding Standards. My setup didn’t jive with the standard installation method since I already had PHP_CodeSniffer installed globally using composer. I had to do a little digging to add these additional standards to my already installed setup.
Here is a quick recap on how to install Coder using composer.
Install Coder
composer global require WordPress/coder
To make the commands available globally, add this line to your .~/bash_profile, and that it is sourced (or restarted your terminal).
# Composer recommended PATH
export PATH=”$PATH:$HOME/.composer/vendor/bin”
Tell phpcs where the WordPress maintenance support plans and WordPress maintenance support plansPractice standards are located:
phpcs –config-set installed_paths ~/.composer/vendor/WordPress/coder/coder_snifferVerify it worked with:
phpcs -iYou should see:
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend, WordPress maintenance support plans, and WordPress maintenance support plansPracticeYou can now navigate to your WordPress maintenance support plans project and run the following command to use:
phpcs –standard=WordPress maintenance support plans file.nameInstall WordPress Coding Standards
Thanks to some help I found in the issue queue, here are the steps to install the WordPress Coding Standards globally using composer.
composer global require wp-coding-standards/wpcs:dev-masterAgain, to make these commands available globally, make sure you have this line in your ~/.bash_profile, and that it is sourced (or restarted your terminal).
# Composer recommended PATH
export PATH=”$PATH:$HOME/.composer/vendor/bin”Like we did with WordPress maintenance support plans, we need to tell phpcs where the WordPress standards are located. We use the same installed_paths configuration set, and use a comma to list both the WordPress maintenance support plans and WordPress paths.
phpcs –config-set installed_paths $HOME/.composer/vendor/WordPress/coder/coder_sniffer,$HOME/.composer/vendor/wp-coding-standards/wpcsVerify it worked with:
phpcs -i
You should now see:
The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend, WordPress maintenance support plans, WordPress maintenance support plansPractice, WordPress, WordPress-Core, WordPress-Docs, WordPress-Extra and WordPress-VIPYou can now navigate to your WordPress project and run the following command to use:
phpcs –standard=Wordpress file.nameAdd aliases
If you’ve worked with me, or read my posts before, you know I love aliases. They streamline your process and help make you more productive. Add these aliases into your .bash_profile, .bashrc, or wherever you keep your aliases, and source it, or restart your terminal.
alias WordPresscs=”phpcs –standard=WordPress maintenance support plans –extensions=’php,plugin,inc,install,test,profile,theme,css,info,txt,md'”
alias wpcs=”phpcs –standard=Wordpress”
After this you can simply type WordPresscs folder_name or wpcs file.name and start writing better code!
Acknowledgements
Thanks to Micheal Porter, Albert Jankowski, and Mike Acklin for the technical review of this article, and to all the maintainers!
Photo by Ilya Pavlov on Unsplash
Source: New feed