feat: add a warning when multiple config files found

Closes #299

Author: sheremet-va

package.json

@@ -71,6 +71,12 @@
           "type": "string",
           "scope": "window"
         },
+        "vitest.disableWorkspaceNotification": {
+          "description": "Disable workspace notification.",
+          "type": "boolean",
+          "default": false,
+          "scope": "window"
+        },
         "vitest.debugExclude": {
           "markdownDescription": "Automatically skip files covered by these glob patterns. \nDefault: `[\"<node_internals>/**\", \"**/node_modules/**\"]`",
           "type": "array",

src/api.ts

@@ -1,7 +1,7 @@
 import type { ChildProcess } from 'node:child_process'
 import { fork } from 'node:child_process'
 import { gte } from 'semver'
-import { dirname, normalize } from 'pathe'
+import { basename, dirname, normalize } from 'pathe'
 import * as vscode from 'vscode'
 import { log } from './log'
 import { configGlob, minimumVersion, workerPath, workspaceGlob } from './constants'
@@ -79,7 +79,10 @@ export class VitestAPI {
 
   async dispose() {
     this.forEach(api => api.dispose())
-    await this.meta.rpc.close()
+    try {
+      await this.meta.rpc.close()
+    }
+    catch {}
     this.meta.process.kill()
   }
 }
@@ -166,7 +169,7 @@ function nonNullable<T>(value: T | null | undefined): value is T {
   return value != null
 }
 
-interface VitestMeta {
+export interface VitestMeta {
   folder: vscode.WorkspaceFolder
   vitestNodePath: string
   // path to a config file or a workspace config file
@@ -184,7 +187,7 @@ function resolveVitestConfig(showWarning: boolean, configOrWorkspaceFile: vscode
 
   if (!vitest) {
     if (showWarning)
-      vscode.window.showWarningMessage('Vitest not found. Please run `npm i --save-dev vitest` to install Vitest.')
+      vscode.window.showWarningMessage(`Vitest not found in "${basename(dirname(configOrWorkspaceFile.fsPath))}" folder. Please run \`npm i --save-dev vitest\` to install Vitest.'`)
     log.error('[API]', `Vitest not found for ${configOrWorkspaceFile}.`)
     return null
   }

src/config.ts

@@ -35,5 +35,6 @@ export function getConfig(workspaceFolder?: WorkspaceFolder | vscode.Uri | strin
     debugExclude: get<string[]>('debugExclude', []),
     packagePath: get<string | undefined>('packagePath'),
     nodeExecutable: get<string | undefined>('nodeExecutable'),
+    disableWorkspaceNotification: get<boolean>('disableWorkspaceNotification', false),
   }
 }

src/extension.ts

@@ -1,13 +1,14 @@
 import { sep } from 'node:path'
 import * as vscode from 'vscode'
 import { basename, dirname } from 'pathe'
-import { testControllerId } from './config'
+import { getConfig, testControllerId } from './config'
 import type { VitestAPI } from './api'
 import { resolveVitestAPI, resolveVitestPackages } from './api'
 import { TestRunner } from './runner/runner'
 import { TestTree } from './testTree'
 import { configGlob, workspaceGlob } from './constants'
 import { log } from './log'
+import { createVitestWorkspaceFile, noop } from './utils'
 
 export async function activate(context: vscode.ExtensionContext) {
   const extension = new VitestExtension()
@@ -52,6 +53,26 @@ class VitestExtension {
       return
     }
 
+    const configFiles = vitest.filter(x => x.configFile)
+
+    if (configFiles.length > 3 && getConfig().disableWorkspaceNotification !== true) {
+      vscode.window.showWarningMessage(
+        `Vitest found ${configFiles.length} config files. For better performance, consider using a workspace configuration.`,
+        'Create vitest.workspace.js',
+        'Disable notification',
+      ).then((result) => {
+        if (!result)
+          return
+        if (result === 'Create vitest.workspace.js')
+          createVitestWorkspaceFile(configFiles).catch(noop)
+
+        if (result === 'Disable notification') {
+          const rootConfig = vscode.workspace.getConfiguration('vitest')
+          rootConfig.update('disableWorkspaceNotification', true)
+        }
+      })
+    }
+
     const folders = new Set(vitest.map(x => x.folder))
     this.testTree.reset(Array.from(folders))
 
@@ -128,7 +149,7 @@ class VitestExtension {
     this.disposables = [
       vscode.workspace.onDidChangeWorkspaceFolders(() => this.defineTestProfiles(false)),
       vscode.workspace.onDidChangeConfiguration((event) => {
-        if (event.affectsConfiguration('vitest'))
+        if (event.affectsConfiguration('vitest.packagePath') || event.affectsConfiguration('vitest.nodeExecutable'))
           this.defineTestProfiles(false)
       }),
     ]

src/utils.ts

@@ -0,0 +1,31 @@
+import * as vscode from 'vscode'
+import { relative } from 'pathe'
+import type { VitestMeta } from './api'
+
+export function noop() {}
+
+export async function createVitestWorkspaceFile(vitest: VitestMeta[]) {
+  const folders = new Set(vitest.map(x => x.folder))
+  const encoder = new TextEncoder()
+  const promises = [...folders].map(async (folder) => {
+    const workspaceFileUri = vscode.Uri.joinPath(folder.uri, 'vitest.workspace.js')
+    const configFiles = vitest.filter(x => x.folder === folder).map(x => relative(folder.uri.fsPath, x.configFile!))
+
+    const workspaceContent = `
+import { defineWorkspace } from 'vitest/config'
+
+export default defineWorkspace([
+  ${configFiles.map(file => `"./${file}"`).join(',\n  ')}
+])
+`.trimStart()
+
+    await vscode.workspace.fs.writeFile(workspaceFileUri, encoder.encode(workspaceContent))
+    return await vscode.workspace.openTextDocument(workspaceFileUri)
+  })
+
+  const results = await Promise.all(promises)
+  if (results[0])
+    await vscode.window.showTextDocument(results[0])
+
+  await vscode.window.showInformationMessage('Created vitest.workspace.js. You might need to run \`npm i --save-dev vitest\` in the root folder to install Vitest.')
+}