mirror of
https://github.com/vuejs/vue-cli.git
synced 2026-02-06 06:58:28 -06:00
48 lines
1.9 KiB
Markdown
48 lines
1.9 KiB
Markdown
# @vue/cli-plugin-e2e-cypress
|
|
|
|
> e2e-cypress plugin for vue-cli
|
|
|
|
This adds E2E testing support using [Cypress](https://www.cypress.io/).
|
|
|
|
Cypress offers a rich interactive interface for running E2E tests, but currently only supports running the tests in Chromium. If you have a hard requirement on E2E testing in multiple browsers, consider using the Selenium-based [@vue/cli-plugin-e2e-nightwatch](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-e2e-nightwatch).
|
|
|
|
## Injected Commands
|
|
|
|
- **`vue-cli-service e2e`**
|
|
|
|
run e2e tests headlessly with `cypress run`.
|
|
|
|
Options:
|
|
|
|
```
|
|
--url run e2e tests against given url instead of auto-starting dev server
|
|
-s, --spec runs a specific spec file. defaults to "all"
|
|
```
|
|
|
|
Additionally, [all Cypress CLI options for `cypress run` are also supported](https://docs.cypress.io/guides/guides/command-line.html#cypress-run).
|
|
|
|
- **`vue-cli-service e2e:open`**
|
|
|
|
run e2e tests in interactive mode with `cypress open`.
|
|
|
|
Options:
|
|
|
|
```
|
|
--url run e2e tests against given url instead of auto-starting dev server
|
|
```
|
|
|
|
Additionally, [all Cypress CLI options for `cypress open` are also supported](https://docs.cypress.io/guides/guides/command-line.html#cypress-open).
|
|
|
|
Both commands automatically starts a server in production mode to run the e2e tests against. If you want to run the tests multiple times without having to restart the server every time, you can start the server with `vue-cli-service serve --mode production` in one terminal, and then run e2e tests against that server using the `--url` option.
|
|
|
|
## Configuration
|
|
|
|
We've pre-configured Cypress to place most of the e2e testing related files under `<projectRoot>/tests/e2e`. You can also check out [how to configure Cypress via `cypress.json`](https://docs.cypress.io/guides/references/configuration.html#Options).
|
|
|
|
## Installing in an Already Created Project
|
|
|
|
``` sh
|
|
npm install -D @vue/cli-plugin-e2e-cypress
|
|
vue invoke e2e-cypress
|
|
```
|