polylang-cs's Introduction

Polylang Coding Standards

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>

polylang-cs's People

Contributors

Watchers

polylang-cs's Issues

Introduce hooks doc block sniff

I'd like to check that all hooks are correctly documented.

Such sniff is currently not included in any of the rulesets that we rely on. There is a project to introduce one in WPCS, but it's currently planned for a "future release".

I have tested the sniff WooCommerce.Commenting.CommentHooks from https://github.com/woocommerce/woocommerce-sniffs/ but all comments such as /** This filter is documented in... */ are reported as errors, which is a no go for us.

Maybe we could write our own sniff, mixing the best of the 2 existing works.