dev: adapt to vitest@1.2 (#213)

* dev: adapt to vitest@1.2.0

* a

* fix import error

* revert vitest version to latest

* bump vitest to 1.2.2

* treat 'custom' task as 'test'

package.json

@@ -155,8 +155,8 @@
   },
   "scripts": {
     "vscode:prepublish": "yarn run compile",
-    "compile": "tsup ./src/extension.ts --external vscode --minify",
-    "watch": "tsup ./src/extension.ts --external vscode --watch --sourcemap",
+    "compile": "tsup ./src/extension.ts --external vscode,lightningcss,esbuild --minify",
+    "watch": "tsup ./src/extension.ts --external vscode,lightningcss,esbuild --watch --sourcemap",
     "test": "vitest run",
     "lint": "eslint .",
     "lint:fix": "eslint . --fix"
@@ -172,10 +172,10 @@
     "@types/node": "^18.11.18",
     "@types/semver": "^7.3.9",
     "@types/vscode": "^1.77.0",
-    "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "^5.12.1",
-    "@typescript-eslint/parser": "^5.12.1",
-    "@vitest/ws-client": "^0.12.6",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^6.19.0",
+    "@typescript-eslint/parser": "^6.19.0",
+    "@vitest/ws-client": "^1.2.0",
     "@vscode/test-electron": "^2.1.2",
     "@vue/reactivity": "^3.2.33",
     "@vueuse/core": "^8.4.2",
@@ -190,11 +190,10 @@
     "prettier": "^2.5.1",
     "semver": "^7.3.5",
     "tree-kill": "^1.2.2",
-    "tsup": "^5.12.7",
-    "typescript": "^4.9.5",
-    "vite": "^2.8.6",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
     "vitest": "latest",
-    "ws": "^8.6.0"
+    "ws": "^8.16.0"
   },
   "lint-staged": {
     "*.{js,ts,tsx,vue,md}": [

src/config.ts

@@ -2,12 +2,22 @@ import * as vscode from 'vscode'
 import semver from 'semver'
 import type { WorkspaceConfiguration, WorkspaceFolder } from 'vscode'
 import type { ResolvedConfig } from 'vitest'
-import { configDefaults } from 'vitest/config'
 import { isDefinitelyVitestEnv, mayBeVitestEnv } from './pure/isVitestEnv'
 import { getVitestCommand, getVitestVersion, isNodeAvailable } from './pure/utils'
 import { log } from './log'
 export const extensionId = 'zxch3n.vitest-explorer'
 
+// Copied from https://github.com/vitest-dev/vitest/blob/main/packages/vitest/src/defaults.ts
+// "import { configDefaults } from 'vitest'" throws unexpected URL error
+const defaultInclude = ['**/*.{test,spec}.?(c|m)[jt]s?(x)']
+const defaultExclude = [
+  '**/node_modules/**',
+  '**/dist/**',
+  '**/cypress/**',
+  '**/.{idea,git,cache,output,temp}/**',
+  '**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build,eslint,prettier}.config.*',
+]
+
 export function getConfigValue<T>(
   rootConfig: WorkspaceConfiguration,
   folderConfig: WorkspaceConfiguration,
@@ -42,8 +52,8 @@ export function getConfig(workspaceFolder?: WorkspaceFolder | vscode.Uri | strin
 export function getCombinedConfig(config: ResolvedConfig, workspaceFolder?: WorkspaceFolder | vscode.Uri | string) {
   const vitestConfig = getConfig(workspaceFolder)
   return {
-    exclude: vitestConfig.exclude?.concat(config.exclude) || configDefaults.exclude,
-    include: vitestConfig.include?.concat(config.include) || configDefaults.include,
+    exclude: vitestConfig.exclude?.concat(config.exclude) || defaultExclude,
+    include: vitestConfig.include?.concat(config.include) || defaultInclude,
   }
 }
 

src/discover.ts

@@ -113,7 +113,6 @@ export class TestFileDiscoverer extends vscode.Disposable {
             workspaceFolder.uri,
             include,
           )
-          const workspacePath = workspaceFolder.uri.fsPath
           const filter = (v: vscode.Uri) =>
             exclude.every(x => !minimatch(path.relative(workspacePath, v.fsPath), x, { dot: true }))
 

src/pure/ApiProcess.ts

@@ -74,7 +74,7 @@ export class ApiProcess {
 
     log.info('Start api process at port', port)
     log.info('[RUN]', `${this.vitest.cmd} ${this.vitest.args.join(' ')}`)
-    const cwd = sanitizeFilePath(this.workspace, false)
+    const cwd = sanitizeFilePath(this.workspace)
     log.info('[RUN.cwd]', cwd)
 
     const logs = [] as string[]

src/pure/isVitestEnv.ts

@@ -1,5 +1,5 @@
 import { existsSync } from 'fs'
-import path = require('path')
+import path from 'node:path'
 import { readFile, readdir } from 'fs-extra'
 import type { WorkspaceFolder } from 'vscode'
 import { getVitestPath } from './utils'

src/pure/runner.ts

@@ -75,7 +75,7 @@ export class TestRunner {
     const command = vitestCommand.cmd
     const args = [
       ...vitestCommand.args,
-      ...(testFile ? testFile.map(f => sanitizeFilePath(f, true)) : []),
+      ...(testFile ? testFile.map(f => sanitizeFilePath(f)) : []),
     ] as string[]
     if (updateSnapshot)
       args.push('--update')
@@ -90,11 +90,11 @@ export class TestRunner {
         args.push('-t', testNamePattern.replace(/[$^+?()[\]"]/g, '\\$&'))
     }
 
-    const workspacePath = sanitizeFilePath(this.workspacePath, false)
+    const workspacePath = sanitizeFilePath(this.workspacePath)
     const outputs: string[] = []
     const env = { ...process.env, ...workspaceEnv }
     let testResultFiles = [] as File[]
-    const output = await runVitestWithApi({ cmd: sanitizeFilePath(command, false), args }, this.workspacePath, {
+    const output = await runVitestWithApi({ cmd: sanitizeFilePath(command), args }, this.workspacePath, {
       log: (line) => {
         log.info(`${filterColorFormatOutput(line.trimEnd())}\r\n`)
         outputs.push(filterColorFormatOutput(line))

src/pure/utils.ts

@@ -18,14 +18,13 @@ export function getVitestPath(projectRoot: string): string | undefined {
     return
 
   if (existsSync(path.resolve(node_modules, 'vitest', 'vitest.mjs')))
-    return sanitizeFilePath(path.resolve(node_modules, 'vitest', 'vitest.mjs'), false)
+    return sanitizeFilePath(path.resolve(node_modules, 'vitest', 'vitest.mjs'))
 
   const suffixes = ['.js', '', '.cmd']
   for (const suffix of suffixes) {
     if (existsSync(path.resolve(node_modules, '.bin', `vitest${suffix}`))) {
       return sanitizeFilePath(
         path.resolve(node_modules, '.bin', `vitest${suffix}`),
-        false,
       )
     }
   }
@@ -64,7 +63,7 @@ export function getVitestCommand(
       return {
         cmd: 'node',
         args: [
-          sanitizeFilePath(path.resolve(node_modules, 'vitest', 'vitest.mjs'), false),
+          sanitizeFilePath(path.resolve(node_modules, 'vitest', 'vitest.mjs')),
         ],
       }
     }
@@ -176,9 +175,8 @@ const capitalizeDriveLetter = (path: string) => {
 const replaceDoubleSlashes = (string: string) => string.replace(/\\/g, '/')
 
 export function sanitizeFilePath(path: string) {
-  if (isWindows) {
+  if (isWindows)
     return replaceDoubleSlashes(capitalizeDriveLetter(path))
-  }
 
   return path
 }

src/pure/watch/client.ts

@@ -1,6 +1,6 @@
 import WebSocket from 'ws'
 import { computed, effect, reactive, ref, shallowRef } from '@vue/reactivity'
-import type { ResolvedConfig, Task, TaskResult, WebSocketEvents } from 'vitest'
+import type { ResolvedConfig, Task, TaskResultPack, WebSocketEvents } from 'vitest'
 import { log } from '../../log'
 import { createClient } from './ws-client'
 
@@ -64,14 +64,14 @@ export function buildWatchClient(
   // otherwise those record will not be recorded to client.state
   const loadingPromise = client.waitForConnection().then(async () => {
     const files = await client.rpc.getFiles()
-    const idResultPairs: [string, TaskResult][] = []
+    const idResultPairs: TaskResultPack[] = []
     let isRunning = files.length === 0
     files && travel(files)
     function travel(tasks: Task[]) {
       for (const task of tasks) {
-        if (task.type === 'test') {
+        if (task.type === 'test' || task.type === 'custom') {
           if (task.result)
-            idResultPairs.push([task.id, task.result])
+            idResultPairs.push([task.id, task.result, task.meta])
           else if (task.mode === 'run')
             isRunning = true
         }

src/pure/watch/vitestConfig.ts

@@ -31,19 +31,19 @@ async function connectAndFetchConfig(
       if (!handled.has(ws)) {
         handled.add(ws)
         ws.addEventListener('open', () => {
-          log.info('WS Opened')
+          log.info('pure/WS Opened')
           client.rpc.getConfig().then((_config) => {
             client.dispose()
             resolve(_config)
           })
         })
 
         ws.addEventListener('error', (e) => {
-          console.error('WS ERROR', e)
+          console.error('pure/WS ERROR ', e)
         })
 
         ws.addEventListener('close', () => {
-          log.info('WS Close')
+          log.info('pure/WS Close')
         })
       }
     })

src/pure/watch/ws-client.ts

@@ -99,7 +99,7 @@ export interface VitestClientOptions {
 export interface VitestClient {
   ws: WebSocket
   state: StateManager
-  rpc: BirpcReturn<WebSocketHandlers>
+  rpc: BirpcReturn<WebSocketHandlers, WebSocketEvents>
   waitForConnection(): Promise<void>
   reconnect(): Promise<void>
   dispose(): void
@@ -138,6 +138,9 @@ export function createClient(url: string, options: VitestClientOptions = {}) {
         ctx.state.collectFiles(files)
         handlers.onCollected?.(files)
       },
+      onCancel(reason) {
+        handlers.onCancel?.(reason)
+      },
       onTaskUpdate(packs) {
         ctx.state.updateTasks(packs)
         handlers.onTaskUpdate?.(packs)

src/watch.ts

@@ -281,14 +281,6 @@ export class TestWatcher extends Disposable {
 }
 
 function getSourceFilepathAndLocationFromStack(stack: ParsedStack): { sourceFilepath?: string; line: number; column: number } {
-  if (stack.sourcePos) {
-    return {
-      sourceFilepath: stack.sourcePos.source?.replace(/\//g, path.sep),
-      line: stack.sourcePos.line,
-      column: stack.sourcePos.column,
-    }
-  }
-
   return {
     sourceFilepath: stack.file.replace(/\//g, path.sep),
     line: stack.line,
@@ -362,8 +354,8 @@ export function syncTestStatusToVsCode(
   ) {
     const set = new Set(vscode)
     for (const task of vitest) {
-      const data = matchTask(task, set, task.type)
-      if (task.type === 'test') {
+      const data = matchTask(task, set)
+      if (task.type === 'test' || task.type === 'custom') {
         if (task.result == null) {
           if (finished) {
             finishedTest && finishedTest.add(data.item)
@@ -385,7 +377,7 @@ export function syncTestStatusToVsCode(
             case 'fail':
               run.failed(
                 data.item,
-                testMessageForTestError(data.item, task.result.error),
+                task.result.errors?.map(i => testMessageForTestError(data.item, i)) ?? [],
                 task.result.duration,
               )
               finishedTest && finishedTest.add(data.item)
@@ -414,14 +406,13 @@ export function syncTestStatusToVsCode(
   function matchTask(
     task: Task,
     candidates: Set<TestDescribe | TestCase>,
-    type: 'suite' | 'test',
   ): TestDescribe | TestCase {
     let ans: (TestDescribe | TestCase) | undefined
     for (const candidate of candidates) {
-      if (type === 'suite' && !(candidate instanceof TestDescribe))
+      if (task.type === 'suite' && !(candidate instanceof TestDescribe))
         continue
 
-      if (type === 'test' && !(candidate instanceof TestCase))
+      if ((task.type === 'test' || task.type==='custom') && !(candidate instanceof TestCase))
         continue
 
       if (candidate.pattern === task.name) {

tsconfig.json

@@ -7,6 +7,7 @@
     "sourceMap": true,
     "rootDir": "src",
     "esModuleInterop": true,
+    "skipLibCheck": true,
     "strict": true /* enable all strict type-checking options */
     /* Additional Checks */
     // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */