haspadar/piqule

Quality checks for PHP projects

v0.10.6 2026-03-14 23:49 UTC

Requires

• php: ~8.3.16 || ~8.4.3 || ~8.5.0
• friendsofphp/php-cs-fixer: ^3.91
• infection/infection: ^0.32.0
• phpmd/phpmd: ^2.15
• phpmetrics/phpmetrics: ^2.9
• phpstan/phpstan: ^2.1
• phpunit/phpunit: ^12.0
• squizlabs/php_codesniffer: ^4.0
• symfony/process: ^7.0
• vimeo/psalm: ^6.14

Suggests

• ext-xdebug: Required to generate coverage reports and run Infection

MIT

• Kanstantsinas Mesnikas

README

Opinionated quality policies for PHP projects.

Zero configuration required.
Reproducible and consistent checks across environments.

Install

composer require --dev haspadar/piqule
vendor/bin/piqule sync

Configure

Customization is optional.

If needed, create .piqule.php in the project root.

Use OverrideConfig with dot-separated keys:

<?php

declare(strict_types=1);

use Haspadar\Piqule\Config\DefaultConfig;
use Haspadar\Piqule\Config\OverrideConfig;

return new OverrideConfig(new DefaultConfig(), [
    'ci.php.matrix' => ['8.3', '8.4', '8.5'],
    'ci.pr.max_lines_changed' => 400,
    'ci.piqule_bin' => 'vendor/bin/piqule',
]);

.piqule/ and .github/ are generated by piqule sync and may be safely deleted.

Commands

• piqule sync — generate configuration from templates
• piqule check — run all checks
• piqule check <tool> — run specific tool
• piqule fix — run auto-fixable tools
• piqule fix <tool> — run specific fixer

Checks

• PHPStan
• Psalm
• PHPUnit
• Infection
• PHPMD
• PHP Metrics
• PHP_CodeSniffer
• PHP-CS-Fixer
• actionlint
• hadolint
• shellcheck
• markdownlint-cli2
• jsonlint
• yamllint
• typos

GitHub CI includes:

• Pull request size limit
• Code coverage (Codecov)

These checks ensure consistency and quality in pull requests and releases.

Contributing

Contributions are welcome.

1. Fork the repository
2. Create a feature branch
3. Ensure all checks pass
4. Open a pull request

All pull requests must pass CI before merging.

License

MIT