byteever/byteever-sniffs

ByteEver PHP Coding Standards

v1.0.1 2023-10-25 04:55 UTC

Requires

• dealerdirect/phpcodesniffer-composer-installer: ^0.7
• phpcompatibility/phpcompatibility-wp: ^2.1
• wp-coding-standards/wpcs: ^3.0

Requires (Dev)

• roave/security-advisories: dev-latest

GPL-3.0-only

• Sultan Nasir Uddin

• wordpress
• standards
• phpcs
• byteever

README

Collection of PHP_CodeSniffer sniffs for ByteEver.

Installation

composer require byteever/byteever-sniffs

Usage

Command line

$ ./vendor/bin/phpcs .

If relying on Composer, edited the composer.json file by adding the following:

	"scripts" : {
		"lint": [
			"phpcs ."
		],
	}

Then lint via:

$ composer run lint

IDE Integration

Some IDE integrations of PHPCS fail to register the ByteEver-Default ruleset. In order to rectify this, place .phpcs.xml.dist at your project root:

<?xml version="1.0"?>
<ruleset name="ByteEver Coding Standards">
	<description>My projects ruleset.</description>

	<!-- Configs -->
	<config name="minimum_supported_wp_version" value="4.7" />
	<config name="testVersion" value="7.2-" />

	<!-- Rules -->
	<rule ref="ByteEver-Defaults" />

	<rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array" value="new-text-domain" />
		</properties>
	</rule>

	<rule ref="PHPCompatibility">
		<exclude-pattern>tests/</exclude-pattern>
	</rule>
</ruleset>