Skip to content

Commit 6e275bc

Browse files
owenvokecanecoalexmartinfr
committed
docs: add page for the Watch plugin
Co-authored-by: Caneco <vitorcaneco@gmail.com> Co-authored-by: Alex Martin <AlexMartinFR@users.noreply.github.com>
1 parent b086170 commit 6e275bc

3 files changed

Lines changed: 36 additions & 1 deletion

File tree

documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- [Global Assertions](/docs/plugins/global-assertions)
2222
- [Snapshots](/docs/plugins/snapshots)
2323
- [Creating Plugins](/docs/plugins/creating-plugins)
24+
- [Watch](/docs/plugins/watch)
2425
- ## More
2526
- [Changelog](/docs/changelog)
2627
- [Upgrade Guide](/docs/upgrade-guide)

plugins/creating-plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,4 +180,4 @@ Any amount of further files can be added this way. They will be loaded automatic
180180

181181
---
182182

183-
Next section: [Changelog ](/docs/changelog/)
183+
Next section: [Watch Plugin ](/docs/plugins/watch)

plugins/watch.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Watch Plugin
3+
description: The Watch Plugin
4+
---
5+
6+
# Watch Plugin
7+
8+
> Note: This is still a development package and needs further testing.
9+
10+
The Watch plugin for Pest keeps an eye on your `tests/` folder and automatically run your Pest tests on file change.
11+
12+
Follow these two steps to install it:
13+
14+
1. [**Install fswatch**](https://github.com/emcrisostomo/fswatch#getting-fswatch) on your machine, or check if you already have it:
15+
16+
```bash
17+
fswatch --version
18+
```
19+
20+
2. Install the Watch plugin using Composer:
21+
22+
```bash
23+
composer require pestphp/pest-plugin-watch --dev
24+
```
25+
26+
This will add a new option to your Pest CLI so you can start watching any updates on your `tests/` folder.
27+
28+
**Just start Pest with the following command:**
29+
30+
```bash
31+
pest --watch # Night gathers, and now my watch begins
32+
```
33+
34+
Next section: [Changelog →](/docs/changelog)

0 commit comments

Comments
 (0)