automattic/phpcs-neutron-ruleset

A PHPCS meta-ruleset for WordPress development

v3.4.0 2021-03-15 19:18 UTC

Requires

• php: ^7.0 || ^8.0
• automattic/phpcs-neutron-standard: ^1.5.3
• sirbrillig/phpcs-import-detection: ^1.1.4
• sirbrillig/phpcs-variable-analysis: ^2.6.1
• wp-coding-standards/wpcs: ^2.1.0

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.5.0
• squizlabs/php_codesniffer: ^3.4.2

MIT

README

These are a set of modern (PHP >7) linting guidelines for WordPress development. Because of the newer PHP version, it is not suitable for work on Core WordPress, but may be useful for those who are not bound by PHP 5.2.

Warning

IMPORTANT NOTE: This project is no longer actively developed. At Automattic we've switched to using the WordPress Coding Standards + VariableAnalysis.

These guidelines are being developed primarily for a team within Automattic, but anyone is free to use them, suggest changes, or report bugs.

This project is a phpcs "standard" (a collection of rules or "sniffs") that can be included in any project.

This is a meta-project in that it's just a collection of rules defined in these packages with certain modifications:

• WordPress Coding Standards
• VariableAnalysis
• NeutronStandard
• ImportDetection

Installation

To use these rules in a project which is set up using composer, we recommend using the phpcodesniffer-composer-installer library which will automatically use all installed standards in the current project with the composer type phpcodesniffer-standard when you run phpcs.

composer require --dev squizlabs/php_codesniffer dealerdirect/phpcodesniffer-composer-installer
composer require --dev automattic/phpcs-neutron-ruleset

Configuration

When installing sniff standards in a project, you edit a phpcs.xml file with the rule tag inside the ruleset tag. The ref attribute of that tag should specify a standard, category, sniff, or error code to enable. It’s also possible to use these tags to disable or modify certain rules. The official annotated file explains how to do this.

The following configuration will enable all the sniffs in this ruleset.

<?xml version="1.0"?>
<ruleset name="MyStandard">
 <description>My library.</description>
 <rule ref="NeutronRuleset"/>
</ruleset>

Usage

Most editors have a phpcs plugin available, but you can also run phpcs manually. To run phpcs on a file in your project, just use the command-line as follows (the -s causes the sniff code to be shown, which is very important for learning about an error).

vendor/bin/phpcs -s src/MyProject/MyClass.php