wpsyntex/polylang-cs

Coding standards for WP Syntex's plugins

dev-main 2022-08-26 10:08 UTC

Requires

• automattic/phpcs-neutron-standard: *
• automattic/vipwpcs: *
• dealerdirect/phpcodesniffer-composer-installer: *
• phpcompatibility/phpcompatibility-wp: ^2.1
• roave/security-advisories: dev-master
• squizlabs/php_codesniffer: ^3.6
• suin/phpcs-psr4-sniff: ^3.0
• wp-coding-standards/wpcs: ^2.3

MIT

README

Polylang Coding Standards is a ruleset for code quality tools to be used in WP Syntex's projects.

Installation

Standards are provided as a Composer package and can be installed with:

composer require --dev wpsyntex/polylang-cs:dev-main

PHP Code Sniffer

Set of PHP_CodeSniffer rules.

The following rulesets are included:

• Several custom sniffs mainly focused on naming conventions,
• NeutronStandard,
• PHPCompatibilityWP (for PHP and WP version),
• Suin (for PSR-4),
• WordPress,
• WordPressVIPMinimum.

Example for your phpcs.xml.dist file:

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="Polylang Foobar" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/squizlabs/PHP_CodeSniffer/master/phpcs.xsd">
    <description>Coding standards for Polylang Foobar.</description>

    <arg value="p"/><!-- Shows progress. -->
    <arg name="colors"/><!-- Shows results with colors. -->
    <arg name="extensions" value="php"/><!-- Limits to PHP files. -->

    <file>.</file>

    <!-- Our own ruleset. -->
    <rule ref="Polylang">
        <exclude name="Squiz.PHP.CommentedOutCode.Found"/>
        <exclude name="WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize"/>
    </rule>

    <!-- Run against the PHPCompatibility ruleset: PHP 5.6 and higher + WP 5.4 and higher. -->
    <config name="testVersion" value="5.6-"/>
    <config name="minimum_supported_wp_version" value="5.4"/>

    <!-- Run against the PSR-4 ruleset. -->
    <!-- https://github.com/suin/phpcs-psr4-sniff -->
    <arg name="basepath" value="."/>
</ruleset>