JBZoo Codestyle QA Assistant

Expert assistant for working with the JBZoo Codestyle library - a comprehensive PHP code quality and standards toolkit that provides configurations and tools for PHPStan, Psalm, PHP-CS-Fixer, PHPUnit, PHPMD, Phan, and other QA tools.

What This Skill Does

This skill helps you work with the JBZoo Codestyle project, which is a code quality library designed to be included in other JBZoo projects to enforce consistent coding standards. It provides guidance on:

Instructions for AI Agent

When working with this codebase, follow these guidelines:

1. Understand the Project Structure

**Core Components:**

- `01_defines.Makefile` - Variables and paths

- `03_tests.Makefile` - Test and lint commands

- `04_reports.Makefile` - Coverage and reports

**Key Files:**

2. Common Development Tasks

**Setup and Dependencies:**

```bash

make update # Install/update Composer dependencies

make autoload # Regenerate optimized autoloader

```

**Running Tests:**

```bash

make test # Run PHPUnit test suite

make test-all # Run all tests and code style checks

make codestyle # Run all linters together

```

**Individual QA Tools:**

```bash

make test-phpstan # PHPStan static analysis

make test-psalm # Psalm static analysis

make test-phpcs # PHP CodeSniffer (PSR-12)

make test-phpcsfixer # Check PHP-CS-Fixer rules

make test-phpcsfixer-fix # Auto-fix with PHP-CS-Fixer

make test-phpmd # PHP Mess Detector

make test-phan # Phan static analyzer

```

**Generating Reports:**

```bash

make report-all # All reports

make report-phpmetrics # PHP Metrics HTML report

make report-pdepend # PHP Depend report

```

3. Code Standards and Requirements

**PHP Standards:**

**Testing Patterns:**

4. Working with PHP-CS-Fixer Configuration

The main coding standard (`src/PhpCsFixer/PhpCsFixerCodingStandard.php`) combines:

When modifying rules:

1. Update `PhpCsFixerCodingStandard::getRules()` method

2. Test with `make test-phpcsfixer`

3. Apply fixes with `make test-phpcsfixer-fix`

5. Integration into Other Projects

Projects integrate this library by adding to their Makefile:

```makefile

ifneq (, $(wildcard ./vendor/jbzoo/codestyle/src/init.Makefile))

include ./vendor/jbzoo/codestyle/src/init.Makefile

endif

```

This provides all `make` commands to the parent project.

6. Extending the Testing Framework

When creating new test traits or base classes:

1. Place in `src/PHPUnit/` directory

2. Use namespace `JBZoo\Codestyle\PHPUnit`

3. Follow existing trait naming: `Trait*` prefix

4. Add trait documentation for available methods

5. Consider CI environment compatibility (TeamCity, GitHub Actions)

7. Adding New QA Tools

To add a new QA tool:

1. Add configuration file in `src/` or project root

2. Add Make target in `src/Makefiles/03_tests.Makefile`

3. Add Composer dev dependency

4. Update `test-all` and `codestyle` targets

5. Document in README

8. Common Tasks

**Adding a new PHP-CS-Fixer rule:**

**Creating a new PHPUnit trait:**

**Modifying Makefile commands:**

**Updating static analysis rules:**

Examples

Example 1: Run all quality checks before committing

```bash

make test-all

```

This runs PHPUnit tests plus all linters (PHPStan, Psalm, PHP-CS-Fixer, PHPCS, PHPMD).

Example 2: Auto-fix code style issues

```bash

make test-phpcsfixer-fix

```

Automatically applies PHP-CS-Fixer rules to fix formatting issues.

Example 3: Generate comprehensive quality reports

```bash

make report-all

```

Creates HTML reports for code coverage, metrics, and dependencies.

Example 4: Check PHP 8.2 compatibility

```bash

make test-phpcs

```

Runs PHP CodeSniffer with PHP 8.2 compatibility rules.

Important Notes

Constraints