think-zap/coding-standards

Zap Coding Standard for PHPCS

2.0.0 2024-09-02 14:17 UTC

Requires

• php: >=7.4
• automattic/vipwpcs: ^3.0
• dealerdirect/phpcodesniffer-composer-installer: ^1.0
• phpcompatibility/phpcompatibility-wp: ^2.1
• slevomat/coding-standard: ^8.0
• squizlabs/php_codesniffer: ^3.6

MIT

• code
• rules
• style
• static analysis
• standard
• phpcs
• sniffer
• coding
• ZAP
• sniffs
• checks
• think zap

README

The Zap Coding Standard is a set of PHP_CodeSniffer rules for use primarily with the Zap Competition plugins.

Requirements

• PHP ^8.2

Install

Composer v2:

composer require --dev Think-Zap/coding-standards "^2.0"`

Composer v1:

Add to the repositories object:

    {
      "type": "vcs",
      "url": "[e-mail]:Think-Zap/coding-standards.git"
    }

And require-dev:

  "Think-Zap/coding-standards": "^3.0"

Project ruleset

Ensure you're running PHP 8.2 locally!

To use this ruleset, create a phpcs.xml.dist in the root of the project and add the following content:

<?xml version="1.0"?>
<ruleset>
	<arg name="basepath" value="." />
	<arg name="extensions" value="php" />
	<arg name="severity" value="4" />
	<arg name="tab-width" value="4" />
	<arg name="parallel" value="80" />
	<arg name="colors" />

	<!--  Update to the PHP version your production/local docker container runs on -->
	<config name="testVersion" value="7.4" />
	<!-- php -r 'echo PHP_VERSION_ID;' -->
	<config name="php_version" value="70400" />

	<!-- Fix WordPress's terrible typing breaking PHPCS -->
	<config name="minimum_supported_wp_version" value="5.6.0" />

	<!-- Ignore warnings, show progress of the run and show sniff names -->
	<arg value="nps" />

	<!-- Directories to be checked -->
	<file>./wp-content/plugins</file>

	<!-- Exclude files -->
	<exclude-pattern>*-config.php</exclude-pattern>
	<exclude-pattern>*vendor/</exclude-pattern>
	<exclude-pattern>*tests/*</exclude-pattern>
	<exclude-pattern>*.twig</exclude-pattern>
	<exclude-pattern>*webpack/</exclude-pattern>

	<!-- Include the Zap coding standard -->
	<rule ref="Zap" />
</ruleset>

Add phpcs.xml to your .gitignore

Manual Usage

PHPCS

./vendor/bin/phpcs --standard=Zap /path/to/files/**.php

PHPCBF

./vendor/bin/phpcbf --standard=Zap /path/to/files/**.php