From d03bc300f1c3f4001fc849942bacfee117d37e4c Mon Sep 17 00:00:00 2001 From: Anjorin Damilare Date: Mon, 21 Feb 2022 06:18:55 +0100 Subject: [PATCH] docs: add globals to cli info (#816) --- docs/guide/index.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/guide/index.md b/docs/guide/index.md index 2b48ce278903..361005fa2eb3 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -101,21 +101,22 @@ You can specify additional CLI options like `--port` or `--https`. For a full li | `-r, --root ` | Define the project root | | `-c, --config ` | Path to config file | | `-u, --update` | Update snapshots | -| `-w, --watch` | Watch mode | +| `-w, --watch` | Smart & instant watch mode | | `-t, --testNamePattern ` | Run tests with names matching the pattern | | `--ui` | Enable UI | -| `--open` | Open the UI automatically if enabled (default: true) | +| `--open` | Open the UI automatically if enabled (default: `true`) | | `--api [api]` | Serve API, available options: `--api.port `, `--api.host [host]` and `--api.strictPort` | -| `--threads` | Enable Threads (default: true) | +| `--threads` | Enable Threads (default: `true`) | | `--silent` | Silent console output from tests | | `--reporter ` | Select reporter: `default`, `verbose`, `dot` or `json` | | `--outputFile ` | Write test results to a file when the `--reporter=json` option is also specified | | `--coverage` | Use c8 for coverage | | `--run` | Do not watch | | `--mode` | Override Vite mode (default: `test`) | -| `--global` | Inject APIs globally | +| `--global` | Inject APIs globally `depreciated` use `--globals` | +| `--globals` | Inject APIs globally | | `--dom` | Mock browser api with happy-dom | -| `--environment ` | Runner environment (default: node) | +| `--environment ` | Runner environment (default: `node`) | | `--passWithNoTests` | Pass when no tests found | | `--allowOnly` | Allow tests and suites that are marked as `only` (default: false in CI, true otherwise) | | `-h, --help` | Display available CLI options |