feat(gatsby-remark-images): add disableBgImage option

[dsewnr]

Description

There's a very long inline style on bgImage. Lots images are possible to exceed the 50,000 bytes limit on AMP.

disableBgImage can be used to prevent "Stylesheet too long" error on AMP

[pieh]

This looks great, let's just do small change to docs and upload missing snapshot file.

You can generate one by running yarn gatsby-remark-images -u in root of repository.

[dsewnr]

I don't know what's wrong with my environment. I got the result when I ran yarn workspace gatsby-remark-images test -u.

- style=\\"padding-bottom: 133.33333333333331%; position: relative; bottom: 0; left: 0; background-image: url('data:image/svg+xml,%3csvg /'MOCK SVG/'%3c/svg%3e'); background-size: cover; display: block;\\"
+ style=\\"padding-bottom: 133.33333333333331%; position: relative; bottom: 0; left: 0; background-image: url('data:image/svg+xml,%3csvg \\\\'MOCK SVG\\\\'%3c/svg%3e'); background-size: cover; display: block;\\"

[pieh]

I don't know what's wrong with my environment. I got the result when I ran yarn workspace gatsby-remark-images test -u.

- style=\\"padding-bottom: 133.33333333333331%; position: relative; bottom: 0; left: 0; background-image: url('data:image/svg+xml,%3csvg /'MOCK SVG/'%3c/svg%3e'); background-size: cover; display: block;\\"
+ style=\\"padding-bottom: 133.33333333333331%; position: relative; bottom: 0; left: 0; background-image: url('data:image/svg+xml,%3csvg \\\\'MOCK SVG\\\\'%3c/svg%3e'); background-size: cover; display: block;\\"

This might be related to our jest config. We have top level jest configuration, so if in root you run yarn jest gatsby-remark-images -u it will produce snapshot that will pass in our CI and this is what I did to "fix" the snapshot (I assume this is related to some path normalization things we have in our top level jest config). Sorry for providing bad command to run to update snapshot in previous comment (there was missing jest there).

When I run your command, I also got same result, so there's nothing wrong in your environment.

[pieh]

Thanks @dsewnr!

[gatsbot]

Holy buckets, @dsewnr — we just merged your PR to Gatsby! 💪💜

Gatsby is built by awesome people like you. Let us say “thanks” in two ways:

1. We’d like to send you some Gatsby swag. As a token of our appreciation, you can go to the Gatsby Swag Store and log in with your GitHub account to get a coupon code good for one free piece of swag. We’ve got Gatsby t-shirts, stickers, hats, scrunchies, and much more. (You can also unlock even more free swag with 5 contributions — wink wink nudge nudge.) See gatsby.dev/swag for details.
2. We just invited you to join the Gatsby organization on GitHub. This will add you to our team of maintainers. Accept the invite by visiting https://github.com/orgs/gatsbyjs/invitation. By joining the team, you’ll be able to label issues, review pull requests, and merge approved pull requests.

If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’.

Thanks again!