fix(gatsby-remark-images): allow tracedSVG to accept object with settings

[pieh]

Description

Currently plugin validation schema only supports true/false, but plugin does support setting detailed settings with object notation too -

gatsby/packages/gatsby-remark-images/src/index.js

Line 262 in 70b81a6

let args = typeof options.tracedSVG === `object` ? options.tracedSVG : {}

Related Issues

Fixes #28217

[pieh]

2 ways of setting it is covered by

gatsby/packages/gatsby-remark-images/src/index.js

Lines 264 to 271 in 70b81a6

	// Translate Potrace constants (e.g. TURNPOLICY_LEFT, COLOR_AUTO) to the values Potrace expects
	const { Potrace } = require(`potrace`)
	const argsKeys = Object.keys(args)
	args = argsKeys.reduce((result, key) => {
	const value = args[key]
	result[key] = Potrace.hasOwnProperty(value) ? Potrace[value] : value
	return result
	}, {})

[pieh]

Defaults and some of extra restrictions are coming from:

• defaults set by gatsby-plugin-sharp -

  gatsby/packages/gatsby-plugin-sharp/src/trace-svg.js

  Lines 126 to 131 in 70b81a6

  	const defaultArgs = {
  	color: `lightgray`,
  	optTolerance: 0.4,
  	turdSize: 100,
  	turnPolicy: potrace.Potrace.TURNPOLICY_MAJORITY,
  	}

• defaults set by node-potrace - https://github.com/Iwasawafag/node-potrace/blob/b86608eaf3b9c5fea6d6b2034c762ea666e70ec6/lib/Potrace.js#L28-L38
• valid options / ranges from validation inside node-potrace - https://github.com/Iwasawafag/node-potrace/blob/b86608eaf3b9c5fea6d6b2034c762ea666e70ec6/lib/Potrace.js#L981-L997

[pieh]

Also - maybe it's safer to remove defaults, because it's not this plugin that set them. My main motivation to add those defaults is that maybe they are (or will be) displayed in some form - if they are not, then better remove them as they can get out of sync

[mfrachet]

This looks reasonable to me :). What do you think of that @mxstbr ?

[pieh]

Published in [email protected]