Add limitInputPixels option for sharp image service

[bluwy]

Changes

close #8886

Testing

Tested manually

Docs

The documentation doesn't quite mention how options are passed. I suppose we should add one? cc @withastro/maintainers-docs

[changeset-bot]

🦋 Changeset detected

Latest commit: b316915

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[github-actions]

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

[sarah11918]

Thanks @bluwy! This one is going to require a little bit of figuring out, but I'll turn up early tomorrow in case anything doesn't feel obvious!

[sarah11918]

Suggested change

	Adds `limitInputPixels` option for the Sharp image service to be passed on to Sharp.
	Adds an option for the Sharp image service to allow large images to be processed. Set `limitInputPixels: false` to bypass the default image size limit:
	```
	// astro.mjs.config
	example showing this config
	```

(I'm assuming this is a config-wide option set, and not e.g. per-image.)

Depending on the appropriate code sample here, the same will need to be added to the astro types file. Since sharp is the default image service, someone might not have this in their config already, but they'd need to add it in order to pass the option. So, I'm thinking somewhere here: https://docs.astro.build/en/reference/configuration-reference/#imageservice but it would have to account for the fact that someone is only adding this NOT to actually change the image service used, but rather to configure the default one. (Since, this option is JUST for Sharp, and not the other services)

Depending on whatever's decided here, for an actual docs PR, we can even get away with just linking to the config option from here: https://docs.astro.build/en/guides/images/#default-image-service and don't need to explain it. We really should have a link there anyway! 😅

Sorry this requires a bit of figuring out, but I'll make sure I get up early tomorrow and am happy to help with it!

[bluwy]

Thanks for the review! Yeah I have a rough idea to improve this now.

Thanks for linking me to the docs. I actually would've documented something like:

import { defineConfig, sharpImageService } from 'astro/config'

export default defineConfig({
  image: {
    service: sharpImageService({ limitInputPixels: false })
  }
})

But I think it's easier to keep the object format for now, so it applies more generally to other kinds of image services.

[bluwy]

I've updated the changesets and jsdoc. Let me know what you think!

[sarah11918]

Looks great, @bluwy ! Thank you!

Merge day

[jlarmstrongiv]

It seems that the release notes

// astro.config.mjs
import { defineConfig } from 'astro/config';

export default defineConfig({
  image: {
    service: {
      entrypoint: 'astro/assets/services/sharp',
      config: {
        limitInputPixels: false,
      },
    },
  },
});

and config

export interface SharpImageServiceConfig {
    /**
     * The `limitInputPixels` option passed to Sharp. See https://sharp.pixelplumbing.com/api-constructor for more information
     */
    limitInputPixels?: number;
}

Have different option types, though the type should match options.limitInputPixels https://sharp.pixelplumbing.com/api-constructor

For now, setting limitInputPixels: 0 is the same as limitInputPixels: false, but without the type error

[bluwy]

@jlarmstrongiv you're right! I mistyped that. Will send a followup PR to fix it