@sveltejs/vite-plugin-svelte 3.0.0-next.0 → 3.0.0-next.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltejs/vite-plugin-svelte",
-  "version": "3.0.0-next.0",
+  "version": "3.0.0-next.1",
   "license": "MIT",
   "author": "dominikg",
   "files": [
@@ -34,23 +34,23 @@
   },
   "homepage": "https://github.com/sveltejs/vite-plugin-svelte#readme",
   "dependencies": {
+    "@sveltejs/vite-plugin-svelte-inspector": "^2.0.0-next.0 || ^2.0.0",
     "debug": "^4.3.4",
     "deepmerge": "^4.3.1",
     "kleur": "^4.1.5",
-    "magic-string": "^0.30.3",
+    "magic-string": "^0.30.5",
     "svelte-hmr": "^0.15.3",
-    "vitefu": "^0.2.4",
-    "@sveltejs/vite-plugin-svelte-inspector": "^2.0.0-next.0"
+    "vitefu": "^0.2.5"
   },
   "peerDependencies": {
     "svelte": "^4.0.0",
     "vite": "^5.0.0-beta.1 || ^5.0.0"
   },
   "devDependencies": {
-    "@types/debug": "^4.1.8",
-    "esbuild": "^0.19.3",
-    "svelte": "^4.2.0",
-    "vite": "^5.0.0-beta.1"
+    "@types/debug": "^4.1.9",
+    "esbuild": "^0.19.4",
+    "svelte": "^4.2.1",
+    "vite": "^5.0.0-beta.7"
   },
   "scripts": {
     "check:publint": "publint --strict",

package/src/index.d.ts

@@ -121,20 +121,7 @@ interface SvelteOptions {
 	 * @see https://svelte.dev/docs#svelte_compile
 	 */
 	compilerOptions?: Omit<CompileOptions, 'filename' | 'format' | 'generate'>;
-	/**
-	 * Handles warning emitted from the Svelte compiler
-	 */
-	onwarn?: (warning: Warning, defaultHandler?: (warning: Warning) => void) => void;
-	/**
-	 * Options for vite-plugin-svelte
-	 */
-	vitePlugin?: PluginOptions;
-}
 
-/**
- * These options are considered experimental and breaking changes to them can occur in any release
- */
-interface ExperimentalOptions {
 	/**
 	 * A function to update `compilerOptions` before compilation
 	 *
@@ -159,6 +146,21 @@ interface ExperimentalOptions {
 		code: string;
 		compileOptions: Partial<CompileOptions>;
 	}) => Promise<Partial<CompileOptions> | void> | Partial<CompileOptions> | void;
+
+	/**
+	 * Handles warning emitted from the Svelte compiler
+	 */
+	onwarn?: (warning: Warning, defaultHandler?: (warning: Warning) => void) => void;
+	/**
+	 * Options for vite-plugin-svelte
+	 */
+	vitePlugin?: PluginOptions;
+}
+
+/**
+ * These options are considered experimental and breaking changes to them can occur in any release
+ */
+interface ExperimentalOptions {
 	/**
 	 * send a websocket message with svelte compiler warnings during dev
 	 *

package/src/preprocess.js

@@ -1,19 +1,18 @@
-import { preprocessCSS, resolveConfig, transformWithEsbuild } from 'vite';
+import { isCSSRequest, preprocessCSS, resolveConfig, transformWithEsbuild } from 'vite';
 import { mapToRelative, removeLangSuffix } from './utils/sourcemaps.js';
 
 /**
  * @typedef {(code: string, filename: string) => Promise<{ code: string; map?: any; deps?: Set<string> }>} CssTransform
  */
 
-const supportedStyleLangs = ['css', 'less', 'sass', 'scss', 'styl', 'stylus', 'postcss', 'sss'];
 const supportedScriptLangs = ['ts'];
 
-export const lang_sep = '.vite-preprocess.';
+export const lang_sep = '.vite-preprocess';
 
 /** @type {import('./index.d.ts').vitePreprocess} */
 export function vitePreprocess(opts) {
 	/** @type {import('svelte/types/compiler/preprocess').PreprocessorGroup} */
-	const preprocessor = {};
+	const preprocessor = { name: 'vite-preprocess' };
 	if (opts?.script !== false) {
 		preprocessor.script = viteScript().script;
 	}
@@ -63,8 +62,8 @@ function viteStyle(config = {}) {
 	let transform;
 	/** @type {import('svelte/types/compiler/preprocess').Preprocessor} */
 	const style = async ({ attributes, content, filename = '' }) => {
-		const lang = /** @type {string} */ (attributes.lang);
-		if (!supportedStyleLangs.includes(lang)) return;
+		const ext = attributes.lang ? `.${attributes.lang}` : '.css';
+		if (attributes.lang && !isCSSRequest(ext)) return;
 		if (!transform) {
 			/** @type {import('vite').ResolvedConfig} */
 			let resolvedConfig;
@@ -82,7 +81,7 @@ function viteStyle(config = {}) {
 			}
 			transform = getCssTransformFn(resolvedConfig);
 		}
-		const suffix = `${lang_sep}${lang}`;
+		const suffix = `${lang_sep}${ext}`;
 		const moduleId = `${filename}${suffix}`;
 		const { code, map, deps } = await transform(content, moduleId);
 		removeLangSuffix(map, suffix);

package/src/utils/compile.js

@@ -4,8 +4,12 @@ import { createMakeHot } from 'svelte-hmr';
 import { safeBase64Hash } from './hash.js';
 import { log } from './log.js';
 
-import { createInjectScopeEverythingRulePreprocessorGroup } from './preprocess.js';
+import {
+	checkPreprocessDependencies,
+	createInjectScopeEverythingRulePreprocessorGroup
+} from './preprocess.js';
 import { mapToRelative } from './sourcemaps.js';
+import { enhanceCompileError } from './error.js';
 
 const scriptLangRE = /<script [^>]*lang=["']?([^"' >]+)["']?[^>]*>/;
 
@@ -21,7 +25,10 @@ export const _createCompileSvelte = (makeHot) => {
 	return async function compileSvelte(svelteRequest, code, options) {
 		const { filename, normalizedFilename, cssId, ssr, raw } = svelteRequest;
 		const { emitCss = true } = options;
+		/** @type {string[]} */
 		const dependencies = [];
+		/** @type {import('svelte/types/compiler/interfaces').Warning[]} */
+		const warnings = [];
 
 		if (options.stats) {
 			if (options.isBuild) {
@@ -86,7 +93,16 @@ export const _createCompileSvelte = (makeHot) => {
 				throw e;
 			}
 
-			if (preprocessed.dependencies) dependencies.push(...preprocessed.dependencies);
+			if (preprocessed.dependencies?.length) {
+				const checked = checkPreprocessDependencies(filename, preprocessed.dependencies);
+				if (checked.warnings.length) {
+					warnings.push(...checked.warnings);
+				}
+				if (checked.dependencies.length) {
+					dependencies.push(...checked.dependencies);
+				}
+			}
+
 			if (preprocessed.map) compileOptions.sourcemap = preprocessed.map;
 		}
 		if (typeof preprocessed?.map === 'object') {
@@ -99,7 +115,7 @@ export const _createCompileSvelte = (makeHot) => {
 			};
 		}
 		const finalCode = preprocessed ? preprocessed.code : code;
-		const dynamicCompileOptions = await options.experimental?.dynamicCompileOptions?.({
+		const dynamicCompileOptions = await options?.dynamicCompileOptions?.({
 			filename,
 			code: finalCode,
 			compileOptions
@@ -119,13 +135,26 @@ export const _createCompileSvelte = (makeHot) => {
 			: compileOptions;
 
 		const endStat = stats?.start(filename);
-		const compiled = compile(finalCode, finalCompileOptions);
+		/** @type {import('svelte/types/compiler/interfaces').CompileResult} */
+		let compiled;
+		try {
+			compiled = compile(finalCode, finalCompileOptions);
+		} catch (e) {
+			enhanceCompileError(e, code, preprocessors);
+			throw e;
+		}
 
 		if (endStat) {
 			endStat();
 		}
 		mapToRelative(compiled.js?.map, filename);
 		mapToRelative(compiled.css?.map, filename);
+		if (warnings.length) {
+			if (!compiled.warnings) {
+				compiled.warnings = [];
+			}
+			compiled.warnings.push(...warnings);
+		}
 		if (!raw) {
 			// wire css import and code for hmr
 			const hasCss = compiled.css?.code?.trim().length > 0;

package/src/utils/error.js

@@ -100,3 +100,79 @@ function formatFrameForVite(frame) {
 		.map((line) => (line.match(/^\s+\^/) ? '   ' + line : ' ' + line.replace(':', ' | ')))
 		.join('\n');
 }
+
+/**
+ * @param {import('svelte/types/compiler/interfaces').Warning & Error} err a svelte compiler error, which is a mix of Warning and an error
+ * @param {string} originalCode
+ * @param {import('../index.js').Arrayable<import('svelte/types/compiler/preprocess').PreprocessorGroup>} [preprocessors]
+ */
+export function enhanceCompileError(err, originalCode, preprocessors) {
+	preprocessors = arraify(preprocessors ?? []);
+
+	/** @type {string[]} */
+	const additionalMessages = [];
+
+	// Handle incorrect TypeScript usage
+	if (err.code === 'parse-error') {
+		// Reference from Svelte: https://github.com/sveltejs/svelte/blob/800f6c076be5dd87dd4d2e9d66c59b973d54d84b/packages/svelte/src/compiler/preprocess/index.js#L262
+		const scriptRe = /<script(\s[^]*?)?(?:>([^]*?)<\/script>|\/>)/gi;
+		const errIndex = err.pos ?? -1;
+
+		let m;
+		while ((m = scriptRe.exec(originalCode))) {
+			const matchStart = m.index;
+			const matchEnd = matchStart + m[0].length;
+			const isErrorInScript = matchStart <= errIndex && errIndex <= matchEnd;
+			if (isErrorInScript) {
+				// Warn missing lang="ts"
+				const hasLangTs = m[1]?.includes('lang="ts"');
+				if (!hasLangTs) {
+					additionalMessages.push('Did you forget to add lang="ts" to your script tag?');
+				}
+				// Warn missing script preprocessor
+				if (preprocessors.every((p) => p.script == null)) {
+					const preprocessorType = hasLangTs ? 'TypeScript' : 'script';
+					additionalMessages.push(
+						`Did you forget to add a ${preprocessorType} preprocessor? See https://github.com/sveltejs/vite-plugin-svelte/blob/main/docs/preprocess.md for more information.`
+					);
+				}
+			}
+		}
+	}
+
+	// Handle incorrect CSS preprocessor usage
+	if (err.code === 'css-syntax-error') {
+		const styleRe = /<style(\s[^]*?)?(?:>([^]*?)<\/style>|\/>)/gi;
+
+		let m;
+		while ((m = styleRe.exec(originalCode))) {
+			// Warn missing lang attribute
+			if (!m[1]?.includes('lang=')) {
+				additionalMessages.push('Did you forget to add a lang attribute to your style tag?');
+			}
+			// Warn missing style preprocessor
+			if (
+				preprocessors.every((p) => p.style == null || p.name === 'inject-scope-everything-rule')
+			) {
+				const preprocessorType = m[1]?.match(/lang="(.+?)"/)?.[1] ?? 'style';
+				additionalMessages.push(
+					`Did you forget to add a ${preprocessorType} preprocessor? See https://github.com/sveltejs/vite-plugin-svelte/blob/main/docs/preprocess.md for more information.`
+				);
+			}
+		}
+	}
+
+	if (additionalMessages.length) {
+		err.message += '\n\n- ' + additionalMessages.join('\n- ');
+	}
+
+	return err;
+}
+
+/**
+ * @param {T | T[]} value
+ * @template T
+ */
+function arraify(value) {
+	return Array.isArray(value) ? value : [value];
+}

package/src/utils/esbuild.js

@@ -81,14 +81,18 @@ async function compileSvelte(options, { filename, code }, statsCollection) {
 
 	const finalCode = preprocessed ? preprocessed.code : code;
 
-	const dynamicCompileOptions = await options.experimental?.dynamicCompileOptions?.({
+	const dynamicCompileOptions = await options?.dynamicCompileOptions?.({
 		filename,
 		code: finalCode,
 		compileOptions
 	});
 
 	if (dynamicCompileOptions && log.debug.enabled) {
-		log.debug(`dynamic compile options for  ${filename}: ${JSON.stringify(dynamicCompileOptions)}`);
+		log.debug(
+			`dynamic compile options for  ${filename}: ${JSON.stringify(dynamicCompileOptions)}`,
+			undefined,
+			'compile'
+		);
 	}
 
 	const finalCompileOptions = dynamicCompileOptions

package/src/utils/load-svelte-config.js

@@ -59,7 +59,8 @@ export async function loadSvelteConfig(viteConfig, inlineOptions) {
 				// identify which require function to use (esm and cjs mode)
 				const _require = import.meta.url
 					? esmRequire ?? (esmRequire = createRequire(import.meta.url))
-					: require;
+					: // eslint-disable-next-line no-undef
+					  require;
 
 				// avoid loading cached version on reload
 				delete _require.cache[_require.resolve(configFile)];

package/src/utils/options.js

@@ -36,6 +36,7 @@ const allowedPluginOptions = new Set([
 	'disableDependencyReinclusion',
 	'prebundleSvelteLibraries',
 	'inspector',
+	'dynamicCompileOptions',
 	'experimental'
 ]);
 
@@ -316,13 +317,13 @@ function removeIgnoredOptions(options) {
 function handleDeprecatedOptions(options) {
 	const experimental = /** @type {Record<string, any>} */ (options.experimental);
 	if (experimental) {
-		for (const promoted of ['prebundleSvelteLibraries', 'inspector']) {
+		for (const promoted of ['prebundleSvelteLibraries', 'inspector', 'dynamicCompileOptions']) {
 			if (experimental[promoted]) {
 				//@ts-expect-error untyped assign
 				options[promoted] = experimental[promoted];
 				delete experimental[promoted];
 				log.warn(
-					`Option "vitePlugin.experimental.${promoted}" is no longer experimental and has moved to "vitePlugin.${promoted}". Please update your svelte config.`
+					`Option "experimental.${promoted}" is no longer experimental and has moved to "${promoted}". Please update your Svelte or Vite config.`
 				);
 			}
 		}

package/src/utils/preprocess.js

@@ -1,6 +1,7 @@
 import MagicString from 'magic-string';
 import { log } from './log.js';
 import path from 'node:path';
+import { normalizePath } from 'vite';
 
 /**
  * this appends a *{} rule to component styles to force the svelte compiler to add style classes to all nodes
@@ -12,6 +13,7 @@ import path from 'node:path';
  */
 export function createInjectScopeEverythingRulePreprocessorGroup() {
 	return {
+		name: 'inject-scope-everything-rule',
 		style({ content, filename }) {
 			const s = new MagicString(content);
 			s.append(' *{}');
@@ -120,3 +122,52 @@ export function addExtraPreprocessors(options, config) {
 		}
 	}
 }
+
+/**
+ *
+ * @param filename {string}
+ * @param dependencies  {string[]}
+ * @returns {({dependencies: string[], warnings:import('svelte/types/compiler/interfaces').Warning[] })}
+ */
+export function checkPreprocessDependencies(filename, dependencies) {
+	/** @type {import('svelte/types/compiler/interfaces').Warning[]} */
+	const warnings = [];
+
+	// to find self, we have to compare normalized filenames, but must keep the original values in `dependencies`
+	// because otherwise file watching on windows doesn't work
+	// so we track idx and filter by that in the end
+	/** @type {number[]} */
+	const selfIdx = [];
+	const normalizedFullFilename = normalizePath(filename);
+	const normalizedDeps = dependencies.map(normalizePath);
+	for (let i = 0; i < normalizedDeps.length; i++) {
+		if (normalizedDeps[i] === normalizedFullFilename) {
+			selfIdx.push(i);
+		}
+	}
+	const hasSelfDependency = selfIdx.length > 0;
+	if (hasSelfDependency) {
+		warnings.push({
+			code: 'vite-plugin-svelte-preprocess-depends-on-self',
+			message:
+				'svelte.preprocess returned this file as a dependency of itself. This can be caused by an invalid configuration or importing generated code that depends on .svelte files (eg. tailwind base css)',
+			filename
+		});
+	}
+
+	if (dependencies.length > 10) {
+		warnings.push({
+			code: 'vite-plugin-svelte-preprocess-many-dependencies',
+			message: `svelte.preprocess depends on more than 10 external files which can cause slow builds and poor DX, try to reduce them. Found: ${dependencies.join(
+				', '
+			)}`,
+			filename
+		});
+	}
+	return {
+		dependencies: hasSelfDependency
+			? dependencies.filter((_, i) => !selfIdx.includes(i)) // remove self dependency
+			: dependencies,
+		warnings
+	};
+}