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

package/src/index.ts

@@ -19,6 +19,7 @@ import { ensureWatchedFile, setupWatchers } from './utils/watch';
 import { resolveViaPackageJsonSvelte } from './utils/resolve';
 import { PartialResolvedId } from 'rollup';
 import { toRollupError } from './utils/error';
+import { handleOptimizeDeps } from './utils/optimizer';
 
 export function svelte(inlineOptions?: Partial<Options>): Plugin {
 	if (process.env.DEBUG != null) {
@@ -26,7 +27,7 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 	}
 	validateInlineOptions(inlineOptions);
 	const cache = new VitePluginSvelteCache();
-	const pkg_export_errors = new Set();
+	const pkg_resolve_errors = new Set();
 	// updated in configResolved hook
 	let requestParser: IdParser;
 	let options: ResolvedOptions;
@@ -69,6 +70,10 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 			log.debug('resolved options', options);
 		},
 
+		async buildStart() {
+			await handleOptimizeDeps(options, viteConfig);
+		},
+
 		configureServer(server) {
 			// eslint-disable-next-line no-unused-vars
 			options.server = server;
@@ -132,21 +137,13 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 			}
 
 			try {
-				const resolved = resolveViaPackageJsonSvelte(importee, importer);
+				const resolved = resolveViaPackageJsonSvelte(importee, importer, cache);
 				if (resolved) {
 					log.debug(`resolveId resolved ${resolved} via package.json svelte field of ${importee}`);
 					return resolved;
 				}
 			} catch (err) {
-				switch (err.code) {
-					case 'ERR_PACKAGE_PATH_NOT_EXPORTED':
-						pkg_export_errors.add(importee);
-						return null;
-					case 'MODULE_NOT_FOUND':
-						return null;
-					default:
-						throw err;
-				}
+				pkg_resolve_errors.add(importee);
 			}
 		},
 
@@ -173,7 +170,7 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 			try {
 				compileData = await compileSvelte(svelteRequest, code, options);
 			} catch (e) {
-				throw toRollupError(e);
+				throw toRollupError(e, options);
 			}
 			logCompilerWarnings(compileData.compiled.warnings, options);
 			cache.update(compileData);
@@ -201,10 +198,11 @@ export function svelte(inlineOptions?: Partial<Options>): Plugin {
 		 */
 		// TODO generateBundle isn't called by vite, is buildEnd enough or should it be logged once per violation in resolve
 		buildEnd() {
-			if (pkg_export_errors.size > 0) {
+			if (pkg_resolve_errors.size > 0) {
 				log.warn(
-					`The following packages did not export their \`package.json\` file so we could not check the "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_export_errors, (s) => `- ${s}`).join('\n')
+					`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/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

@@ -66,7 +66,10 @@ function getSvelteDependencies(
 	return result;
 }
 
-function resolveDependencyData(dep: string, localRequire: NodeRequire): DependencyData | void {
+export function resolveDependencyData(
+	dep: string,
+	localRequire: NodeRequire
+): DependencyData | void {
 	try {
 		const pkgJson = `${dep}/package.json`;
 		const pkg = localRequire(pkgJson);
@@ -166,7 +169,7 @@ const COMMON_PREFIXES_WITHOUT_SVELTE_FIELD = [
  * @param dependency {string}
  * @returns {boolean} true if it is a dependency without a svelte field
  */
-function is_common_without_svelte_field(dependency: string): boolean {
+export function is_common_without_svelte_field(dependency: string): boolean {
 	return (
 		COMMON_DEPENDENCIES_WITHOUT_SVELTE_FIELD.includes(dependency) ||
 		COMMON_PREFIXES_WITHOUT_SVELTE_FIELD.some(

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

@@ -0,0 +1,43 @@
+import fs from 'fs';
+import path from 'path';
+import { optimizeDeps, ResolvedConfig } from 'vite';
+import { ResolvedOptions } from './options';
+
+// List of options that changes the prebundling result
+const PREBUNDLE_SENSITIVE_OPTIONS: (keyof ResolvedOptions)[] = [
+	'compilerOptions',
+	'configFile',
+	'experimental',
+	'extensions',
+	'ignorePluginPreprocessors',
+	'preprocess'
+];
+
+export async function handleOptimizeDeps(options: ResolvedOptions, viteConfig: ResolvedConfig) {
+	if (!options.experimental.prebundleSvelteLibraries || !viteConfig.cacheDir) return;
+
+	const viteMetadataPath = path.resolve(viteConfig.cacheDir, '_metadata.json');
+
+	if (!fs.existsSync(viteMetadataPath)) return;
+
+	const svelteMetadataPath = path.resolve(viteConfig.cacheDir, '_svelte_metadata.json');
+	const currentSvelteMetadata = JSON.stringify(generateSvelteMetadata(options), (_, value) => {
+		return typeof value === 'function' ? value.toString() : value;
+	});
+
+	if (fs.existsSync(svelteMetadataPath)) {
+		const existingSvelteMetadata = fs.readFileSync(svelteMetadataPath, 'utf8');
+		if (existingSvelteMetadata === currentSvelteMetadata) return;
+	}
+
+	await optimizeDeps(viteConfig, true);
+	fs.writeFileSync(svelteMetadataPath, currentSvelteMetadata);
+}
+
+function generateSvelteMetadata(options: ResolvedOptions) {
+	const metadata: Record<string, any> = {};
+	for (const key of PREBUNDLE_SENSITIVE_OPTIONS) {
+		metadata[key] = options[key];
+	}
+	return metadata;
+}

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
@@ -112,6 +113,7 @@ export function resolveOptions(
 			...defaultOptions.compilerOptions,
 			...preResolveOptions.compilerOptions
 		},
+		root: viteConfig.root,
 		isProduction: viteConfig.isProduction
 	};
 	addExtraPreprocessors(merged, viteConfig);
@@ -490,6 +492,7 @@ export interface PreResolvedOptions extends Options {
 	root: string;
 	isBuild: boolean;
 	isServe: boolean;
+	isDebug: boolean;
 }
 
 export interface ResolvedOptions extends PreResolvedOptions {

package/src/utils/preprocess.ts

@@ -25,7 +25,8 @@ function createViteScriptPreprocessor(): Preprocessor {
 			tsconfigRaw: {
 				compilerOptions: {
 					// svelte typescript needs this flag to work with type imports
-					importsNotUsedAsValues: 'preserve'
+					importsNotUsedAsValues: 'preserve',
+					preserveValueImports: true
 				}
 			}
 		});

package/src/utils/resolve.ts

@@ -1,18 +1,42 @@
 import path from 'path';
-import fs from 'fs';
-// @ts-ignore
-import relative from 'require-relative';
+import { builtinModules, createRequire } from 'module';
+import { is_common_without_svelte_field, resolveDependencyData } from './dependencies';
+import { VitePluginSvelteCache } from './vite-plugin-svelte-cache';
 
-export function resolveViaPackageJsonSvelte(importee: string, importer?: string): string | void {
-	if (importer && isBareImport(importee)) {
-		const importeePkgFile = relative.resolve(`${importee}/package.json`, path.dirname(importer));
-		const importeePkg = JSON.parse(fs.readFileSync(importeePkgFile, { encoding: 'utf-8' }));
-		if (importeePkg.svelte) {
-			return path.resolve(path.dirname(importeePkgFile), importeePkg.svelte);
+export function resolveViaPackageJsonSvelte(
+	importee: string,
+	importer: string | undefined,
+	cache: VitePluginSvelteCache
+): string | void {
+	if (
+		importer &&
+		isBareImport(importee) &&
+		!isNodeInternal(importee) &&
+		!is_common_without_svelte_field(importee)
+	) {
+		const cached = cache.getResolvedSvelteField(importee, importer);
+		if (cached) {
+			return cached;
+		}
+		const localRequire = createRequire(importer);
+		const pkgData = resolveDependencyData(importee, localRequire);
+		if (pkgData) {
+			const { pkg, dir } = pkgData;
+			if (pkg.svelte) {
+				const result = path.resolve(dir, pkg.svelte);
+				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 ||

package/src/utils/vite-plugin-svelte-cache.ts

@@ -6,6 +6,7 @@ export class VitePluginSvelteCache {
 	private _js = new Map<string, Code>();
 	private _dependencies = new Map<string, string[]>();
 	private _dependants = new Map<string, Set<string>>();
+	private _resolvedSvelteFields = new Map<string, string>();
 
 	public update(compileData: CompileData) {
 		this.updateCSS(compileData);
@@ -80,4 +81,23 @@ export class VitePluginSvelteCache {
 		const dependants = this._dependants.get(path);
 		return dependants ? [...dependants] : [];
 	}
+
+	public getResolvedSvelteField(name: string, importer?: string): string | void {
+		return this._resolvedSvelteFields.get(this._getResolvedSvelteFieldKey(name, importer));
+	}
+
+	public setResolvedSvelteField(
+		importee: string,
+		importer: string | undefined = undefined,
+		resolvedSvelte: string
+	) {
+		this._resolvedSvelteFields.set(
+			this._getResolvedSvelteFieldKey(importee, importer),
+			resolvedSvelte
+		);
+	}
+
+	private _getResolvedSvelteFieldKey(importee: string, importer?: string): string {
+		return importer ? `${importer} > ${importee}` : importee;
+	}
 }

package/src/utils/watch.ts

@@ -54,7 +54,7 @@ export function setupWatchers(
 			});
 		} else {
 			log.info(`svelte config changed: restarting vite server. - file: ${filename}`);
-			server.restart(!!options.experimental?.prebundleSvelteLibraries);
+			server.restart();
 		}
 	};