ssgonchar/PHP.Skeleton

CI ready PHP project skeleton

PHP.Skeleton

A standard PHP project 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

Requirements

• PHP 5.4+

Getting started

Create project

composer create-project 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] (https://github.com/phpmd/phpmd) and phpunit. Run phpunit for unit test only.

composer test

cs-fix

composer cs-fix run php-cs-fixer and phpcbf to fix up the PHP code to follow the coding standards.

composer cs-fix

build

composer build run apigen, phploc, pdepend and test above. It's handy for Jenkins.

composer build

Global installation of QA tools

composer global require bear/qatools

Add this directory to your PATH in your ~/.bash_profile (or ~/.bashrc) like this:

export PATH=./vendor/bin:~/.composer/vendor/bin:$PATH

See detail at bear/qatools.