Skip to content

Commit 779edde

Browse files
committed
docs: deprecate watch plugin
1 parent a2a49ae commit 779edde

File tree

2 files changed

+1
-43
lines changed

2 files changed

+1
-43
lines changed

plugins.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ The following plugins are maintained by the Pest team:
1414
- [Faker](#faker)
1515
- [Laravel](#laravel)
1616
- [Livewire](#livewire)
17-
- [Watch](#watch)
1817

1918
---
2019

@@ -160,45 +159,4 @@ it('can be decremented', function () {
160159

161160
---
162161

163-
<a name="watch"></a>
164-
## Watch
165-
166-
**Source code**: [github.com/pestphp/pest-plugin-watch](https://github.com/pestphp/pest-plugin-watch)
167-
168-
To install Pest's "watch" plugin, you need to require the plugin via Composer.
169-
170-
```bash
171-
composer require pestphp/pest-plugin-watch --dev
172-
```
173-
174-
Make sure you also install [`fswatch`](https://github.com/emcrisostomo/fswatch#getting-fswatch) so Pest can monitor when a file changes.
175-
176-
Once both the plugin and `fswatch` are installed, you will be able to use the `--watch` option when running Pest. This option instructs Pest to monitor your application and automatically re-run your tests when you change files within a list of specified directories.
177-
178-
```bash
179-
pest --watch
180-
```
181-
182-
By default, the plugin monitors the following directories.
183-
184-
```plain
185-
tests/
186-
app/
187-
src/
188-
```
189-
190-
To customize the watched directories, supply a comma-separated list of directories (relative to your application root) to the `--watch` flag.
191-
192-
```bash
193-
pest --watch=app,routes,tests
194-
```
195-
196-
By default, the output is not colored, as watch mode starts a new process, so Pest doesn't know it's running in a Terminal. To force Pest's output to be colored, you can use the `--colors` flag.
197-
198-
```bash
199-
pest --watch --colors=always
200-
```
201-
202-
---
203-
204162
In this section, we have seen how plugins can enhance your Pest experience. Now, let's see how you can manage your team's tasks and responsibilities using Pest: [Team Management](/docs/team-management)

why-pest.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In addition to its exceptional test reporting, Pest also offers a range of other
3535
- [Coverage](/docs/test-coverage) report directly on the terminal to track code coverage
3636
- [Mutation Testing](#mutation-testing) to evaluate the quality of your test suite
3737
- [Team Management](/docs/team-management) to manage tasks / todos with your team
38-
- Dozens of [optional plugins](/docs/plugins), such as Watch Mode and [Snapshot testing](https://github.com/spatie/pest-plugin-snapshots), to customize Pest to fit your needs.
38+
- Dozens of [optional plugins](/docs/plugins), such as [Snapshot testing](https://github.com/spatie/pest-plugin-snapshots), to customize Pest to fit your needs.
3939

4040
Whether you're engaged in a small personal project or a large-scale enterprise application, Pest has got you covered. So if you want to make the testing process enjoyable and efficient, give Pest a try. We're confident that you'll love it as much as we do.
4141

0 commit comments

Comments
 (0)