lipemat/wp-phpcs

PHP Codesniffer for a WordPress plugin

WP PHPCS

, _(*1)

PHP Codesniffer setup for a WordPress plugin., _(*2)

Installation

Use composer to install. Although this may be added directly to your plugins composer.json, it is recommended to install somewhere globally to reuse across projects., _(*3)

If not using as a global library, your local composer.json will need to include the following config., _(*4)

{
  "config": {
    "allow-plugins": {
      "dealerdirect/phpcodesniffer-composer-installer": true
    }
  }
}

Install via composer, _(*5)

composer require lipemat/wp-phpcs

Copy the phpcs-sample.xml file to the root of your plugin and rename to phpcs.xml. Adjust the configuration as desired., _(*6)

Running

The vendor/bin folder includes the scripts to run on either Windows or Unix. You may either add that directory to your PATH or call it verbosely like so: ``` bash {project dir}/vendor/bin/phpcs ./, _(*7)

OR
``` bash
{project dir}/vendor/bin/phpcbf ./

You may also create your own script somewhere on your PATH. Here is an example phpcs.bat for Windows. This assumes you created a folder named wp-phpcs in your root and ran composer require there. text @echo off C:\wp-phpcs\vendor\bin\phpcs %*, _(*8)

Automating

Once you have scripts added to your path for phpcs and phpcbf, you can use the included git-hooks/pre-commit to run PHP lint and PHPCS automatically before making any commit., _(*9)

Copy the pre-commit file to your plugin's .git/hooks directory, and the rest is automatic., _(*10)

Included Sniffs

1. WordPress Coding Standards
2. WordPress VIP Coding Standards
3. PHPCompatibilityWP
4. PHPCSExtra

Lipe Sniffs

This package ships with some optional Lipe namespaced sniffs. 1. <rule ref="Lipe" /> for all our default configurations and sniffs. 1. @note This configuration is opinionated, you probably just want to include desired sniff namespaces. 2. <rule ref="Lipe.JS" /> for our JavaScript security sniffs, which support dompurify. 3. <rule ref="Lipe.DB.CalcFoundRows" /> for detecting the deprecated uses of MySQL SQL_CALC_FOUND_ROWS. 4. <rule ref="Lipe.PHP.DisallowNullCoalesceInCondition" /> for detecting using ?? in conditions. 5. <rule ref="Lipe.PHP.DisallowNullCoalesceInForLoops" /> for detecting using ?? in for loops. 6. <rule ref="Lipe.Performance.SlowMetaQuery" /> for detecting slow meta queries. 1. Like WordPress.DB.SlowDBQuery.slow_db_query_meta_query but supports using EXISTS and NOT_EXISTS meta queries. 7. <rule ref="Lipe.Performance.SlowOrderBy" /> for detecting slow ORDER BY clauses in WP_Query. 8. <rule ref="Lipe.Performance.PostNotIn" /> for detecting uses of post__not_in clauses in WP_Query. 9. <rule ref="Lipe.Performance.SuppressFilters" /> for detecting missing uses of suppress_filters clauses in get_posts., _(*11)

LipePlugin Sniffs

This package ships with some optional LipePlugin namespaced sniffs designed to be used with a distributed plugin or library. 1. <rule ref="LipePlugin" /> for all the default configurations and sniffs. 1. @note This configuration is opinionated, you probably just want to include desired sniff namespaces. 2. <rule ref="Lipe.CodeAnalysis.SelfInClassSniff" /> force using static instead of self to improve extensibility. 1. 'ReturnType' - return type of methods. 2. 'InstanceOf' - self instance for static calls. 3. 'NewInstance' - Constructing via new self(). 4. 'ScopeResolution' - Local constants via self::. 3. <rule ref="LipePlugin.TypeHints.PrivateInClass" /> for distributed packages, which should not use private to improve extensibility. 4. <rule ref="LipePlugin.TypeHints.PreventStrictTypes" /> for distributed packages, which should not use strict_type to improve compatibility., _(*12)

Other Notes

The phpcs-sample.xml has many things excluded. This is because some things don't really fit in with WordPress standards. You can remove any of <exclude> items to make more strict. Remove them all if you really want to make your code strict., _(*13)