docs: update cli docs (#2159)

.gitignore

@@ -19,6 +19,9 @@ bench/test/*/*/
 cypress/videos
 cypress/downloads
 cypress/screenshots
+packages/ui/cypress/videos
+packages/ui/cypress/downloads
+packages/ui/cypress/screenshots
 docs/public/user-avatars
 docs/public/sponsors
 .eslintcache

docs/guide/cli.md

@@ -76,6 +76,8 @@ vitest related /src/index.ts /src/hello-world.js
 | `--shard <shard>` | Execute tests in a specified shard |
 | `--sequence` | Define in what order to run tests. Use [cac's dot notation] to specify options (for example, use `--sequence.shuffle` to run tests in random order) |
 | `--no-color` | Removes colors from the console output |
+| `--inspect` | Enables Node.js inspector |
+| `--inspect-brk` | Enables Node.js inspector with break |
 | `-h, --help` | Display available CLI options |
 
 ### changed

packages/ui/client/components/dashboard/DashboardEntry.vue

@@ -12,7 +12,7 @@ withDefaults(defineProps<{ tail?: boolean }>(), { tail: false })
         <slot name="header" />
       </div>
     </div>
-<!--
+    <!--
     <div v-if="!tail" data-testid="tail" my-0 op50 w-2px bg-current origin-center rotate-0 translate-x-3 />
 -->
   </div>

packages/ui/client/composables/module-graph.ts

@@ -1,6 +1,6 @@
 import type { Graph, GraphConfig, GraphController, GraphLink, GraphNode } from 'd3-graph-controller'
 import { defineGraph, defineLink, defineNode } from 'd3-graph-controller'
-import type { ModuleGraphData } from '../../../vitest/src/types'
+import type { ModuleGraphData } from 'vitest/src/types'
 
 export type ModuleType = 'external' | 'inline'
 export type ModuleNode = GraphNode<ModuleType>

packages/ui/index.html

@@ -21,4 +21,4 @@
     <div id="app"></div>
     <script type="module" src="/client/main.ts"></script>
   </body>
-</html>
+</html>

packages/vitest/src/node/cli.ts

@@ -71,28 +71,28 @@ cli
 
 cli.parse()
 
-async function runRelated(relatedFiles: string[] | string, argv: CliOptions) {
+async function runRelated(relatedFiles: string[] | string, argv: CliOptions): Promise<void> {
   argv.related = relatedFiles
   argv.passWithNoTests ??= true
   await start('test', [], argv)
 }
 
-async function watch(cliFilters: string[], options: CliOptions) {
+async function watch(cliFilters: string[], options: CliOptions): Promise<void> {
   options.watch = true
   await start('test', cliFilters, options)
 }
 
-async function run(cliFilters: string[], options: CliOptions) {
+async function run(cliFilters: string[], options: CliOptions): Promise<void> {
   options.run = true
   await start('test', cliFilters, options)
 }
 
-async function benchmark(cliFilters: string[], options: CliOptions) {
+async function benchmark(cliFilters: string[], options: CliOptions): Promise<void> {
   console.warn(c.yellow('Benchmarking is an experimental feature.\nBreaking changes might not follow semver, please pin Vitest\'s version when using it.'))
   await start('benchmark', cliFilters, options)
 }
 
-async function start(mode: VitestRunMode, cliFilters: string[], options: CliOptions) {
+async function start(mode: VitestRunMode, cliFilters: string[], options: CliOptions): Promise<void> {
   try {
     if (await startVitest(mode, cliFilters, options) === false)
       process.exit()