internals.md

Internals

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

Code style

Use Rector to make codebase follow some specific rules or use either newest or any specific version of PHP:

./vendor/bin/rector

Dependencies

This package uses composer-require-checker to check if all dependencies are correctly defined in composer.json. To run the checker, execute the following command:

./vendor/bin/composer-require-checker

Benchmarks

The package provides performance benchmarks for the main use-cases, implemented with phpbench.

Benchmarks are located in tests/Benchmark and configured via phpbench.json.

To run the benchmarks:

./vendor/bin/phpbench run

Or via Composer script:

composer bench