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.3 or higher
• Composer

Install via Composer

composer require --dev devstrict/phpcs

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 DevStrict rules -->
    <rule ref="DevStrict"/>
</ruleset>

Rulesets

DevStrict

The main ruleset includes all available rules. See RULES.md for detailed documentation of each rule.

Core Rules:

• DevStrict.Attributes.ForbiddenAttributes - Disallow specific attributes (e.g. #[ArrayShape])
• DevStrict.ControlStructures.DisallowCountInLoop - Prevent count() in loop conditions for performance
• DevStrict.ControlStructures.DisallowGotoStatement - Disallow goto statements as anti-pattern
• DevStrict.ControlStructures.DisallowThrowInTernary - No exceptions in ternary operators
• DevStrict.ControlStructures.UseInArray - Suggest in_array() for multiple OR comparisons
• DevStrict.Formatting.MethodChainingIndentation - Enforce four-space indentation for multi-line method chains
• DevStrict.Formatting.MethodChainingPerLine - Require one chained call per line once the chain is broken
• DevStrict.Formatting.ConsistentStatementIndentation - Keep statements at the same nesting level aligned with identical indentation
• DevStrict.Formatting.DisallowConsecutivePhpTags - Warn when ?>...<?php switches appear repeatedly in view files
• DevStrict.Functions.DisallowCastFunctions - Use type casts instead of strval(), intval(), floatval(), boolval()
• DevStrict.Functions.PreferModernStringFunctions - Suggest modern string functions (str_contains(), str_starts_with(), str_ends_with()) instead of strpos()
• DevStrict.Functions.PreferJsonValidate - Suggest json_validate() instead of json_decode() for validation-only use cases
• DevStrict.Objects.DisallowVariableStaticProperty - Forbid $object::$property static property access

Yii2 Framework Rules:

• DevStrict.Yii2.DisallowResponseFormatAssignment - Use controller methods like asJson() instead of direct assignment
• DevStrict.Yii2.PreferActiveRecordShortcuts - Suggest findOne()/findAll() over find()->where()->one()/all()
• DevStrict.Yii2.PreferExistsOverCount - Use exists() instead of count() > 0 for better performance
• DevStrict.Yii2.PreferIsGuestOverUserIdCheck - Use Yii::$app->user->isGuest instead of checking id directly

Development

Guidelines

• All new sniffs must have tests
• Follow the existing code style
• Update documentation when necessary
• Ensure all checks pass (composer check)

License

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

Additional Resources

• PHP_CodeSniffer Documentation
• Creating Custom Sniffs