@sveltejs/vite-plugin-svelte 1.0.0-next.35 → 1.0.0-next.38

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;
@@ -136,41 +135,24 @@ 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);
+			const resolved = resolveViaPackageJsonSvelte(importee, importer, cache);
+			if (resolved) {
+				log.debug(`resolveId resolved ${resolved} via package.json svelte field of ${importee}`);
+				return resolved;
 			}
 		},
 
 		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);
 			} catch (e) {
-				throw toRollupError(e);
+				throw toRollupError(e, options);
 			}
 			logCompilerWarnings(compileData.compiled.warnings, options);
 			cache.update(compileData);
@@ -179,7 +161,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 +173,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/compile.ts

@@ -37,7 +37,13 @@ const _createCompileSvelte = (makeHot: Function) =>
 		let preprocessed;
 
 		if (options.preprocess) {
-			preprocessed = await preprocess(code, options.preprocess, { filename });
+			try {
+				preprocessed = await preprocess(code, options.preprocess, { filename });
+			} catch (e) {
+				e.message = `Error while preprocessing ${filename}${e.message ? ` - ${e.message}` : ''}`;
+				throw e;
+			}
+
 			if (preprocessed.dependencies) dependencies.push(...preprocessed.dependencies);
 			if (preprocessed.map) compileOptions.sourcemap = preprocessed.map;
 		}

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/error.ts

@@ -1,5 +1,5 @@
 import { RollupError } from 'rollup';
-import { Warning } from './options';
+import { ResolvedOptions, Warning } from './options';
 import { buildExtendedLogMessage } from './log';
 import { PartialMessage } from 'esbuild';
 
@@ -8,15 +8,15 @@ import { PartialMessage } from 'esbuild';
  * @param error a svelte compiler error, which is a mix of Warning and an error
  * @returns {RollupError} the converted error
  */
-export function toRollupError(error: Warning & Error): RollupError {
-	const { filename, frame, start, code, name } = error;
+export function toRollupError(error: Warning & Error, options: ResolvedOptions): RollupError {
+	const { filename, frame, start, code, name, stack } = error;
 	const rollupError: RollupError = {
 		name, // needed otherwise sveltekit coalesce_to_error turns it into a string
 		id: filename,
 		message: buildExtendedLogMessage(error), // include filename:line:column so that it's clickable
 		frame: formatFrameForVite(frame),
 		code,
-		stack: ''
+		stack: options.isBuild || options.isDebug || !frame ? stack : ''
 	};
 	if (start) {
 		rollupError.loc = {
@@ -33,8 +33,8 @@ export function toRollupError(error: Warning & Error): RollupError {
  * @param error a svelte compiler error, which is a mix of Warning and an error
  * @returns {PartialMessage} the converted error
  */
-export function toESBuildError(error: Warning & Error): PartialMessage {
-	const { filename, frame, start } = error;
+export function toESBuildError(error: Warning & Error, options: ResolvedOptions): PartialMessage {
+	const { filename, frame, start, stack } = error;
 	const partialMessage: PartialMessage = {
 		text: buildExtendedLogMessage(error)
 	};
@@ -46,6 +46,9 @@ export function toESBuildError(error: Warning & Error): PartialMessage {
 			lineText: lineFromFrame(start.line, frame) // needed to get a meaningful error message on cli
 		};
 	}
+	if (options.isBuild || options.isDebug || !frame) {
+		partialMessage.detail = stack;
+	}
 	return partialMessage;
 }
 

package/src/utils/esbuild.ts

@@ -27,7 +27,7 @@ export function esbuildSveltePlugin(options: ResolvedOptions): EsbuildPlugin {
 					const contents = await compileSvelte(options, { filename, code });
 					return { contents };
 				} catch (e) {
-					return { errors: [toESBuildError(e)] };
+					return { errors: [toESBuildError(e, options)] };
 				}
 			});
 		}
@@ -73,7 +73,12 @@ async function compileSvelte(
 	let preprocessed;
 
 	if (options.preprocess) {
-		preprocessed = await preprocess(code, options.preprocess, { filename });
+		try {
+			preprocessed = await preprocess(code, options.preprocess, { filename });
+		} catch (e) {
+			e.message = `Error while preprocessing ${filename}${e.message ? ` - ${e.message}` : ''}`;
+			throw e;
+		}
 		if (preprocessed.map) compileOptions.sourcemap = preprocessed.map;
 	}
 

package/src/utils/log.ts

@@ -164,7 +164,10 @@ export function buildExtendedLogMessage(w: Warning) {
 		parts.push(':', w.start.line, ':', w.start.column);
 	}
 	if (w.message) {
-		parts.push(' ', w.message);
+		if (parts.length > 0) {
+			parts.push(' ');
+		}
+		parts.push(w.message);
 	}
 	return parts.join('');
 }

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

@@ -82,7 +82,8 @@ export async function preResolveOptions(
 		// extras
 		root: viteConfigWithResolvedRoot.root!,
 		isBuild: viteEnv.command === 'build',
-		isServe: viteEnv.command === 'serve'
+		isServe: viteEnv.command === 'serve',
+		isDebug: process.env.DEBUG != null
 	};
 	// configFile of svelteConfig contains the absolute path it was loaded from,
 	// prefer it over the possibly relative inline path
@@ -491,6 +492,7 @@ export interface PreResolvedOptions extends Options {
 	root: string;
 	isBuild: boolean;
 	isServe: boolean;
+	isDebug: boolean;
 }
 
 export interface ResolvedOptions extends PreResolvedOptions {

package/src/utils/resolve.ts

@@ -1,5 +1,5 @@
 import path from 'path';
-import { createRequire } from 'module';
+import { builtinModules, createRequire } from 'module';
 import { is_common_without_svelte_field, resolveDependencyData } from './dependencies';
 import { VitePluginSvelteCache } from './vite-plugin-svelte-cache';
 
@@ -8,7 +8,12 @@ export function resolveViaPackageJsonSvelte(
 	importer: string | undefined,
 	cache: VitePluginSvelteCache
 ): string | void {
-	if (importer && isBareImport(importee) && !is_common_without_svelte_field(importee)) {
+	if (
+		importer &&
+		isBareImport(importee) &&
+		!isNodeInternal(importee) &&
+		!is_common_without_svelte_field(importee)
+	) {
 		const cached = cache.getResolvedSvelteField(importee, importer);
 		if (cached) {
 			return cached;
@@ -22,12 +27,14 @@ export function resolveViaPackageJsonSvelte(
 				cache.setResolvedSvelteField(importee, importer, result);
 				return result;
 			}
-		} else {
-			throw new Error(`failed to resolve package.json of ${importee} imported by ${importer}`);
 		}
 	}
 }
 
+function isNodeInternal(importee: string) {
+	return importee.startsWith('node:') || builtinModules.includes(importee);
+}
+
 function isBareImport(importee: string): boolean {
 	if (
 		!importee ||