onConsoleLog should be typed false | undefined or boolean | undefined

[ST-DDT]

Clear and concise description of the problem

According to @bradzacher in typescript-eslint/typescript-eslint#8576 (comment) the current typing of the method is flawed. As the current void part of the method would indicate that you shouldn't care about the result.

Suggested solution

Change the return signature of onConsoleLog to false | undefined or boolean | undefined.

The later variant especially would allow for ternaries or simple return expressions like:

onConsoleLog(type) {
  return type != 'stderr';
}

Alternative

No response

Additional context

https://vitest.dev/config/#onconsolelog

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.

[hi-ogawa]

Good point. I don't think restricting it to false makes much sense. Probably it was just a small oversight and the similar one just below already have boolean | void, so probably we can do the same for onConsoleLog.

vitest/packages/vitest/src/types/config.ts

Lines 583 to 591 in a14b648

	onConsoleLog?: (log: string, type: 'stdout' | 'stderr') => false | void
	/**
	* Enable stack trace filtering. If absent, all stack trace frames
	* will be shown.
	*
	* Return `false` to omit the frame.
	*/
	onStackTrace?: (error: Error, frame: ParsedStack) => boolean | void