A standard PHP project skeleton

(former php/skeleton)

This project was created in order to provide project skeleton to start new PHP project. Various config files are ready for continuous integration.

• phpunit.xml.dist for phpunit
• phpmd.xml for PHPMD
• phpcs.xml for PHP_CodeSniffer
• .php_cs for php-cs-fixer
• .travis.yml for Travis CI
• .scrutinizer for scrutinizer-ci
• phpstan.neon for phpstan

Getting started

Create project

composer create-project koriym/php-skeleton {project-path}

What is the vendor name ?

(MyVendor):Koriym

What is the package name ?

(MyPackage):AwesomeProject

What is your name ?

(Akihito Koriyama):

Composer scripts

test

composer test run phpcs, phpmd and phpunit. Run phpunit for unit test only.

composer test

coverage

composer coverage builds test coverage report.

composer coverage

cs-fix

composer cs-fix run php-cs-fixer and phpcbf to fix up the PHP code to follow the coding standards. (Check only command compposer cs is also available.)

composer cs-fix

build

composer build run phploc, pdepend and test above. It's handy for Jenkins. You need composer require phploc/phploc and pdepend/pdepend for this.

composer build