lonnylot/dusk-watcher

Automatically rerun Laravel Dusk tests when source code changes

Automatically rerun PHPUnit tests when source code changes

, _(*1)

Wouldn't it be great if your PHPUnit tests would be automatically rerun whenever you change some code? This package can do exactly that., _(*2)

With the package installed you can do this:, _(*3)

phpunit-watcher watch

Here's how it looks like:, _(*4)

, _(*5)

This will run the tests and rerun them whenever a file in the app, src or tests directory is modified., _(*6)

Want to pass some arguments to PHPUnit? No problem, just tack them on:, _(*7)

phpunit-watcher watch --filter=it_can_run_a_single_test

In his excellent talk at Laracon EU 2017 Amo Chohan shows our phpunit-watcher in action., _(*8)

, _(*9)

Installation

You can install this package globally like this, _(*10)

composer global require spatie/phpunit-watcher

After that phpunit-watcher watch can be run in any directory on your system., _(*11)

Alternatively you can install the package locally as a dev dependency in your project, _(*12)

composer require spatie/phpunit-watcher --dev

Locally installed you can run it with vendor/bin/phpunit-watcher watch, _(*13)

Usage

All the examples assume you've installed the package globally. If you opted for the local installation prepend vendor/bin/ everywhere where phpunit-watcher is mentioned., _(*14)

You can start the watcher with:, _(*15)

phpunit-watcher watch

This will run the tests and rerun them whenever a file in the src or tests directory is modified., _(*16)

Want to pass some arguments to PHPUnit? No problem, just tack them on:, _(*17)

phpunit-watcher watch --filter=it_can_run_a_single_test

Customization

Certain aspects of the behaviour of the tool can be modified. All options can be set in a .phpunit-watcher.yml in your project directory., _(*18)

If a such a config file does not exist in the project directory, the tool will check if the file exists in any of the parent directories of the project directory., _(*19)

Here's some example content. Read on for a more detailed explanation of all the options., _(*20)

watch:
  directories:
    - src
    - tests
  fileMask: '*.php'
notifications:
  passingTests: false
  failingTests: false
phpunit:
  arguments: '--stop-on-failure'

Customize watched directories and files

You can customize the directories being watched by creating a file named .phpunit-watcher.yml in your project directory. Here's some example content:, _(*21)

watch:
  directories:
    - src
    - tests
  fileMask: '*.php'

Desktop notifications

By default the tool will display desktop notifications whenever the tests pass or fail. If you want to disable certain desktop notifications update .phpunit-watcher.yml by adding a notifications key., _(*22)

notifications:
  passingTests: false
  failingTests: false

Initial PHPUnit arguments

If you want to use pass the same arguments to PHPUnit everytime to watcher starts, you can specificy those in the .phpunit-watcher.yml config file. Here's an example:, _(*23)

phpunit:
  arguments: '--stop-on-failure'

When starting the tool with some arguments (eg phpunit-watcher watch --filter=my_favourite_test) those arguments will get used instead of the ones specified in the config file., _(*24)

Changelog

Please see CHANGELOG for more information what has changed recently., _(*25)

Testing

bash composer test, _(*26)

Contributing

Please see CONTRIBUTING for details., _(*27)

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker., _(*28)

Postcardware

You're free to use this package (it's MIT-licensed), but if you use it often we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using., _(*29)

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium., _(*30)

We publish all received postcards on our company website., _(*31)

Credits

• Freek Van der Herten
• All Contributors

We started creating this package after reading this excellent article by Christoper Pitt, _(*32)

Interactive commands were inspired by Jest., _(*33)

Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website., _(*34)

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff., _(*35)

License

The MIT License (MIT). Please see License File for more information., _(*36)