fix: move ipx to optional dependencies (#403)

Co-authored-by: Patrick Heneise <[email protected]>
nuxt · Sep 5, 2021 · 0affa9d · 0affa9d
1 parent 026be95
commit 0affa9d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -29,7 +29,6 @@
     "fs-extra": "^10.0.0",
     "hasha": "^5.2.2",
     "image-meta": "^0.0.1",
-    "ipx": "^0.7.1",
     "is-https": "^4.0.0",
     "lru-cache": "^6.0.0",
     "node-fetch": "^2.6.1",
@@ -70,6 +69,9 @@
     "typescript": "latest",
     "vue-jest": "latest"
   },
+  "optionalDependencies": {
+    "ipx": "^0.7.1"
+  },
   "publishConfig": {
     "access": "public"
   },

diff --git a/src/ipx.ts b/src/ipx.ts
@@ -21,6 +21,11 @@ export const ipxSetup: ProviderSetup = async (_providerOptions, moduleOptions, n
 
   if (!hasUserProvidedIPX) {
     const { createIPX, createIPXMiddleware } = await import('ipx')
+      .catch((err) => {
+        // eslint-disable-next-line no-console
+        console.error('[@nuxt/image] `ipx` is an optional dependency for local image optimization and is not properly installed. Please try `npm install` or `yarn install` again.')
+        throw new Error(err)
+      })
     const ipx = createIPX(ipxOptions)
     nuxt.options.serverMiddleware.push({
       path: '/_ipx',