feat(cli): add --no-open option (#635)

vitest-dev · Jan 26, 2022 · a2013a5 · a2013a5
1 parent aaa6df4
commit a2013a5
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -103,7 +103,8 @@ You can specify additional CLI options like `--port` or `--https`. For a full li
 | `-u, --update` | Update snapshots |
 | `-w, --watch` | Watch mode |
 | `-t, --testNamePattern <pattern>` | Run tests with names matching the pattern |
-| `--ui` | Open UI |
+| `--ui` | Enable UI |
+| `--open` | Open the UI automatically if enabled (default: true) |
 | `--api [api]` | Serve API, available options: `--api.port <port>`, `--api.host [host]` and `--api.strictPort` |
 | `--threads` | Enable Threads (default: true) |
 | `--silent` | Silent console output from tests |

diff --git a/packages/vitest/src/node/cli.ts b/packages/vitest/src/node/cli.ts
@@ -14,7 +14,8 @@ cli
  .option('-u, --update', 'update snapshot')
  .option('-w, --watch', 'watch mode')
  .option('-t, --testNamePattern <pattern>', 'run test names with the specified pattern')
- .option('--ui', 'open UI')
+ .option('--ui', 'enable UI')
+ .option('--open', 'open UI automatically', { default: true })
  .option('--api [api]', 'serve API, available options: --api.port <port>, --api.host [host] and --api.strictPort')
  .option('--threads', 'enabled threads', { default: true })
  .option('--silent', 'silent console output from tests')

diff --git a/packages/vitest/src/node/plugins/index.ts b/packages/vitest/src/node/plugins/index.ts
@@ -30,7 +30,7 @@ export async function VitestPlugin(options: UserConfig = {}, viteOverrides: Vite
  },
  server: {
  ...options.api,
- open: options.ui
+ open: options.ui && options.open
  ? options.uiBase ?? '/__vitest__/'
  : undefined,
  preTransformRequests: false,

diff --git a/packages/vitest/src/types/config.ts b/packages/vitest/src/types/config.ts
@@ -232,11 +232,18 @@ export interface InlineConfig {
  api?: boolean | number | ApiConfig
 
  /**
- * Open Vitest UI
+ * Enable Vitest UI
  * @internal WIP
  */
  ui?: boolean
 
+ /**
+ * Open UI automatically.
+ *
+ * @default true
+ */
+ open?: boolean
+
  /**
  * Base url for the UI
  *