lipsia/phpcs-wp-plugin-standard

A custom phpcs ruleset for WordPress plugin development.

1.5.0 2021-10-21 15:26 UTC

Requires

• php: ^7.3
• automattic/phpcs-neutron-standard: 1.6.0
• dealerdirect/phpcodesniffer-composer-installer: ^0.7.0
• phpcompatibility/phpcompatibility-paragonie: ^1.3
• phpcompatibility/phpcompatibility-wp: ^2.1

Requires (Dev)

• squizlabs/php_codesniffer: ^3.5

MIT

• Lipsia Digital GmbH

• wordpress
• phpcs
• wordpress-plugin

README

This is a superset of the NeutronStandard and PSR12 with some modifications.

Installation

composer require --dev squizlabs/php_codesniffer dealerdirect/phpcodesniffer-composer-installer
composer require --dev lipsia/phpcs-wp-plugin-standard

Usage

In your project's ruleset file, enable this ruleset by setting the <rule> tag.

Minimal phpcs.xml.dist:

<?xml version="1.0"?>
<ruleset>
    <rule ref="LDWordPressPlugin"/>
</ruleset>

Or without a file:

./vendor/bin/phpcs --standard=LDWordPressPlugin .

Opinions

This ruleset is opinionated and that is a good thing.

Rules that MUST NOT be changed

• main plugin file is in ./plugin.php
• all other plugin files are autoloaded from ./src/
• composer dependencies are in ./vendor/
• convert tabs to 4 spaces

Rules that CAN be changed

• use colors in report
• look into all files with extension php
• check 8 files in parallel