fix(gatsby,gatsby-cli): Correct behavior for reporter.error with pluginName

[LekoArts]

Description

Passing the Error object to e.g. reporter.panic (or all reporter.error invocations really) wasn't working as intended. It always showed the "There was an error" generic error.

The culprit is that

gatsby/packages/gatsby/src/utils/api-runner-node.js

Lines 178 to 189 in 9429b3b

	const addPluginNameToErrorMeta = (errorMeta, pluginName) =>
	typeof errorMeta === `string`
	? {
	context: {
	sourceMessage: errorMeta,
	},
	pluginName,
	}
	: {
	...errorMeta,
	pluginName,
	}

was added but doesn't handle all the cases that

gatsby/packages/gatsby-cli/src/reporter/reporter.ts

Lines 106 to 109 in 3db77a5

	error = (
	errorMeta: ErrorMeta | Array<ErrorMeta>,
	error?: Error | Array<Error>
	): IStructuredError | Array<IStructuredError> => {

does handle.

So instead of repeating the code and possibly diverge in the future, pluginName is now passed as an optional third param.

I've also updated the default catch-all error to be more helpful and added tests to show that correct behavior.

Documentation

The API docs for now will still promote reporter.panic('text', new Error('text'))

Related Issues

[ch27056]