Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [Global Assertions](/docs/plugins/global-assertions)
- [Snapshots](/docs/plugins/snapshots)
- [Creating Plugins](/docs/plugins/creating-plugins)
- [Watch](/docs/plugins/watch)
- ## More
- [Changelog](/docs/changelog)
- [Upgrade Guide](/docs/upgrade-guide)
Expand Down
2 changes: 1 addition & 1 deletion plugins/creating-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,4 +180,4 @@ Any amount of further files can be added this way. They will be loaded automatic

---

Next section: [Changelog →](/docs/changelog/)
Next section: [Watch Plugin →](/docs/plugins/watch)
34 changes: 34 additions & 0 deletions plugins/watch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Watch Plugin
description: The Watch Plugin
---

# Watch Plugin

> Note: This is still a development package and needs further testing.

The Watch plugin for Pest keeps an eye on your `tests/` folder and automatically run your Pest tests on file change.

Follow these two steps to install it:

1. [**Install fswatch**](https://github.com/emcrisostomo/fswatch#getting-fswatch) on your machine, or check if you already have it:

```bash
fswatch --version
```

2. Install the Watch plugin using Composer:

```bash
composer require pestphp/pest-plugin-watch --dev
```

This will add a new option to your Pest CLI so you can start watching any updates on your `tests/` folder.

**Just start Pest with the following command:**

```bash
pest --watch # Night gathers, and now my watch begins
```

Next section: [Changelog →](/docs/changelog)