Skip to content

Commit dfd6bd5

Browse files
Documenting installation of hoa/console
Documenting installation of hoa/console - see Codeception/Codeception#5971
1 parent ca0ac91 commit dfd6bd5

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

docs/02-GettingStarted.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,16 @@ Learn more about the [Cest format](http://codeception.com/docs/07-AdvancedUsage#
270270
It's hard to write a complete test at once.
271271
You will need to try different commands with different arguments before you find a correct path.
272272

273-
Since Codeception 3.0 you can pause execution in any point and enter interactive shell where you will be able to try commands in action.
274-
All you need to do is to **call `$I->pause()` in debug mode**.
273+
Since Codeception 3.0 you can pause the execution at any point and enter an interactive shell where you will be able to try different commands in action.
274+
All you need to do is **call `$I->pause()`** somewhere in your test, then run the test in [debug mode](#Debugging).
275+
276+
Interactive Pause requires [`hoa/console`](https://hoa-project.net/) which is not installed by default. To install it, run:
277+
278+
{% highlight bash %}
279+
280+
php composer.phar require --dev hoa/console
281+
282+
{% endhighlight %}
275283

276284
{% highlight php %}
277285

@@ -281,15 +289,15 @@ $I->pause();
281289

282290
{% endhighlight %}
283291

284-
When a test gets to this point it stops and shows a console where you can try all available commands.
292+
The execution of the test is stopped at this point, and a console is shown where you can try all available commands "live".
285293
This can be very useful when you write functional, acceptance, or api test.
286294

287295
![](https://user-images.githubusercontent.com/220264/54929617-875ad180-4f1e-11e9-8fea-fc1b02423050.gif)
288296

289-
Inside interactive pause you can use all power of PHP interpreter. Use variables, functions, etc.
290-
Result of the last executed command (usually a grabber) is saved to `$result` variable, so you can use it in next commands.
297+
Inside Interactive Pause you can use the entire power of the PHP interpreter: variables, functions, etc.
298+
You can access the result of the last executed command in a variable called `$result`.
291299

292-
Inside acceptance or functional test you can save page screenshot or html snapshot to check the page you are working on.
300+
In acceptance or functional test you can save page screenshot or html snapshot.
293301

294302
{% highlight php %}
295303

0 commit comments

Comments
 (0)