Problem/Motivation

There are many helpful commands in the core/tests/README.md, like

brew install selenium-server-standalone
brew install chromedriver

and

export MINK_DRIVER_ARGS_WEBDRIVER='["chrome", null, "http://localhost:4444/wd/hub"]'
./vendor/bin/phpunit -c core --testsuite functional-javascript

Additionally, 90% of the command examples re-include the ./vendor/bin/phpunit part.
At first glance, it's not clear if that's on the same line as the needed command (it's not) or if it is required to run alongside the export commands (it's not).
And as it does not include trailing semicolons, pasting the block will not work

Proposed resolution

Add trailing semicolons to commands that should be run together and are on different lines
Consider removing the redundant ./vendor/bin/phpunit portions from the set-up commands.

Remaining tasks

N/A

User interface changes

N/A

API changes

N/A

Data model changes

N/A

Comments

tim.plunkett created an issue. See original summary.

volkswagenchick’s picture

Issue tags: +fldc19, +sfdug, +dcnj19

Tagging for upcoming contribution days.

dawehner’s picture

Issue tags: +Novice
msankhala’s picture

I agree with adding the semicolon at the end of commands but I think it is fine if we keep `./vendor/bin/phpunit` part of the command instead of changing it to just `phpunit` because this is the correct path of the phpunit after you run `composer install`.

msankhala’s picture

Status: Active » Needs review
StatusFileSize
new3.11 KB

Here is the patch.

tim.plunkett’s picture

Status: Needs review » Reviewed & tested by the community

Looks great! I agree with not removing ./vendor/bin, not sure why I suggested that.

alexpott’s picture

Status: Reviewed & tested by the community » Fixed

Committed and pushed 93e12b09c9 to 8.7.x and b1a183acc0 to 8.6.x. Thanks!

Crediting @tim.plunkett for filing the issue.

As a docs fix backported to 8.6.x

  • alexpott committed 93e12b0 on 8.7.x
    Issue #2995150 by msankhala, tim.plunkett: Command examples in core/...

  • alexpott committed b1a183a on 8.6.x
    Issue #2995150 by msankhala, tim.plunkett: Command examples in core/...

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.