gatsby-image-sharp missing 'resize' export

[cupojoe]

Description

According to the documentation for gatsby-image-sharp v2 beta 3 there is a method called resize to just resize one image. Trying to import this method from the package fails and looking at the source the export is not there:

gatsby/packages/gatsby-plugin-sharp/src/index.js

Lines 740 to 747 in c4ee17a

	exports.queueImageResizing = queueImageResizing
	exports.base64 = base64
	exports.traceSVG = traceSVG
	exports.sizes = fluid
	exports.resolutions = fixed
	exports.fluid = fluid
	exports.fixed = fixed
	exports.getImageSize = getImageSize

Should it be added or the documentation updated?

[LekoArts]

You would use resize in the GraphQL query. Or what did you try to do?

[m-allanson]

@cupojoe I'd be interested to hear what you're aiming to do!

I just had a dig through the history of gatsby-image-sharp, and it doesn't look like resize has ever been exported. Resize operations are instead handled by the queueImageResizing function, which is designed to work with Gatsby file nodes rather than file paths directly.

See the tests for example usages, or take a look at extend-node-type.js in gatsby-transformer-sharp to see how this is hooked up to resize() in a GraphQL query.

I'd love to see a PR updating the docs to remove resize and include queueImageResizing if you or anyone else is interested.

Edit to add: @LekoArts is right, typically you wouldn't use these functions directly, but via a GraphQL query. Check out the image processing example (src) to see how that'd look.

[KyleAMathews]

We could export a resize function that just calls queueImageResizing if someone wanted to PR that.

[cupojoe]

I'm making a gatsby plugin to process poster attributes so you can add html 5 video tags directly into the markdown files (using plain html).
I think exporting resize as an alias would be great since that is what is documented in the package and it can be confusing that it doesn't work while the docs refer to it.

[KyleAMathews]

Sounds like a sweet plugin! And yeah! Please PR the change!

[cupojoe]

@KyleAMathews will do, also a PR to include the plugin in the plugins registry. Gotta checkout the plugin contribution guidelines first :)

[KyleAMathews]

Sweet! Plugins btw are auto pulled in if you add "gatsby-plugin" as a keyword

[cupojoe]

you mean if I add gatsby-plugin as a keyword in the package.json and also include the plugin in a pr to the gatsby mono repo?

[KyleAMathews]

We're suggesting that most plugins should be maintained in your own repo. We like to maintain some really core plugins here that are widely used but we have limited bandwidth so most plugins we ask authors to keep in your own repo. But definitely want it in the plugin library so please add the keyword to your package.json so it shows up!

[cupojoe]

sounds good 👍

[cupojoe]

Added the plugin: https://www.npmjs.com/package/gatsby-remark-video-poster
On to that PR now

[cupojoe]

@KyleAMathews I can see the new plugin in the list of plugins, but if you select it you get a 404. Did I miss something for it to populate correctly?