wmde / fun-validators
General and shared validation services created as part of the WMDE fundraising software
Installs: 13 847
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 7
Forks: 0
Open Issues: 0
Requires
- php: >=8.1
Requires (Dev)
- phpstan/phpstan: ^1.0
- phpunit/phpunit: ~10.0
- wmde/fundraising-phpcs: ~9.0
README
General and shared validation services created as part of the WMDE fundraising software.
Installation
To use the fun-validators library in your project, simply add a dependency on wmde/fun-validators
to your project's composer.json
file. Here is a minimal example of a composer.json
file that just defines a dependency on fun-validators 1.x:
{ "require": { "wmde/fun-validators": "~1.0" } }
Development
For development you need to have Docker and Docker-compose installed. Local PHP and Composer are not needed.
sudo apt-get install docker docker-compose
Running Composer
To pull in the project dependencies via Composer, run:
make composer install
You can run other Composer commands via make run
, but at present this does not support argument flags.
If you need to execute such a command, you can do so in this format:
docker run --rm --interactive --tty --volume $PWD:/app -w /app\
--volume ~/.composer:/composer --user $(id -u):$(id -g) composer composer install -vvv
Running the CI checks
To run all CI checks, which includes PHPUnit tests, PHPCS style checks and coverage tag validation, run:
make
Running the tests
To run just the PHPUnit tests run
make test
To run only a subset of PHPUnit tests or otherwise pass flags to PHPUnit, run
docker-compose run --rm fun-validators-7.2 ./vendor/bin/phpunit --filter SomeClassNameOrFilter
If you have failing unit tests but want to run them for all PHP versions (normally it would bail on the first error) you can do so using
make -i test
In this case do keep in mind that the exit code can not be used to assess the run's success.