@sveltejs/vite-plugin-svelte 1.0.0-next.37 → 1.0.0-next.40

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltejs/vite-plugin-svelte",
-  "version": "1.0.0-next.37",
+  "version": "1.0.0-next.40",
   "license": "MIT",
   "author": "dominikg",
   "files": [
@@ -40,11 +40,11 @@
   },
   "homepage": "https://github.com/sveltejs/vite-plugin-svelte#readme",
   "dependencies": {
-    "@rollup/pluginutils": "^4.1.2",
+    "@rollup/pluginutils": "^4.2.0",
     "debug": "^4.3.3",
     "kleur": "^4.1.4",
-    "magic-string": "^0.25.7",
-    "svelte-hmr": "^0.14.9"
+    "magic-string": "^0.26.1",
+    "svelte-hmr": "^0.14.11"
   },
   "peerDependencies": {
     "diff-match-patch": "^1.0.5",
@@ -60,11 +60,11 @@
     "@types/debug": "^4.1.7",
     "@types/diff-match-patch": "^1.0.32",
     "diff-match-patch": "^1.0.5",
-    "esbuild": "^0.14.14",
-    "rollup": "^2.66.1",
-    "svelte": "^3.46.3",
-    "tsup": "^5.11.13",
-    "vite": "^2.7.13"
+    "esbuild": "^0.14.26",
+    "rollup": "^2.70.1",
+    "svelte": "^3.46.4",
+    "tsup": "^5.12.1",
+    "vite": "^2.8.6"
   },
   "scripts": {
     "dev": "pnpm run build:ci -- --sourcemap --watch src",

package/src/index.ts

@@ -27,7 +27,6 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 	}
 	validateInlineOptions(inlineOptions);
 	const cache = new VitePluginSvelteCache();
-	const pkg_resolve_errors = new Set();
 	// updated in configResolved hook
 	let requestParser: IdParser;
 	let options: ResolvedOptions;
@@ -56,7 +55,7 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 			// @ts-expect-error temporarily lend the options variable until fixed in configResolved
 			options = await preResolveOptions(inlineOptions, config, configEnv);
 			// extra vite config
-			const extraViteConfig = buildExtraViteConfig(options, config, configEnv);
+			const extraViteConfig = buildExtraViteConfig(options, config);
 			log.debug('additional vite config', extraViteConfig);
 			return extraViteConfig;
 		},
@@ -135,37 +134,28 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 				}
 				return resolvedSvelteSSR;
 			}
-
 			try {
 				const resolved = resolveViaPackageJsonSvelte(importee, importer, cache);
 				if (resolved) {
 					log.debug(`resolveId resolved ${resolved} via package.json svelte field of ${importee}`);
 					return resolved;
 				}
-			} catch (err) {
-				pkg_resolve_errors.add(importee);
+			} catch (e) {
+				log.debug.once(
+					`error trying to resolve ${importee} from ${importer} via package.json svelte field `,
+					e
+				);
+				// this error most likely happens due to non-svelte related importee/importers so swallow it here
+				// in case it really way a svelte library, users will notice anyway. (lib not working due to failed resolve)
 			}
 		},
 
 		async transform(code, id, opts) {
 			const ssr = !!opts?.ssr;
 			const svelteRequest = requestParser(id, ssr);
-			if (!svelteRequest) {
+			if (!svelteRequest || svelteRequest.query.svelte) {
 				return;
 			}
-			const { filename, query } = svelteRequest;
-
-			if (query.svelte) {
-				if (query.type === 'style') {
-					const css = cache.getCSS(svelteRequest);
-					if (css) {
-						log.debug(`transform returns css for ${filename}`);
-						return css; // TODO return code arg instead? it's the code from load hook.
-					}
-				}
-				log.error('failed to transform tagged svelte request', svelteRequest);
-				throw new Error(`failed to transform tagged svelte request for id ${id}`);
-			}
 			let compileData;
 			try {
 				compileData = await compileSvelte(svelteRequest, code, options);
@@ -179,7 +169,7 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 					ensureWatchedFile(options.server!.watcher, d, options.root);
 				});
 			}
-			log.debug(`transform returns compiled js for ${filename}`);
+			log.debug(`transform returns compiled js for ${svelteRequest.filename}`);
 			return compileData.compiled.js;
 		},
 
@@ -191,20 +181,6 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 			if (svelteRequest) {
 				return handleHotUpdate(compileSvelte, ctx, svelteRequest, cache, options);
 			}
-		},
-
-		/**
-		 * All resolutions done; display warnings wrt `package.json` access.
-		 */
-		// TODO generateBundle isn't called by vite, is buildEnd enough or should it be logged once per violation in resolve
-		buildEnd() {
-			if (pkg_resolve_errors.size > 0) {
-				log.warn(
-					`vite-plugin-svelte was unable to find package.json of the following packages and wasn't able to resolve via their "svelte" field.
-					If you had difficulties importing svelte components from a package, then please contact the author and ask them to export the package.json file.
-					${Array.from(pkg_resolve_errors, (s) => `- ${s}`).join('\n')}`.replace(/\t/g, '')
-				);
-			}
 		}
 	};
 }

package/src/utils/__tests__/dependencies.spec.ts

@@ -1,15 +1,16 @@
-import { findRootSvelteDependencies } from '../dependencies';
+import { findRootSvelteDependencies, needsOptimization } from '../dependencies';
 import * as path from 'path';
+import { createRequire } from 'module';
 
 describe('dependencies', () => {
 	describe('findRootSvelteDependencies', () => {
-		it('should find svelte dependencies in packages/e2e-test/hmr', async () => {
+		it('should find svelte dependencies in packages/e2e-test/hmr', () => {
 			const deps = findRootSvelteDependencies(path.resolve('packages/e2e-tests/hmr'));
 			expect(deps).toHaveLength(1);
 			expect(deps[0].name).toBe('e2e-test-dep-svelte-simple');
 			expect(deps[0].path).toEqual([]);
 		});
-		it('should find nested svelte dependencies in packages/e2e-test/package-json-svelte-field', async () => {
+		it('should find nested svelte dependencies in packages/e2e-test/package-json-svelte-field', () => {
 			const deps = findRootSvelteDependencies(
 				path.resolve('packages/e2e-tests/package-json-svelte-field')
 			);
@@ -26,4 +27,14 @@ describe('dependencies', () => {
 			expect(simple.path[0]).toBe('e2e-test-dep-svelte-nested');
 		});
 	});
+	describe('needsOptimization', () => {
+		it('should optimize cjs deps only', () => {
+			const localRequire = createRequire(path.resolve('packages/e2e-tests/dependencies'));
+			expect(needsOptimization('e2e-test-dep-cjs-and-esm', localRequire)).toBe(false);
+			expect(needsOptimization('e2e-test-dep-cjs-only', localRequire)).toBe(true);
+			expect(needsOptimization('e2e-test-dep-esm-only', localRequire)).toBe(false);
+			expect(needsOptimization('e2e-test-dep-index-only', localRequire)).toBe(true);
+			expect(needsOptimization('e2e-test-dep-types-only', localRequire)).toBe(false);
+		});
+	});
 });

package/src/utils/dependencies.ts

@@ -187,12 +187,23 @@ export function needsOptimization(dep: string, localRequire: NodeRequire): boole
 	const pkg = depData.pkg;
 	// only optimize if is cjs, using the below as heuristic
 	// see https://github.com/sveltejs/vite-plugin-svelte/issues/162
-	const isCjs = pkg.main && !pkg.module && !pkg.exports;
-	if (!isCjs) return false;
-	// ensure entry is js so vite can prebundle it
-	// see https://github.com/sveltejs/vite-plugin-svelte/issues/233
-	const entryExt = path.extname(pkg.main);
-	return !entryExt || entryExt === '.js' || entryExt === '.cjs';
+	const hasEsmFields = pkg.module || pkg.exports;
+	if (hasEsmFields) return false;
+	if (pkg.main) {
+		// ensure entry is js so vite can prebundle it
+		// see https://github.com/sveltejs/vite-plugin-svelte/issues/233
+		const entryExt = path.extname(pkg.main);
+		return !entryExt || entryExt === '.js' || entryExt === '.cjs';
+	} else {
+		// check if has implicit index.js entrypoint
+		// https://github.com/sveltejs/vite-plugin-svelte/issues/281
+		try {
+			localRequire.resolve(`${dep}/index.js`);
+			return true;
+		} catch {
+			return false;
+		}
+	}
 }
 
 interface DependencyData {

package/src/utils/optimizer.ts

@@ -16,11 +16,10 @@ const PREBUNDLE_SENSITIVE_OPTIONS: (keyof ResolvedOptions)[] = [
 export async function handleOptimizeDeps(options: ResolvedOptions, viteConfig: ResolvedConfig) {
 	if (!options.experimental.prebundleSvelteLibraries || !viteConfig.cacheDir) return;
 
-	const viteMetadataPath = path.resolve(viteConfig.cacheDir, '_metadata.json');
+	const viteMetadataPath = findViteMetadataPath(viteConfig.cacheDir);
+	if (!viteMetadataPath) return;
 
-	if (!fs.existsSync(viteMetadataPath)) return;
-
-	const svelteMetadataPath = path.resolve(viteConfig.cacheDir, '_svelte_metadata.json');
+	const svelteMetadataPath = path.resolve(viteMetadataPath, '../_svelte_metadata.json');
 	const currentSvelteMetadata = JSON.stringify(generateSvelteMetadata(options), (_, value) => {
 		return typeof value === 'function' ? value.toString() : value;
 	});
@@ -41,3 +40,11 @@ function generateSvelteMetadata(options: ResolvedOptions) {
 	}
 	return metadata;
 }
+
+function findViteMetadataPath(cacheDir: string) {
+	const metadataPaths = ['_metadata.json', 'deps/_metadata.json'];
+	for (const metadataPath of metadataPaths) {
+		const viteMetadataPath = path.resolve(cacheDir, metadataPath);
+		if (fs.existsSync(viteMetadataPath)) return viteMetadataPath;
+	}
+}

package/src/utils/options.ts

@@ -184,8 +184,7 @@ function resolveViteRoot(viteConfig: UserConfig): string | undefined {
 
 export function buildExtraViteConfig(
 	options: PreResolvedOptions,
-	config: UserConfig,
-	configEnv: ConfigEnv
+	config: UserConfig
 ): Partial<UserConfig> {
 	// extra handling for svelte dependencies in the project
 	const svelteDeps = findRootSvelteDependencies(options.root);
@@ -200,7 +199,7 @@ export function buildExtraViteConfig(
 		// knownJsSrcExtensions: options.extensions
 	};
 
-	if (configEnv.command === 'serve') {
+	if (options.isServe) {
 		extraViteConfig.optimizeDeps = buildOptimizeDepsForSvelte(
 			svelteDeps,
 			options,
@@ -209,7 +208,7 @@ export function buildExtraViteConfig(
 	}
 
 	// @ts-ignore
-	extraViteConfig.ssr = buildSSROptionsForSvelte(svelteDeps, options, config);
+	extraViteConfig.ssr = buildSSROptionsForSvelte(svelteDeps, options, config, extraViteConfig);
 
 	return extraViteConfig;
 }
@@ -294,7 +293,7 @@ function buildSSROptionsForSvelte(
 	// add svelte to ssr.noExternal unless it is present in ssr.external
 	// so we can resolve it with svelte/ssr
 	if (options.isBuild && config.build?.ssr) {
-		// @ts-ignore
+		// @ts-expect-error ssr still flagged in vite
 		if (!config.ssr?.external?.includes('svelte')) {
 			noExternal.push('svelte');
 		}
@@ -309,13 +308,30 @@ function buildSSROptionsForSvelte(
 	// add svelte dependencies to ssr.noExternal unless present in ssr.external or optimizeDeps.include
 	noExternal.push(
 		...Array.from(new Set(svelteDeps.map((s) => s.name))).filter((x) => {
-			// @ts-ignore
+			// @ts-expect-error ssr still flagged in vite
 			return !config.ssr?.external?.includes(x) && !config.optimizeDeps?.include?.includes(x);
 		})
 	);
-	return {
+	const ssr = {
 		noExternal
 	};
+
+	if (options.isServe) {
+		// during dev, we have to externalize transitive dependencies, see https://github.com/sveltejs/vite-plugin-svelte/issues/281
+		// @ts-expect-error ssr still flagged in vite
+		ssr.external = Array.from(
+			new Set(svelteDeps.flatMap((dep) => Object.keys(dep.pkg.dependencies || {})))
+		).filter(
+			(dep) =>
+				!ssr.noExternal.includes(dep) &&
+				// @ts-expect-error ssr still flagged in vite
+				!config.ssr?.noExternal?.includes(dep) &&
+				// @ts-expect-error ssr still flagged in vite
+				!config.ssr?.external?.includes(dep)
+		);
+	}
+
+	return ssr;
 }
 
 export function patchResolvedViteConfig(viteConfig: ResolvedConfig, options: ResolvedOptions) {

package/src/utils/resolve.ts

@@ -27,8 +27,6 @@ export function resolveViaPackageJsonSvelte(
 				cache.setResolvedSvelteField(importee, importer, result);
 				return result;
 			}
-		} else {
-			throw new Error(`failed to resolve package.json of ${importee} imported by ${importer}`);
 		}
 	}
 }