automattic/jetpack-codesniffer

Jetpack Coding Standards. Based on the WordPress Coding Standards, with some additions.

v2.5.0 2022-04-05 18:48 UTC

Requires

• automattic/vipwpcs: ^2.3
• dealerdirect/phpcodesniffer-composer-installer: ^0.7
• mediawiki/mediawiki-codesniffer: ^38.0
• phpcompatibility/phpcompatibility-wp: ^2.1
• sirbrillig/phpcs-variable-analysis: ^2.10
• wp-coding-standards/wpcs: ^2.3

Requires (Dev)

• automattic/jetpack-changelogger: ^3.0
• wp-coding-standards/wpcs: dev-develop#7b39722c38cbf2fe64c55be7154ee6f1807d304c as 2.3.1
• yoast/phpunit-polyfills: 1.0.3

GPL-2.0-or-later

README

This is a package implementing phpcs sniffs for the Jetpack Coding Standard.

This standard is generally that of WordPress, with a few additions.

Usage

In your project's composer.json, add the following lines:

{
    "require-dev": {
        "dealerdirect/phpcodesniffer-composer-installer": "*",
        "automattic/jetpack-codesniffer": "^1"
    }
}

Your project must use the default composer vendor directory, vendor.

You should then include the Jetpack rules in your .phpcs.xml.dist, like

<rule ref="Jetpack" />

You will also likely want to set some configuration for other included rulesets:

<config name="minimum_supported_wp_version" value="5.4" />
<config name="testVersion" value="5.6-"/>

Included Standards

The Jetpack standard includes the following other standards:

• PHPCompatibilityWP
• WordPress-Core, WordPress-Docs, and WordPress-Extra
• VariableAnalysis
• Selected sniffs from MediaWiki