Allow to interrupt test running in watch mode

[sethreidnz]

Clear and concise description of the problem

Currently if I have thousands of tests to run and want to use the watch feature to filter only say one test, or test file, then I have to wait until the entire test suite runs to then press "h" and do that. This takes a lot of time and also is different to how Jest works where you can interrupt the test running and do filtering.

Suggested solution

Pressing enter, or any of the keys like "h" or whatever should interrupt the current run. That way I could start the watch, press enter, then start filtering to the tests I care about. This is how Jest works and it would be great if Vite did similar.

Alternative

No response

Additional context

No response

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[AriPerkkio]

This should already be implemented by #3163. When you press c, space or any other key that Vitest registers in watch mode, the test run should be interrupted. Exactly as in Jest.

The h key is not used by Vitest at all.

vitest/packages/vitest/src/node/stdin.ts

Lines 7 to 16 in 1e8760a

	const keys = [
	[['a', 'return'], 'rerun all tests'],
	['r', 'rerun current pattern tests'],
	['f', 'rerun only failed tests'],
	['u', 'update snapshot'],
	['p', 'filter by a filename'],
	['t', 'filter by a test name regex pattern'],
	['q', 'quit'],
	]
	const cancelKeys = ['space', 'c', ...keys.map(key => key[0]).flat()]

vitest/packages/vitest/src/node/stdin.ts

Lines 50 to 54 in 1e8760a

	if (ctx.runningPromise) {
	if (cancelKeys.includes(name))
	await ctx.cancelCurrentRun('keyboard-input')
	return
	}

[sethreidnz]

This should already be implemented by #3163. When you press c, space or any other key that Vitest registers in watch mode, the test run should be interrupted. Exactly as in Jest.

The h key is not used by Vitest at all.

vitest/packages/vitest/src/node/stdin.ts

Lines 7 to 16 in 1e8760a

	const keys = [
	[['a', 'return'], 'rerun all tests'],
	['r', 'rerun current pattern tests'],
	['f', 'rerun only failed tests'],
	['u', 'update snapshot'],
	['p', 'filter by a filename'],
	['t', 'filter by a test name regex pattern'],
	['q', 'quit'],
	]
	const cancelKeys = ['space', 'c', ...keys.map(key => key[0]).flat()]

vitest/packages/vitest/src/node/stdin.ts

Lines 50 to 54 in 1e8760a

	if (ctx.runningPromise) {
	if (cancelKeys.includes(name))
	await ctx.cancelCurrentRun('keyboard-input')
	return
	}

Oh cool. Will have to see when at the computer when I get there if we are on an older version but wasn’t working for me today and very recently migrated. Although that PR looks like it’s pretty newly merged so maybe I’m not on that version.

And yeah it does use “h” it’s what it says at the end when you’ve finished running tests. Something like press “h” for help.

[AriPerkkio]

it does use “h” it’s what it says at the end when you’ve finished running tests

Oh right, sorry, you are correct. The #3618 adds h key for cancelling watch mode too.