🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

@sveltejs/vite-plugin-svelte

Package Overview
Dependencies
Maintainers
4
Versions
125
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@sveltejs/vite-plugin-svelte - npm Package Compare versions

Comparing version

to
1.0.0-next.43

src/ui/inspector/icon.svg

47

dist/index.d.ts

@@ -11,3 +11,3 @@ import { Plugin } from 'vite';

*
* set to `false` to skip reading config from a file
* set to `false` to ignore the svelte config file
*

@@ -154,3 +154,46 @@ * @see https://vitejs.dev/config/#root

}) => Promise<Partial<CompileOptions> | void> | Partial<CompileOptions> | void;
/**
* enable svelte inspector
*/
inspector?: InspectorOptions | boolean;
}
interface InspectorOptions {
/**
* define a key combo to toggle inspector,
* @default 'control-shift' on windows, 'meta-shift' on other os
*
* any number of modifiers `control` `shift` `alt` `meta` followed by zero or one regular key, separated by -
* examples: control-shift, control-o, control-alt-s meta-x control-meta
* Some keys have native behavior (e.g. alt-s opens history menu on firefox).
* To avoid conflicts or accidentally typing into inputs, modifier only combinations are recommended.
*/
toggleKeyCombo?: string;
/**
* inspector is automatically disabled when releasing toggleKeyCombo after holding it for a longpress
* @default false
*/
holdMode?: boolean;
/**
* when to show the toggle button
* @default 'active'
*/
showToggleButton?: 'always' | 'active' | 'never';
/**
* where to display the toggle button
* @default top-right
*/
toggleButtonPos?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
/**
* inject custom styles when inspector is active
*/
customStyles?: boolean;
/**
* append an import to the module id ending with `appendTo` instead of adding a script into body
* useful for frameworks that do not support trannsformIndexHtml hook
*
* WARNING: only set this if you know exactly what it does.
* Regular users of vite-plugin-svelte or SvelteKit do not need it
*/
appendTo?: string;
}
declare type ModuleFormat = NonNullable<CompileOptions['format']>;

@@ -160,4 +203,4 @@ declare type CssHashGetter = NonNullable<CompileOptions['cssHash']>;

declare function svelte(inlineOptions?: Partial<Options>): Plugin;
declare function svelte(inlineOptions?: Partial<Options>): Plugin[];
export { Arrayable, CssHashGetter, ModuleFormat, Options, svelte };

399

dist/index.js

@@ -275,4 +275,5 @@ var __defProp = Object.defineProperty;

// src/utils/compile.ts
var scriptLangRE = /<script [^>]*lang=["']?([^"' >]+)["']?[^>]*>/;
var _createCompileSvelte = (makeHot) => async function compileSvelte2(svelteRequest, code, options) {
var _a, _b;
var _a, _b, _c;
const { filename, normalizedFilename, cssId, ssr } = svelteRequest;

@@ -340,2 +341,3 @@ const { emitCss = true } = options;

normalizedFilename,
lang: ((_c = code.match(scriptLangRE)) == null ? void 0 : _c[1]) || "js",
compiled,

@@ -1058,2 +1060,3 @@ ssr,

// src/utils/options.ts
import deepmerge from "deepmerge";
var knownOptions = /* @__PURE__ */ new Set([

@@ -1071,3 +1074,4 @@ "configFile",

"disableDependencyReinclusion",
"experimental"
"experimental",
"kit"
]);

@@ -1092,5 +1096,3 @@ function validateInlineOptions(inlineOptions) {

const svelteConfig = await loadSvelteConfig(viteConfigWithResolvedRoot, inlineOptions);
const merged = __spreadProps(__spreadValues(__spreadValues(__spreadValues({}, defaultOptions), svelteConfig), inlineOptions), {
compilerOptions: __spreadValues(__spreadValues(__spreadValues({}, defaultOptions == null ? void 0 : defaultOptions.compilerOptions), svelteConfig == null ? void 0 : svelteConfig.compilerOptions), inlineOptions == null ? void 0 : inlineOptions.compilerOptions),
experimental: __spreadValues(__spreadValues(__spreadValues({}, defaultOptions == null ? void 0 : defaultOptions.experimental), svelteConfig == null ? void 0 : svelteConfig.experimental), inlineOptions == null ? void 0 : inlineOptions.experimental),
const extraOptions = {
root: viteConfigWithResolvedRoot.root,

@@ -1100,3 +1102,4 @@ isBuild: viteEnv.command === "build",

isDebug: process.env.DEBUG != null
});
};
const merged = mergeConfigs(defaultOptions, svelteConfig, inlineOptions, extraOptions);
if (svelteConfig == null ? void 0 : svelteConfig.configFile) {

@@ -1107,2 +1110,11 @@ merged.configFile = svelteConfig.configFile;

}
function mergeConfigs(...configs) {
let result = {};
for (const config of configs.filter(Boolean)) {
result = deepmerge(result, config, {
arrayMerge: (target, source) => source ?? target
});
}
return result;
}
function resolveOptions(preResolveOptions2, viteConfig) {

@@ -1116,7 +1128,7 @@ const defaultOptions = {

};
const merged = __spreadProps(__spreadValues(__spreadValues({}, defaultOptions), preResolveOptions2), {
compilerOptions: __spreadValues(__spreadValues({}, defaultOptions.compilerOptions), preResolveOptions2.compilerOptions),
const extraOptions = {
root: viteConfig.root,
isProduction: viteConfig.isProduction
});
};
const merged = mergeConfigs(defaultOptions, preResolveOptions2, extraOptions);
addExtraPreprocessors(merged, viteConfig);

@@ -1174,2 +1186,3 @@ enforceOptionsForHmr(merged);

function buildExtraViteConfig(options, config) {
var _a;
const svelteDeps = findRootSvelteDependencies(options.root);

@@ -1185,3 +1198,3 @@ const extraViteConfig = {

}
if (options.experimental.prebundleSvelteLibraries) {
if ((_a = options.experimental) == null ? void 0 : _a.prebundleSvelteLibraries) {
extraViteConfig.optimizeDeps = __spreadProps(__spreadValues({}, extraViteConfig.optimizeDeps), {

@@ -1199,11 +1212,12 @@ extensions: options.extensions ?? [".svelte"],

function buildOptimizeDepsForSvelte(svelteDeps, options, optimizeDeps) {
var _a;
const include = [];
const exclude = ["svelte-hmr"];
const isIncluded = (dep) => {
var _a;
return include.includes(dep) || ((_a = optimizeDeps == null ? void 0 : optimizeDeps.include) == null ? void 0 : _a.includes(dep));
var _a2;
return include.includes(dep) || ((_a2 = optimizeDeps == null ? void 0 : optimizeDeps.include) == null ? void 0 : _a2.includes(dep));
};
const isExcluded = (dep) => {
var _a;
return exclude.includes(dep) || ((_a = optimizeDeps == null ? void 0 : optimizeDeps.exclude) == null ? void 0 : _a.some((id) => dep === id || id.startsWith(`${dep}/`)));
var _a2;
return exclude.includes(dep) || ((_a2 = optimizeDeps == null ? void 0 : optimizeDeps.exclude) == null ? void 0 : _a2.some((id) => dep === id || id.startsWith(`${dep}/`)));
};

@@ -1217,3 +1231,3 @@ if (!isExcluded("svelte")) {

}
if (options.experimental.prebundleSvelteLibraries) {
if ((_a = options.experimental) == null ? void 0 : _a.prebundleSvelteLibraries) {
return { include, exclude };

@@ -1397,13 +1411,2 @@ }

};
const possibleSvelteConfigs = knownSvelteConfigNames.map((cfg) => path5.join(root, cfg));
const restartOnConfigAdd = (filename) => {
if (possibleSvelteConfigs.includes(filename)) {
triggerViteRestart(filename);
}
};
const restartOnConfigChange = (filename) => {
if (filename === svelteConfigFile) {
triggerViteRestart(filename);
}
};
const listenerCollection = {

@@ -1414,7 +1417,20 @@ add: [],

};
if (svelteConfigFile) {
listenerCollection.change.push(restartOnConfigChange);
listenerCollection.unlink.push(restartOnConfigChange);
} else {
listenerCollection.add.push(restartOnConfigAdd);
if (svelteConfigFile !== false) {
const possibleSvelteConfigs = knownSvelteConfigNames.map((cfg) => path5.join(root, cfg));
const restartOnConfigAdd = (filename) => {
if (possibleSvelteConfigs.includes(filename)) {
triggerViteRestart(filename);
}
};
const restartOnConfigChange = (filename) => {
if (filename === svelteConfigFile) {
triggerViteRestart(filename);
}
};
if (svelteConfigFile) {
listenerCollection.change.push(restartOnConfigChange);
listenerCollection.unlink.push(restartOnConfigChange);
} else {
listenerCollection.add.push(restartOnConfigAdd);
}
}

@@ -1506,2 +1522,91 @@ Object.entries(listenerCollection).forEach(([evt, listeners]) => {

// src/ui/inspector/plugin.ts
import { createRequire as createRequire5 } from "module";
var defaultInspectorOptions = {
toggleKeyCombo: process.platform === "win32" ? "control-shift" : "meta-shift",
holdMode: false,
showToggleButton: "active",
toggleButtonPos: "top-right",
customStyles: true
};
function svelteInspector() {
let root;
let rootRequire;
let inspectorOptions;
let append_to;
return {
name: "vite-plugin-svelte:inspector",
apply: "serve",
enforce: "pre",
configResolved(config) {
var _a, _b, _c;
const vps = config.plugins.find((p) => p.name === "vite-plugin-svelte");
if ((_c = (_b = (_a = vps == null ? void 0 : vps.api) == null ? void 0 : _a.options) == null ? void 0 : _b.experimental) == null ? void 0 : _c.inspector) {
inspectorOptions = __spreadValues(__spreadValues({}, defaultInspectorOptions), vps.api.options.experimental.inspector);
}
if (!vps || !inspectorOptions) {
this.resolveId = this.load = this.transformIndexHtml = this.transform = () => {
};
} else {
root = config.root || process.cwd();
rootRequire = createRequire5(root);
if (vps.api.options.kit && !inspectorOptions.appendTo) {
const out_dir = vps.api.options.kit.outDir || ".svelte-kit";
inspectorOptions.appendTo = `${out_dir}/runtime/client/start.js`;
}
append_to = inspectorOptions.appendTo;
}
},
async resolveId(importee, importer, options) {
if (options == null ? void 0 : options.ssr) {
return;
}
if (importee === "virtual:svelte-inspector-options") {
return importee;
}
if (importee.startsWith("virtual:svelte-inspector:")) {
const file = importee.replace("virtual:svelte-inspector:", "@sveltejs/vite-plugin-svelte/src/ui/inspector/");
const path8 = rootRequire.resolve(file);
if (path8) {
return path8;
} else {
log.error.once(`failed to resolve ${file} for ${importee} from ${root}`);
}
}
},
load(id) {
if (id === "virtual:svelte-inspector-options") {
return `export default ${JSON.stringify(inspectorOptions ?? {})}`;
}
},
transform(code, id, options) {
if ((options == null ? void 0 : options.ssr) || !append_to) {
return;
}
if (id.endsWith(append_to)) {
return { code: `${code}
import 'virtual:svelte-inspector:load-inspector.ts'` };
}
},
transformIndexHtml(html) {
if (append_to) {
return;
}
return {
html,
tags: [
{
tag: "script",
injectTo: "body",
attrs: {
type: "module",
src: "/@id/virtual:svelte-inspector:load-inspector.ts"
}
}
]
};
}
};
}
// src/index.ts

@@ -1519,120 +1624,134 @@ function svelte(inlineOptions) {

let resolvedSvelteSSR;
return {
name: "vite-plugin-svelte",
enforce: "pre",
async config(config, configEnv) {
if (process.env.DEBUG) {
log.setLevel("debug");
} else if (config.logLevel) {
log.setLevel(config.logLevel);
}
options = await preResolveOptions(inlineOptions, config, configEnv);
const extraViteConfig = buildExtraViteConfig(options, config);
log.debug("additional vite config", extraViteConfig);
return extraViteConfig;
},
async configResolved(config) {
options = resolveOptions(options, config);
patchResolvedViteConfig(config, options);
requestParser = buildIdParser(options);
compileSvelte2 = createCompileSvelte(options);
viteConfig = config;
log.debug("resolved options", options);
},
async buildStart() {
if (!options.experimental.prebundleSvelteLibraries)
return;
const isSvelteMetadataChanged = await saveSvelteMetadata(viteConfig.cacheDir, options);
if (isSvelteMetadataChanged) {
viteConfig.server.force = true;
}
},
configureServer(server) {
options.server = server;
setupWatchers(options, cache, requestParser);
},
load(id, opts) {
const ssr = opts === true || (opts == null ? void 0 : opts.ssr);
const svelteRequest = requestParser(id, !!ssr);
if (svelteRequest) {
const { filename, query } = svelteRequest;
if (query.svelte && query.type === "style") {
const css = cache.getCSS(svelteRequest);
if (css) {
log.debug(`load returns css for ${filename}`);
return css;
const api = {};
const plugins = [
{
name: "vite-plugin-svelte",
enforce: "pre",
api,
async config(config, configEnv) {
if (process.env.DEBUG) {
log.setLevel("debug");
} else if (config.logLevel) {
log.setLevel(config.logLevel);
}
options = await preResolveOptions(inlineOptions, config, configEnv);
const extraViteConfig = buildExtraViteConfig(options, config);
log.debug("additional vite config", extraViteConfig);
return extraViteConfig;
},
async configResolved(config) {
options = resolveOptions(options, config);
patchResolvedViteConfig(config, options);
requestParser = buildIdParser(options);
compileSvelte2 = createCompileSvelte(options);
viteConfig = config;
api.options = options;
log.debug("resolved options", options);
},
async buildStart() {
var _a;
if (!((_a = options.experimental) == null ? void 0 : _a.prebundleSvelteLibraries))
return;
const isSvelteMetadataChanged = await saveSvelteMetadata(viteConfig.cacheDir, options);
if (isSvelteMetadataChanged) {
viteConfig.server.force = true;
}
},
configureServer(server) {
options.server = server;
setupWatchers(options, cache, requestParser);
},
load(id, opts) {
const ssr = opts === true || (opts == null ? void 0 : opts.ssr);
const svelteRequest = requestParser(id, !!ssr);
if (svelteRequest) {
const { filename, query } = svelteRequest;
if (query.svelte && query.type === "style") {
const css = cache.getCSS(svelteRequest);
if (css) {
log.debug(`load returns css for ${filename}`);
return css;
}
}
if (viteConfig.assetsInclude(filename)) {
log.debug(`load returns raw content for ${filename}`);
return fs7.readFileSync(filename, "utf-8");
}
}
if (viteConfig.assetsInclude(filename)) {
log.debug(`load returns raw content for ${filename}`);
return fs7.readFileSync(filename, "utf-8");
},
async resolveId(importee, importer, opts) {
const ssr = !!(opts == null ? void 0 : opts.ssr);
const svelteRequest = requestParser(importee, ssr);
if (svelteRequest == null ? void 0 : svelteRequest.query.svelte) {
if (svelteRequest.query.type === "style") {
log.debug(`resolveId resolved virtual css module ${svelteRequest.cssId}`);
return svelteRequest.cssId;
}
log.debug(`resolveId resolved ${importee}`);
return importee;
}
}
},
async resolveId(importee, importer, opts) {
const ssr = !!(opts == null ? void 0 : opts.ssr);
const svelteRequest = requestParser(importee, ssr);
if (svelteRequest == null ? void 0 : svelteRequest.query.svelte) {
if (svelteRequest.query.type === "style") {
log.debug(`resolveId resolved virtual css module ${svelteRequest.cssId}`);
return svelteRequest.cssId;
if (ssr && importee === "svelte") {
if (!resolvedSvelteSSR) {
resolvedSvelteSSR = this.resolve("svelte/ssr", void 0, { skipSelf: true }).then((svelteSSR) => {
log.debug("resolved svelte to svelte/ssr");
return svelteSSR;
}, (err) => {
log.debug("failed to resolve svelte to svelte/ssr. Update svelte to a version that exports it", err);
return null;
});
}
return resolvedSvelteSSR;
}
log.debug(`resolveId resolved ${importee}`);
return importee;
}
if (ssr && importee === "svelte") {
if (!resolvedSvelteSSR) {
resolvedSvelteSSR = this.resolve("svelte/ssr", void 0, { skipSelf: true }).then((svelteSSR) => {
log.debug("resolved svelte to svelte/ssr");
return svelteSSR;
}, (err) => {
log.debug("failed to resolve svelte to svelte/ssr. Update svelte to a version that exports it", err);
return null;
try {
const resolved = resolveViaPackageJsonSvelte(importee, importer, cache);
if (resolved) {
log.debug(`resolveId resolved ${resolved} via package.json svelte field of ${importee}`);
return resolved;
}
} catch (e) {
log.debug.once(`error trying to resolve ${importee} from ${importer} via package.json svelte field `, e);
}
},
async transform(code, id, opts) {
var _a;
const ssr = !!(opts == null ? void 0 : opts.ssr);
const svelteRequest = requestParser(id, ssr);
if (!svelteRequest || svelteRequest.query.svelte) {
return;
}
let compileData;
try {
compileData = await compileSvelte2(svelteRequest, code, options);
} catch (e) {
throw toRollupError(e, options);
}
logCompilerWarnings(compileData.compiled.warnings, options);
cache.update(compileData);
if (((_a = compileData.dependencies) == null ? void 0 : _a.length) && options.server) {
compileData.dependencies.forEach((d) => {
ensureWatchedFile(options.server.watcher, d, options.root);
});
}
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;
log.debug(`transform returns compiled js for ${svelteRequest.filename}`);
return __spreadProps(__spreadValues({}, compileData.compiled.js), {
meta: {
vite: {
lang: compileData.lang
}
}
});
},
handleHotUpdate(ctx) {
if (!options.hot || !options.emitCss) {
return;
}
} catch (e) {
log.debug.once(`error trying to resolve ${importee} from ${importer} via package.json svelte field `, e);
const svelteRequest = requestParser(ctx.file, false, ctx.timestamp);
if (svelteRequest) {
return handleHotUpdate(compileSvelte2, ctx, svelteRequest, cache, options);
}
}
},
async transform(code, id, opts) {
var _a;
const ssr = !!(opts == null ? void 0 : opts.ssr);
const svelteRequest = requestParser(id, ssr);
if (!svelteRequest || svelteRequest.query.svelte) {
return;
}
let compileData;
try {
compileData = await compileSvelte2(svelteRequest, code, options);
} catch (e) {
throw toRollupError(e, options);
}
logCompilerWarnings(compileData.compiled.warnings, options);
cache.update(compileData);
if (((_a = compileData.dependencies) == null ? void 0 : _a.length) && options.server) {
compileData.dependencies.forEach((d) => {
ensureWatchedFile(options.server.watcher, d, options.root);
});
}
log.debug(`transform returns compiled js for ${svelteRequest.filename}`);
return compileData.compiled.js;
},
handleHotUpdate(ctx) {
if (!options.hot || !options.emitCss) {
return;
}
const svelteRequest = requestParser(ctx.file, false, ctx.timestamp);
if (svelteRequest) {
return handleHotUpdate(compileSvelte2, ctx, svelteRequest, cache, options);
}
}
};
];
plugins.push(svelteInspector());
return plugins.filter(Boolean);
}

@@ -1639,0 +1758,0 @@ export {

{
"name": "@sveltejs/vite-plugin-svelte",
"version": "1.0.0-next.42",
"version": "1.0.0-next.43",
"license": "MIT",

@@ -22,3 +22,4 @@ "author": "dominikg",

},
"./package.json": "./package.json"
"./package.json": "./package.json",
"./src/ui/*": "./src/ui/*"
},

@@ -46,2 +47,3 @@ "engines": {

"debug": "^4.3.4",
"deepmerge": "^4.2.2",
"kleur": "^4.1.4",

@@ -69,3 +71,3 @@ "magic-string": "^0.26.1",

"tsup": "^5.12.5",
"vite": "^2.9.5"
"vite": "^2.9.8"
},

@@ -72,0 +74,0 @@ "scripts": {

@@ -23,4 +23,15 @@ import fs from 'fs';

import { saveSvelteMetadata } from './utils/optimizer';
import { svelteInspector } from './ui/inspector/plugin';
export function svelte(inlineOptions?: Partial<Options>): Plugin {
interface PluginAPI {
/**
* must not be modified, should not be used outside of vite-plugin-svelte repo
* @internal
* @experimental
*/
options?: ResolvedOptions;
// TODO expose compile cache here so other utility plugins can use it
}
export function svelte(inlineOptions?: Partial<Options>): Plugin[] {
if (process.env.DEBUG != null) {

@@ -44,151 +55,167 @@ log.setLevel('debug');

let resolvedSvelteSSR: Promise<PartialResolvedId | null>;
const api: PluginAPI = {};
const plugins: Plugin[] = [
{
name: 'vite-plugin-svelte',
// make sure our resolver runs before vite internal resolver to resolve svelte field correctly
enforce: 'pre',
api,
async config(config, configEnv): Promise<Partial<UserConfig>> {
// setup logger
if (process.env.DEBUG) {
log.setLevel('debug');
} else if (config.logLevel) {
log.setLevel(config.logLevel);
}
// @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);
log.debug('additional vite config', extraViteConfig);
return extraViteConfig;
},
return {
name: 'vite-plugin-svelte',
// make sure our resolver runs before vite internal resolver to resolve svelte field correctly
enforce: 'pre',
async config(config, configEnv): Promise<Partial<UserConfig>> {
// setup logger
if (process.env.DEBUG) {
log.setLevel('debug');
} else if (config.logLevel) {
log.setLevel(config.logLevel);
}
// @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);
log.debug('additional vite config', extraViteConfig);
return extraViteConfig;
},
async configResolved(config) {
options = resolveOptions(options, config);
patchResolvedViteConfig(config, options);
requestParser = buildIdParser(options);
compileSvelte = createCompileSvelte(options);
viteConfig = config;
// TODO deep clone to avoid mutability from outside?
api.options = options;
log.debug('resolved options', options);
},
async configResolved(config) {
options = resolveOptions(options, config);
patchResolvedViteConfig(config, options);
requestParser = buildIdParser(options);
compileSvelte = createCompileSvelte(options);
viteConfig = config;
log.debug('resolved options', options);
},
async buildStart() {
if (!options.experimental?.prebundleSvelteLibraries) return;
const isSvelteMetadataChanged = await saveSvelteMetadata(viteConfig.cacheDir, options);
if (isSvelteMetadataChanged) {
// Force Vite to optimize again. Although we mutate the config here, it works because
// Vite's optimizer runs after `buildStart()`.
viteConfig.server.force = true;
}
},
async buildStart() {
if (!options.experimental.prebundleSvelteLibraries) return;
const isSvelteMetadataChanged = await saveSvelteMetadata(viteConfig.cacheDir, options);
if (isSvelteMetadataChanged) {
// Force Vite to optimize again. Although we mutate the config here, it works because
// Vite's optimizer runs after `buildStart()`.
viteConfig.server.force = true;
}
},
configureServer(server) {
// eslint-disable-next-line no-unused-vars
options.server = server;
setupWatchers(options, cache, requestParser);
},
configureServer(server) {
// eslint-disable-next-line no-unused-vars
options.server = server;
setupWatchers(options, cache, requestParser);
},
load(id, opts) {
// @ts-expect-error anticipate vite changing second parameter as options object
// see https://github.com/vitejs/vite/discussions/5109
const ssr: boolean = opts === true || opts?.ssr;
const svelteRequest = requestParser(id, !!ssr);
if (svelteRequest) {
const { filename, query } = svelteRequest;
// virtual css module
if (query.svelte && query.type === 'style') {
const css = cache.getCSS(svelteRequest);
if (css) {
log.debug(`load returns css for ${filename}`);
return css;
}
}
// prevent vite asset plugin from loading files as url that should be compiled in transform
if (viteConfig.assetsInclude(filename)) {
log.debug(`load returns raw content for ${filename}`);
return fs.readFileSync(filename, 'utf-8');
}
}
},
load(id, opts) {
// @ts-expect-error anticipate vite changing second parameter as options object
// see https://github.com/vitejs/vite/discussions/5109
const ssr: boolean = opts === true || opts?.ssr;
const svelteRequest = requestParser(id, !!ssr);
if (svelteRequest) {
const { filename, query } = svelteRequest;
// virtual css module
if (query.svelte && query.type === 'style') {
const css = cache.getCSS(svelteRequest);
if (css) {
log.debug(`load returns css for ${filename}`);
return css;
async resolveId(importee, importer, opts) {
const ssr = !!opts?.ssr;
const svelteRequest = requestParser(importee, ssr);
if (svelteRequest?.query.svelte) {
if (svelteRequest.query.type === 'style') {
// return cssId with root prefix so postcss pipeline of vite finds the directory correctly
// see https://github.com/sveltejs/vite-plugin-svelte/issues/14
log.debug(`resolveId resolved virtual css module ${svelteRequest.cssId}`);
return svelteRequest.cssId;
}
log.debug(`resolveId resolved ${importee}`);
return importee; // query with svelte tag, an id we generated, no need for further analysis
}
// prevent vite asset plugin from loading files as url that should be compiled in transform
if (viteConfig.assetsInclude(filename)) {
log.debug(`load returns raw content for ${filename}`);
return fs.readFileSync(filename, 'utf-8');
if (ssr && importee === 'svelte') {
if (!resolvedSvelteSSR) {
resolvedSvelteSSR = this.resolve('svelte/ssr', undefined, { skipSelf: true }).then(
(svelteSSR) => {
log.debug('resolved svelte to svelte/ssr');
return svelteSSR;
},
(err) => {
log.debug(
'failed to resolve svelte to svelte/ssr. Update svelte to a version that exports it',
err
);
return null; // returning null here leads to svelte getting resolved regularly
}
);
}
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 (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 resolveId(importee, importer, opts) {
const ssr = !!opts?.ssr;
const svelteRequest = requestParser(importee, ssr);
if (svelteRequest?.query.svelte) {
if (svelteRequest.query.type === 'style') {
// return cssId with root prefix so postcss pipeline of vite finds the directory correctly
// see https://github.com/sveltejs/vite-plugin-svelte/issues/14
log.debug(`resolveId resolved virtual css module ${svelteRequest.cssId}`);
return svelteRequest.cssId;
async transform(code, id, opts) {
const ssr = !!opts?.ssr;
const svelteRequest = requestParser(id, ssr);
if (!svelteRequest || svelteRequest.query.svelte) {
return;
}
log.debug(`resolveId resolved ${importee}`);
return importee; // query with svelte tag, an id we generated, no need for further analysis
}
let compileData;
try {
compileData = await compileSvelte(svelteRequest, code, options);
} catch (e) {
throw toRollupError(e, options);
}
logCompilerWarnings(compileData.compiled.warnings, options);
cache.update(compileData);
if (compileData.dependencies?.length && options.server) {
compileData.dependencies.forEach((d) => {
ensureWatchedFile(options.server!.watcher, d, options.root);
});
}
log.debug(`transform returns compiled js for ${svelteRequest.filename}`);
return {
...compileData.compiled.js,
meta: {
vite: {
lang: compileData.lang
}
}
};
},
if (ssr && importee === 'svelte') {
if (!resolvedSvelteSSR) {
resolvedSvelteSSR = this.resolve('svelte/ssr', undefined, { skipSelf: true }).then(
(svelteSSR) => {
log.debug('resolved svelte to svelte/ssr');
return svelteSSR;
},
(err) => {
log.debug(
'failed to resolve svelte to svelte/ssr. Update svelte to a version that exports it',
err
);
return null; // returning null here leads to svelte getting resolved regularly
}
);
handleHotUpdate(ctx: HmrContext): void | Promise<Array<ModuleNode> | void> {
if (!options.hot || !options.emitCss) {
return;
}
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;
const svelteRequest = requestParser(ctx.file, false, ctx.timestamp);
if (svelteRequest) {
return handleHotUpdate(compileSvelte, ctx, svelteRequest, cache, options);
}
} 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 || svelteRequest.query.svelte) {
return;
}
let compileData;
try {
compileData = await compileSvelte(svelteRequest, code, options);
} catch (e) {
throw toRollupError(e, options);
}
logCompilerWarnings(compileData.compiled.warnings, options);
cache.update(compileData);
if (compileData.dependencies?.length && options.server) {
compileData.dependencies.forEach((d) => {
ensureWatchedFile(options.server!.watcher, d, options.root);
});
}
log.debug(`transform returns compiled js for ${svelteRequest.filename}`);
return compileData.compiled.js;
},
handleHotUpdate(ctx: HmrContext): void | Promise<Array<ModuleNode> | void> {
if (!options.hot || !options.emitCss) {
return;
}
const svelteRequest = requestParser(ctx.file, false, ctx.timestamp);
if (svelteRequest) {
return handleHotUpdate(compileSvelte, ctx, svelteRequest, cache, options);
}
}
};
];
plugins.push(svelteInspector());
return plugins.filter(Boolean);
}

@@ -195,0 +222,0 @@

@@ -9,2 +9,4 @@ import { CompileOptions, ResolvedOptions } from './options';

const scriptLangRE = /<script [^>]*lang=["']?([^"' >]+)["']?[^>]*>/;
const _createCompileSvelte = (makeHot: Function) =>

@@ -92,2 +94,3 @@ async function compileSvelte(

normalizedFilename,
lang: code.match(scriptLangRE)?.[1] || 'js',
// @ts-ignore

@@ -153,2 +156,3 @@ compiled,

normalizedFilename: string;
lang: string;
compiled: Compiled;

@@ -155,0 +159,0 @@ ssr: boolean | undefined;

@@ -27,2 +27,3 @@ /* eslint-disable no-unused-vars */

import { addExtraPreprocessors } from './preprocess';
import deepmerge from 'deepmerge';

@@ -41,3 +42,4 @@ const knownOptions = new Set([

'disableDependencyReinclusion',
'experimental'
'experimental',
'kit'
]);

@@ -70,17 +72,3 @@

const svelteConfig = await loadSvelteConfig(viteConfigWithResolvedRoot, inlineOptions);
const merged = {
...defaultOptions,
...svelteConfig,
...inlineOptions,
compilerOptions: {
...defaultOptions?.compilerOptions,
...svelteConfig?.compilerOptions,
...inlineOptions?.compilerOptions
},
experimental: {
...defaultOptions?.experimental,
...svelteConfig?.experimental,
...inlineOptions?.experimental
},
// extras
const extraOptions: Partial<PreResolvedOptions> = {
root: viteConfigWithResolvedRoot.root!,

@@ -91,2 +79,9 @@ isBuild: viteEnv.command === 'build',

};
const merged = mergeConfigs<Partial<PreResolvedOptions> | undefined>(
defaultOptions,
svelteConfig,
inlineOptions,
extraOptions
);
// configFile of svelteConfig contains the absolute path it was loaded from,

@@ -100,2 +95,13 @@ // prefer it over the possibly relative inline path

function mergeConfigs<T>(...configs: T[]): ResolvedOptions {
let result = {};
for (const config of configs.filter(Boolean)) {
result = deepmerge<T>(result, config, {
// replace arrays
arrayMerge: (target: any[], source: any[]) => source ?? target
});
}
return result as ResolvedOptions;
}
// used in configResolved phase, merges a contextual default config, pre-resolved options, and some preprocessors.

@@ -114,12 +120,8 @@ // also validates the final config.

};
const merged: ResolvedOptions = {
...defaultOptions,
...preResolveOptions,
compilerOptions: {
...defaultOptions.compilerOptions,
...preResolveOptions.compilerOptions
},
const extraOptions: Partial<ResolvedOptions> = {
root: viteConfig.root,
isProduction: viteConfig.isProduction
};
const merged: ResolvedOptions = mergeConfigs(defaultOptions, preResolveOptions, extraOptions);
addExtraPreprocessors(merged, viteConfig);

@@ -216,3 +218,3 @@ enforceOptionsForHmr(merged);

if (options.experimental.prebundleSvelteLibraries) {
if (options.experimental?.prebundleSvelteLibraries) {
extraViteConfig.optimizeDeps = {

@@ -266,3 +268,3 @@ ...extraViteConfig.optimizeDeps,

// If we prebundle svelte libraries, we can skip the whole prebundling dance below
if (options.experimental.prebundleSvelteLibraries) {
if (options.experimental?.prebundleSvelteLibraries) {
return { include, exclude };

@@ -366,3 +368,3 @@ }

*
* set to `false` to skip reading config from a file
* set to `false` to ignore the svelte config file
*

@@ -521,4 +523,53 @@ * @see https://vitejs.dev/config/#root

}) => Promise<Partial<CompileOptions> | void> | Partial<CompileOptions> | void;
/**
* enable svelte inspector
*/
inspector?: InspectorOptions | boolean;
}
export interface InspectorOptions {
/**
* define a key combo to toggle inspector,
* @default 'control-shift' on windows, 'meta-shift' on other os
*
* any number of modifiers `control` `shift` `alt` `meta` followed by zero or one regular key, separated by -
* examples: control-shift, control-o, control-alt-s meta-x control-meta
* Some keys have native behavior (e.g. alt-s opens history menu on firefox).
* To avoid conflicts or accidentally typing into inputs, modifier only combinations are recommended.
*/
toggleKeyCombo?: string;
/**
* inspector is automatically disabled when releasing toggleKeyCombo after holding it for a longpress
* @default false
*/
holdMode?: boolean;
/**
* when to show the toggle button
* @default 'active'
*/
showToggleButton?: 'always' | 'active' | 'never';
/**
* where to display the toggle button
* @default top-right
*/
toggleButtonPos?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left';
/**
* inject custom styles when inspector is active
*/
customStyles?: boolean;
/**
* append an import to the module id ending with `appendTo` instead of adding a script into body
* useful for frameworks that do not support trannsformIndexHtml hook
*
* WARNING: only set this if you know exactly what it does.
* Regular users of vite-plugin-svelte or SvelteKit do not need it
*/
appendTo?: string;
}
export interface PreResolvedOptions extends Options {

@@ -525,0 +576,0 @@ // these options are non-nullable after resolve

@@ -61,15 +61,2 @@ import { VitePluginSvelteCache } from './vite-plugin-svelte-cache';

const possibleSvelteConfigs = knownSvelteConfigNames.map((cfg) => path.join(root, cfg));
const restartOnConfigAdd = (filename: string) => {
if (possibleSvelteConfigs.includes(filename)) {
triggerViteRestart(filename);
}
};
const restartOnConfigChange = (filename: string) => {
if (filename === svelteConfigFile) {
triggerViteRestart(filename);
}
};
// collection of watcher listeners by event

@@ -81,7 +68,24 @@ const listenerCollection = {

};
if (svelteConfigFile) {
listenerCollection.change.push(restartOnConfigChange);
listenerCollection.unlink.push(restartOnConfigChange);
} else {
listenerCollection.add.push(restartOnConfigAdd);
if (svelteConfigFile !== false) {
// configFile false means we ignore the file and external process is responsible
const possibleSvelteConfigs = knownSvelteConfigNames.map((cfg) => path.join(root, cfg));
const restartOnConfigAdd = (filename: string) => {
if (possibleSvelteConfigs.includes(filename)) {
triggerViteRestart(filename);
}
};
const restartOnConfigChange = (filename: string) => {
if (filename === svelteConfigFile) {
triggerViteRestart(filename);
}
};
if (svelteConfigFile) {
listenerCollection.change.push(restartOnConfigChange);
listenerCollection.unlink.push(restartOnConfigChange);
} else {
listenerCollection.add.push(restartOnConfigAdd);
}
}

@@ -88,0 +92,0 @@

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet

Sorry, the diff of this file is not supported yet