Repository files navigation

⚠️Archived 2025-08-17

Use at your own risk.

Automate running your PHP QA toolset!

# npm$ npm i phly-php-qa-watch -g# yarn$ yarn global add phly-php-qa-watch

At its most basic, execute the watcher:

$ php-qa-watch

By default, the script, runscomposer check when any of the following change:

• phpunit.xml.dist
• phpcs.xml
• any PHP files undersrc/
• any PHP files undertest/

You can alter the behavior via the following flags:

• -d|--no-notifications will disable system notifications when failures occur
• -w|--watch-files allows you to provide a comma separated list of files/globpatterns to watch
• -c|--check-command allows you to specify an alternate command to run inorder to perform checks; defaults to "composer check"

Using either-h or--help will provide the usage message as well.

To use an alternate tool or pipeline for checking your project, use the-c or--check-command flags to provide one. As an example, perhaps you want tocombine several composer scripts, without writing an aggregate:

$ php-qa-watch -c"composer cs-lint && composer unit-test && composer mess-detector"

Alternately, perhaps you don't have composer scripts defined; you can justspecify an&&'d set of commands in that case:

$ php-qa-watch -c"./vendor/bin/php-cs-fixer fix --dry-run -v --diff && phpunit --colors=always"

The-w or--watch-files flags allow you to specify a comma-separated list offiles, directories, or glob patterns detailing what files to watch for changes.

Let's combine this with the above example:

$ php-qa-watch \> -c"./vendor/bin/php-cs-fixer fix --dry-run -v --diff && phpunit --colors=always" \> -w".php_cs,phpunit.xml,phpunit.xml.dist,src/**/*.php,test/**/*.php"

The above adds ensures that the.php_cs andphpunit.xml files are watched,but not thephpcs.xml (which is in the default set).

By default,php-qa-watch will provide a system notification when the specifiedchecker fails. This is done to allow you to run the watcher in a hiddenterminal, and only raise it when you see a notification of a break.

If you do not want the notification, disable it with the-d or--no-notifications flag.