Skip to content

Commit

Permalink
Update install-sharp.md (vercel#18508)
Browse files Browse the repository at this point in the history
Co-authored-by: Luis Alvarez D. <[email protected]>
  • Loading branch information
styfle and lfades authored Oct 30, 2020
1 parent afa04d2 commit b7daae4
Showing 1 changed file with 9 additions and 12 deletions.
21 changes: 9 additions & 12 deletions errors/install-sharp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,24 @@

#### Why This Error Occurred

Using Next.js' built-in Image Optimization requires that you install `sharp`.
Using Next.js' built-in [Image Optimization](https://nextjs.org/docs/basic-features/image-optimization) requires [sharp](https://www.npmjs.com/package/sharp) as a dependency.

Since `sharp` is optional, it may have been skipped if you installed `next` with the [`--no-optional`](https://docs.npmjs.com/cli/install) flag or it may have been skipped if your platform does not support `sharp`.
You are seeing this error because your OS was unable to [install sharp](https://sharp.pixelplumbing.com/install) properly, either using pre-built binaries or building from source.

#### Possible Ways to Fix It

Option 1: Install the `sharp` package in your project.
Option 1: Use a different version of Node.js and try to install `sharp` again.

```bash
npm i sharp
# or
yarn add sharp
```

Option 2: Configure an external loader in `next.config.js` such as [imgix](https://imgix.com).
Option 2: If using macOS, ensure XCode Build Tools are installed and try to install `sharp` again.

```js
module.exports = {
images: {
path: 'https://example.com/myaccount/',
loader: 'imgix',
},
}
```
For example, see [macOS Catalina instructions](https://github.com/nodejs/node-gyp/blob/66c0f0446749caa591ad841cd029b6d5b5c8da42/macOS_Catalina.md).

Option 3: Use a different OS and try to install `sharp` again.

For example, if you're using Windows, try using [WSL](https://docs.microsoft.com/en-us/windows/wsl/about) (Windows Subsystem for Linux).

0 comments on commit b7daae4

Please sign in to comment.