parf/composer-php8-template

PHP8/8.1 Template for composer/packagist

1.0.2 2022-04-06 18:03 UTC

Requires

• php: >=8.0

MIT

• Sergey Parf

• template

README

INSTALL / How to Use:

• composer create-project parf/composer-php8-template your-project-name
• edit composer.json
• run composer install

Provides:

• ready to use Composer Package Template for php 8/8.1 projects
• commonly used php tools (see list below)
• default tools configurations
• useful scripts

Provided Php-Tools

• php code linter
• psalm static code analyzer and fixer
• php-stan static code analyzer
• rector code analyzer & refactoring tool
• phpDocumentor documentation application for PHP projects
• php-cs-fixer Coding Standards Fixer
• php-unit Unit Testing
• spartan-test (phpunit alternative) + automated web-test framework
• psysh - php cli shell

tools install instructions

Scripts

composer test
run unit tests. use test-q to run tests silently (show errors only)

composer psalm
check code with psalm

composer stan
check code with php-stan (default level is 6)

composer lint
php syntax check

composer psalm-dry / composer psalm-fix (aka psalter)
review/apply suggested code changes by psalm, be careful always do dry-run first

composer cs-dry / composer cs-fix
review/apply suggested code changes by php-cs-fixer, be careful always do dry-run first

composer doc
generate phpDocumentor documentation in doc folder

./check
do all checks: lint, unit tests, psalm, php-stan; stops when any of them failed

./check-commit, ./check-push
do ./check, add all new files to git, do git commit -v -s and git push --tags

./psysh php cli shell
notable commands: wtf, doc Class, doc Class::method, show Class::method, ls -l ClassName, help

see composer.json scripts section for more scripts shortcuts