README

Are you tired of copy-pasting your boilerplate PHP code whenever you need to start a new project?

This repository contains a single-line command that will automatically setup for you all the needed code to create a modern, clutter-free and test-oriented PHP package.

It will automatically install the following dependencies:

• PHPUnit: provides testing framework.
• PHP_CodeSniffer: detects violations of a defined set of coding standards.
• PHPMD: analyze your code to detect sub-optimal or overly complex code.
• PHPStan: discover bugs in your code without running it.
• Psalm: - another static analysis tool from Vimeo.
• Infection: mutation testing framework to evaluate test quality.
• ComposerRequireChecker Check composer dependencies.

Project Structure

After installation, your project will have the following structure:

your-project/
├── src/                 # Source code
├── tests/               # Test files
│   └── Fake/            # Test doubles
├── vendor/              # Dependencies
├── vendor-bin/          # Development tool dependencies
├── build/               # Build artifacts (coverage reports, etc.)
├── composer.json        # Project configuration
├── phpcs.xml            # PHP_CodeSniffer configuration
├── phpmd.xml            # PHPMD configuration
├── phpstan.neon         # PHPStan configuration
├── phpunit.xml.dist     # PHPUnit configuration
├── psalm.xml            # Psalm configuration
├── composer-require-checker.json  # Composer dependencies checker configuration
└── README.md            # Project documentation

Create Project

To create your project, enter the following command in your console:

composer create-project koriym/php-skeleton <project-path>

You will be asked a few questions to configure the project:

What is the vendor name ?
(MyVendor):Koriym

What is the package name ?
(MyPackage):AwesomePackage

What is your name ?
(Akihito Koriyama):

What is your email address ?
(akihito.koriyama@gmail.com):

You can also skip the prompts by setting environment variables:

VENDOR=MyVendor PACKAGE=MyPackage composer create-project koriym/php-skeleton <project-path>

Composer Commands

Once installed, the project will automatically be configured, so you can run these commands in the root of your application:

test

composer test runs phpunit.

tests

composer tests runs cs, sa, and test.

coverage, phpdbg, pcov

composer coverage builds a test coverage report using XDebug. composer phpdbg builds a test coverage report using phpdbg. composer pcov builds a test coverage report using pcov.

mutation

composer mutation runs mutation testing using Infection.

cs, cs-fix

composer cs checks coding standard. composer cs-fix fixes the PHP code to match coding standards.

sa

composer sa runs static code analysis tools (PHPStan and Psalm).

build

composer build builds all reports (code quality, test coverage, require check).

Continuous Integration

This project includes several GitHub Actions workflows to ensure code quality and compatibility:

• Continuous Integration: Runs tests on PHP 8.1, 8.2, 8.3, and 8.4
• Static Analysis: Runs PHPStan, Psalm, PHPMD, and ComposerRequireChecker
• Coding Standards: Checks code style with PHP_CodeSniffer
• Mutation Testing: Runs Infection to evaluate test quality (on 1.x branch and PRs)

These workflows are pre-configured for common PHP project needs, but feel free to modify or remove them to suit your project's requirements.