vix/phpcs-sniffs

Custom PHP_CodeSniffer ruleset for strict development standards

v0.3.0 2026-05-18 13:18 UTC

Requires

• php: ^8.3
• dealerdirect/phpcodesniffer-composer-installer: ^1.2.0
• squizlabs/php_codesniffer: ^4.0.1

Requires (Dev)

• captainhook/captainhook: ^5.29.2
• friendsofphp/php-cs-fixer: ^3.94.2
• phpstan/extension-installer: ^1.4.3
• phpstan/phpstan: ^2.1.44
• phpstan/phpstan-strict-rules: ^2.0.10
• phpunit/phpunit: ^13.0.5
• slevomat/coding-standard: ^8.28.1

MIT

• Anton VIX

• phpcs
• dev
• static-analysis
• coding-standards
• code-sniffer

README

A comprehensive set of strict PHP_CodeSniffer rules for general PHP, Laravel, and Yii2 projects to maintain high code quality standards in your projects.

Installation

Requirements

• PHP 8.4 or higher
• Composer

Install via Composer

composer require --dev vix/phpcs-sniffs

Usage

Basic Configuration

Create a phpcs.xml file in your project root:

<?xml version="1.0"?>
<ruleset name="MyProject">
    <description>My project coding standard</description>

    <!-- Paths to check -->
    <file>src</file>
    <file>tests</file>

    <!-- Use VixPHPCS rules -->
    <rule ref="VixPHPCS"/>
</ruleset>

Sniffs

The package ships with the VixPHPCS ruleset. Alternatively, individual standalone sniffs can be enabled manually. See docs/SNIFFS.md for the full catalog, examples, and configurable parameters.

Development

Guidelines

• All new sniffs must have tests
• Follow the existing code style
• Update documentation when necessary
• Ensure all checks pass (composer test and composer static-analysis)

License

This project is licensed under the MIT License - see the LICENSE file for details.

Additional Resources

• PHP_CodeSniffer Documentation
• Creating Custom Sniffs