Svelte-Kit: Can't use Image component

[r-bt]

Hi,

Firstly thanks for making this great library. I'm trying to get to get it setup with Svelte-Kit however importing Image gives me this error:

ENOENT: no such file or directory, open '/Users/richard/Documents/Personal sites/r-bt.com/node_modules/blurhash/src/index.ts'

Steps to reproduce

1. Create new Svelte-Kit project (issue present on both JS & TS projects
2. Install svelte-image
3. Add svelte-image to svelte.config.cjs

const image = require('svelte-image');
/** @type {import('@sveltejs/kit').Config} */
module.exports = {
	kit: {
		// hydrate the <div id="svelte"> element in src/app.html
		target: '#svelte'
	},
	preprocess: {
		...image()
	}
};

4. Import Image component
5. Run the dev server

[michaeloliverx]

Can confirm I get this also:

08:57:06 [vite] Internal server error: ENOENT: no such file or directory, open '/Users/michaeloliver/Development/Personal/blog-sveltekit-ts-markdown-list/node_modules/blurhash/src/index.ts'

[yiioverflow]

I am also trying to make it work with sveltekit. Anybody have a solution ?

[Antoine-lb]

Same problem.

This package is a deal maker/braker for Svelte, I should be in the official repo.

My two cents, I guess the config file now looks more like:

preprocess: preprocess({
	...image()
}),

[yiioverflow]

@Antoine-lb would you able to make it work, or do we need to use other plugins like vite-image-tools ?

[Antoine-lb]

@yiioverflow no, I wasn't able to make it work. I didn't try that hard but I ended up exactly where the this issue points to

[jpoep]

I fixed it by adding blurhash to optimizeDevs in my vite config. I also needed to add it to the ssr.noExternal array, even though I have it as a dev dependency. It wouldn't work otherwise. So the total config kinda looks like this:

// svelte.config.js
// ...
const config = {
  // ...
  kit: {
    // ...
    vite: {
      optimizeDeps: {
        include: ['blurhash'],
      },
      ssr: {
        noExternal: ['svelte-image'],
      },
    },
  },
};

Also, the preprocess statement has to look like the following:

import preprocess from 'svelte-preprocess';
import svelteImage from 'svelte-image';

const config = {
  preprocess: [
    preprocess({ /* options */ }),
    svelteImage(),
  ],
// ...

Note that there is a difference between svelte-preprocess and the Svelte preprocess API. In my opinion, svelte-preprocess is pretty poorly named and causes a lot of confusion. This plugin does not use svelte-preprocess, but the preprocess API of svelte, which is why it needs to be passed along with svelte-preprocess, not inside of it.

However, with my project running TypeScript, I couldn't get it to work, as svelte-image kept producing parsing errors when it encountered TypeScript syntax. No idea how to solve this -- this project relying so much on preprocessing for more than just image resizing was probably not the greatest design decision.

[benmccann]

@QElix thanks for sharing! There's a PR for blurhash that would package it as ESM, so that you no longer need to include it in optimizeDeps: woltapp/blurhash#58. I don't think that you should need to include svelte-image in ssr.noExternal as that should be done automatically (sveltejs/kit#1148). Whether it's a dependency or dev dependency also shouldn't matter (though it did in the past because SvelteKit had noExternal: Object.keys(pkg.dependencies || {}) in the default config, which is no longer recommended - https://kit.svelte.dev/faq#packages).

[omahlama]

Hi, I just merged the woltapp/blurhash#58 PR and release 1.1.4 of the package, so you should be able to move forward with this.

[benmccann]

Thanks @omahlama! However, it looks like there's another issue: woltapp/blurhash#142

[kaushalyap]

Things works fine for me in both dev and build mode. @Antoine-lb thanks for the config file guess seems you are correct.

// svelte.config.js

/** @type {import('@sveltejs/kit').Config} */
import adapter from '@sveltejs/adapter-static';
import image from 'svelte-image';
import { preprocess } from 'svelte/compiler';

const config = {
	kit: {
		// hydrate the <div id="svelte"> element in src/app.html
		target: '#svelte',
		adapter: adapter({
			// default options are shown
			pages: 'build',
			assets: 'build',
			fallback: null
		})
	},
	preprocess: preprocess({
		...image()
	})
};

export default config;

Update:

But there seems to be something odd going on in prod build, if I am to reload the page with image image disappears., but If I navigate to another link and came back to the page with image, image is shown. May be this is a bug with Svelte kit Static adapter. paging @benmccann

[winston0410]

I fixed it by adding blurhash to optimizeDevs in my vite config. I also needed to add it to the ssr.noExternal array, even though I have it as a dev dependency. It wouldn't work otherwise. So the total config kinda looks like this:

// svelte.config.js
// ...
const config = {
  // ...
  kit: {
    // ...
    vite: {
      optimizeDeps: {
        include: ['blurhash'],
      },
      ssr: {
        noExternal: ['svelte-image'],
      },
    },
  },
};

Also, the preprocess statement has to look like the following:

import preprocess from 'svelte-preprocess';
import svelteImage from 'svelte-image';

const config = {
  preprocess: [
    preprocess({ /* options */ }),
    svelteImage(),
  ],
// ...

Note that there is a difference between svelte-preprocess and the Svelte preprocess API. In my opinion, svelte-preprocess is pretty poorly named and causes a lot of confusion. This plugin does not use svelte-preprocess, but the preprocess API of svelte, which is why it needs to be passed along with svelte-preprocess, not inside of it.

However, with my project running TypeScript, I couldn't get it to work, as svelte-image kept producing parsing errors when it encountered TypeScript syntax. No idea how to solve this -- this project relying so much on preprocessing for more than just image resizing was probably not the greatest design decision.

Is the typescript issue solved for now? I have the same error, pointing to type declaration.

[benmccann]

I've sent a fix for the blurhash source map issue: woltapp/blurhash#155

[benmccann]

I just tested with the latest version of blurhash and everything seems to be working now. I've sent a PR to upgrade this project: #140. But in the meantime, you can upgrade your own projects by upgrading the version in your lock file. I believe this issue can be closed now