Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
  • Loading branch information
Princesseuh and sarah11918 authored Aug 18, 2023
1 parent e51c7eb commit bcc567a
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions packages/astro/src/core/errors/errors-data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -794,11 +794,13 @@ export const InvalidDynamicRoute = {
/**
* @docs
* @see
* - [Images](https://docs.astro.build/en/guides/images/)
* - [Default Image Service](https://docs.astro.build/en/guides/images/#default-image-service)
* - [Image Component](https://docs.astro.build/en/guides/images/#image--astroassets)
* - [Image Services API](https://docs.astro.build/en/reference/image-service-reference/)
* @description
* When using a [strict package manager](https://pnpm.io/pnpm-vs-npm#npms-flat-tree) like pnpm, Sharp must be installed manually into your project in order to use image processing.
* Sharp is the default image service used for `astro:assets`. When using a [strict package manager](https://pnpm.io/pnpm-vs-npm#npms-flat-tree) like pnpm, Sharp must be installed manually into your project in order to use image processing.
*
* If you are not using image processing, you can use a passthrough image service that does no processing, like such:
* If you are not using `astro:assets` for image processing, and do not wish to install Sharp, you can configure the following passthrough image service that does no processing:
*
* ```js
* import { defineConfig, passthroughImageService } from "astro/config";
Expand All @@ -813,7 +815,7 @@ export const MissingSharp = {
name: 'MissingSharp',
title: 'Could not find Sharp.',
message: 'Could not find Sharp. Please install Sharp (`sharp`) manually into your project.',
hint: "See Sharp's installation instructions for more information: https://sharp.pixelplumbing.com/install. If you are not using image processing, you may want to use the passthrough image service instead, see https://docs.astro.build/en/reference/errors/missing-sharp for more information.",
hint: "See Sharp's installation instructions for more information: https://sharp.pixelplumbing.com/install. If you are not relying on `astro:assets` to optimize, transform, or process any images, you can configure a passthrough image service instead of installing Sharp. See https://docs.astro.build/en/reference/errors/missing-sharp for more information.",
};
// No headings here, that way Vite errors are merged with Astro ones in the docs, which makes more sense to users.
// Vite Errors - 4xxx
Expand Down

0 comments on commit bcc567a

Please sign in to comment.