fivelab/ci-rules

Custom rules for code style and static analyzer

dev-master 2024-01-09 07:54 UTC

Requires

• php: ~8.0

Requires (Dev)

• escapestudios/symfony2-coding-standard: ~3.13
• phpstan/phpstan: ~1.10
• phpunit/phpunit: ~9.5

Suggests

• escapestudios/symfony2-coding-standard: For use code style rules
• phpstan/phpstan: For use static analyzer rules.

MIT

• Vitaliy Zhuk
• FiveLab Team

• query
• specification
• Code style
• static analyzer
• satisfy

README

 #StandWithUkraine 

CI Rules

• Extends escapestudios/symfony2-coding-standard code style rules with added our custom rules.
• Add custom rules for phpstan.

Development

For easy development you can use the Docker.

docker build -t ci-rules .
docker run -it -v $(pwd):/code --name ci-rules ci-rules bash

After success run and attach to container you must install vendors:

composer update

Before create the PR or merge into develop, please run next commands for validate code:

./bin/phpunit

./bin/phpcs --config-set show_warnings 0
./bin/phpcs --standard=vendor/escapestudios/symfony2-coding-standard/Symfony/ src/
./bin/phpcs --standard=tests/phpcs.xml tests/