sv-router 0.11.0 → 0.12.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sv-router",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Modern Svelte Routing",
   "keywords": [
     "svelte",
@@ -36,29 +36,29 @@
     "esm-env": "^1.2.2"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.29.7",
-    "@eslint/js": "^9.39.0",
+    "@changesets/cli": "^2.29.8",
+    "@eslint/js": "^9.39.1",
     "@sveltejs/vite-plugin-svelte": "^6.2.1",
     "@testing-library/jest-dom": "^6.9.1",
-    "@testing-library/svelte": "^5.2.8",
+    "@testing-library/svelte": "^5.2.9",
     "@testing-library/user-event": "^14.6.1",
-    "@types/node": "^24.9.2",
-    "eslint": "^9.39.0",
+    "@types/node": "^24.10.1",
+    "eslint": "^9.39.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-simple-import-sort": "^12.1.1",
-    "eslint-plugin-svelte": "^3.13.0",
+    "eslint-plugin-svelte": "^3.13.1",
     "eslint-plugin-unicorn": "^62.0.0",
     "globals": "^16.5.0",
-    "happy-dom": "^20.0.10",
-    "prettier": "^3.6.2",
-    "prettier-plugin-jsdoc": "^1.5.0",
+    "happy-dom": "^20.0.11",
+    "prettier": "^3.7.4",
+    "prettier-plugin-jsdoc": "^1.8.0",
     "prettier-plugin-svelte": "^3.4.0",
-    "svelte-check": "^4.3.3",
+    "svelte-check": "^4.3.4",
     "type-testing": "^0.2.0",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.46.2",
-    "vite": "^7.1.12",
-    "vitest": "^4.0.6"
+    "typescript-eslint": "^8.48.1",
+    "vite": "^7.2.6",
+    "vitest": "^4.0.15"
   },
   "peerDependencies": {
     "svelte": "^5"

package/src/cli/index.js

@@ -1,13 +1,76 @@
 #!/usr/bin/env node
+/* eslint-disable no-console */
 
+import { existsSync, readFileSync } from 'node:fs';
+import path from 'node:path';
 import { genConfig } from '../gen/config.js';
 import { writeRouterCode } from '../gen/write-router-code.js';
 
 const args = process.argv.slice(2).flatMap((arg) => arg.split('='));
 
+if (args.length > 0) {
+	parseArgs();
+} else {
+	parseViteConfig();
+}
+
+writeRouterCode();
+
+function parseViteConfig() {
+	const viteConfig = readViteConfig('ts') || readViteConfig('js');
+	if (!viteConfig) return;
+	const routerConfig = extractRouterConfig(viteConfig);
+	if (!routerConfig) return;
+	console.log('ℹ️ Using router plugin options from Vite config');
+	if (routerConfig.allLazy) genConfig.allLazy = routerConfig.allLazy;
+	if (routerConfig.js) genConfig.routesInJs = routerConfig.js;
+	if (routerConfig.path) genConfig.routesPath = routerConfig.path;
+	if (routerConfig.ignore) genConfig.ignore = routerConfig.ignore;
+}
+
+/**
+ * @param {'js' | 'ts'} extension
+ * @returns {string | undefined}
+ */
+function readViteConfig(extension) {
+	const vitePath = path.join(process.cwd(), 'vite.config.' + extension);
+	if (existsSync(vitePath)) {
+		return readFileSync(vitePath, 'utf8');
+	}
+}
+
+/**
+ * @param {string} viteConfig
+ * @returns {import('../vite-plugin/index.d.ts').RouterOptions | undefined}
+ */
+function extractRouterConfig(viteConfig) {
+	const regex = /router\(\s*([^)]+)\)/;
+	const match = viteConfig.match(regex);
+	if (!match) return;
+	try {
+		return new Function(`return ${match[1]}`)();
+	} catch (error) {
+		console.error('⚠️ Error parsing router config:', error);
+	}
+}
+
+function parseArgs() {
+	const allLazyArg = arg('allLazy');
+	if (allLazyArg) genConfig.allLazy = true;
+
+	const jsArg = arg('js');
+	if (jsArg) genConfig.routesInJs = true;
+
+	const pathArg = arg('path');
+	if (pathArg) genConfig.routesPath = pathArg;
+
+	const ignoreArg = arg('ignore');
+	if (ignoreArg) genConfig.ignore = ignoreArg.split(',').map((ignore) => new RegExp(ignore, 'gu'));
+}
+
 /**
  * @param {keyof import('../vite-plugin/index.d.ts').RouterOptions} option
- * @returns
+ * @returns {string | undefined}
  */
 function arg(option) {
 	const pathArgIndex = args.indexOf('--' + option);
@@ -17,17 +80,3 @@ function arg(option) {
 	}
 	return args[pathArgIndex];
 }
-
-const allLazyArg = arg('allLazy');
-if (allLazyArg) genConfig.allLazy = true;
-
-const jsArg = arg('js');
-if (jsArg) genConfig.routesInJs = true;
-
-const pathArg = arg('path');
-if (pathArg) genConfig.routesPath = pathArg;
-
-const ignoreArg = arg('ignore');
-if (ignoreArg) genConfig.ignore = ignoreArg.split(',').map((ignore) => new RegExp(ignore, 'gu'));
-
-writeRouterCode();

package/src/create-router.svelte.js

@@ -134,7 +134,7 @@ function navigate(path, options = {}) {
 
 	path = constructPath(path, options.params);
 	if (base.name === '#') {
-		path = new URL(path).hash;
+		path = path.replace('/#', '');
 	} else if (options.hash && !options.hash.startsWith('#')) {
 		options.hash = '#' + options.hash;
 	}
@@ -200,8 +200,10 @@ export async function onNavigate(path, options = {}) {
 		url.hash = options.hash || '';
 		if (base.name === '#') {
 			url.hash = path;
+		} else if (base.name && !path.startsWith(base.name)) {
+			url.pathname = join(base.name, path);
 		} else {
-			url.pathname = base.name ? join(base.name, path) : path;
+			url.pathname = path;
 		}
 		const historyMethod = options.replace ? 'replaceState' : 'pushState';
 		globalThis.history[historyMethod](options.state || {}, '', url.toString());

package/src/gen/generate-router-code.js

@@ -5,11 +5,12 @@ import path from 'node:path';
 
 /**
  * @typedef {{
- * 	[key: string]: string | GeneratedRoutes;
+ * 	[key: string]: string | string[] | GeneratedRoutes;
  * }} GeneratedRoutes
  */
 
 const FILENAME_REGEX = /(?<=[/.]|^)\(?([\w-]+)\)?(\.lazy)?\.svelte$/; // any.svelte, any.lazy.svelte, (any).svelte
+const INDEX_FILENAME_REGEX = /(?<=[/.]|^)\(?index\)?(\.lazy)?\.svelte$/; // index.svelte, index.lazy.svelte, (index).svelte
 const PARAM_FILENAME_REGEX = /(?<=[/.]|^)\(?\[([\w-]+)\]\)?(\.lazy)?\.svelte$/; // [any].svelte, [any].lazy.svelte, ([any]).svelte
 const CATCH_ALL_FILENAME_REGEX = /(?<=[/.]|^)\(?\[\.\.\.([\w-]+)\]\)?(\.lazy)?\.svelte$/; // [...any].svelte, [...any].lazy.svelte, ([...any]).svelte
 const OUT_OF_LAYOUT_FILENAME_REGEX = /(?<=[/.]|^)\(\[\.?\.?\.?([\w-]+)\]\)(\.lazy)?\.svelte$/; // ([any]).svelte, ([...any]).lazy.svelte
@@ -81,8 +82,9 @@ export function createRouteMap(fileTree, prefix = '') {
 				continue;
 			}
 
-			if (entry.endsWith('index.svelte') || entry.endsWith('index.lazy.svelte')) {
-				const indexEntry = entry.replace(/\.?index(\.lazy)?\.svelte/, '');
+			if (INDEX_FILENAME_REGEX.test(entry)) {
+				const replacement = /\.?\(index\)(\.lazy)?\.svelte/.test(entry) ? '()' : '';
+				const indexEntry = entry.replace(/\.?\(?index\)?(\.lazy)?\.svelte/, replacement);
 				result['/' + (indexEntry ? filePathToRoute(indexEntry) : '')] = prefix + entry;
 				continue;
 			}
@@ -144,22 +146,28 @@ function mergeRouteGroup(result, childMap) {
 	const layout = childMap.layout;
 	const hooks = childMap.hooks;
 	const meta = childMap.meta;
+	const hasRootRoute = '/' in childMap;
 
 	for (const [key, val] of Object.entries(childMap)) {
 		if (key === 'layout' || key === 'hooks' || key === 'meta') {
 			continue;
 		}
 
+		const childMeta =
+			typeof val === 'object' && !Array.isArray(val) && 'meta' in val ? val.meta : undefined;
+		const mergedMeta =
+			childMeta && meta && !hasRootRoute ? [childMeta, meta].flat() : childMeta || meta;
+
 		/** @type {GeneratedRoutes} */
 		let routeWithGroupFiles = {};
 		if (typeof val === 'string') {
 			routeWithGroupFiles = { '/': val };
-		} else {
+		} else if (!Array.isArray(val)) {
 			routeWithGroupFiles = { ...val };
 		}
-		if (layout) routeWithGroupFiles.layout = layout;
-		if (hooks) routeWithGroupFiles.hooks = hooks;
-		if (meta) routeWithGroupFiles.meta = meta;
+		if (layout) routeWithGroupFiles.layout = /** @type {string} */ (layout);
+		if (hooks) routeWithGroupFiles.hooks = /** @type {string} */ (hooks);
+		if (mergedMeta) routeWithGroupFiles.meta = /** @type {string | string[]} */ (mergedMeta);
 		if (result[key]) {
 			throw new Error(`Route conflict at \`${key}\``);
 		}
@@ -186,12 +194,18 @@ export function createRouterCode(routes, routesPath, { allLazy = false, js = fal
 		/** @type {GeneratedRoutes} */
 		const result = {};
 		for (const [key, value] of Object.entries(routes)) {
-			if (typeof value === 'object') {
+			if (typeof value === 'object' && !Array.isArray(value)) {
 				result[key] = handleImports(value, routesPath);
+			} else if (key === 'meta' && Array.isArray(value)) {
+				const varNames = value.map((metaPath) => {
+					const variableName = pathToCorrectCasing(metaPath);
+					importsMap.set(variableName, routesPath + metaPath);
+					return variableName;
+				});
+				result[key] = `{ ...${varNames.toReversed().join(', ...')} }`;
 			} else if (
-				key === 'hooks' ||
-				key === 'meta' ||
-				(!value.endsWith('.lazy.svelte') && !allLazy)
+				typeof value === 'string' &&
+				(key === 'hooks' || key === 'meta' || (!value.endsWith('.lazy.svelte') && !allLazy))
 			) {
 				const variableName = pathToCorrectCasing(value);
 				importsMap.set(variableName, routesPath + value);

package/src/gen/write-router-code.js

@@ -40,13 +40,13 @@ export function writeRouterCode() {
 		const written = writeFileIfDifferent(genConfig.routerPath, routerCode);
 
 		if (written) {
-			console.log('✅️ Routes generated');
+			console.log('❇️ Routes generated');
 		} else {
 			console.log('✅️ Routes already up to date');
 		}
 	} catch (error) {
 		console.error(
-			'Error during routes generation:',
+			'⚠️ Error during routes generation:',
 			error instanceof Error ? error.message : String(error),
 		);
 	}

package/src/helpers/is-active.js

@@ -1,5 +1,5 @@
 import { base, location } from '../create-router.svelte.js';
-import { constructPath, join } from './utils.js';
+import { constructPath } from './utils.js';
 
 /**
  * @param {string} pathname
@@ -7,8 +7,7 @@ import { constructPath, join } from './utils.js';
  * @returns {boolean}
  */
 export function isActive(pathname, params) {
-	const p = base.name && base.name !== '#' ? join(base.name, pathname) : pathname;
-	return compare((a, b) => a === b, p, params);
+	return compare((a, b) => a === b, pathname, params);
 }
 
 /**
@@ -17,8 +16,7 @@ export function isActive(pathname, params) {
  * @returns {boolean}
  */
 isActive.startsWith = (pathname, params) => {
-	const p = base.name && base.name !== '#' ? join(base.name, pathname) : pathname;
-	return compare((a, b) => a.startsWith(b), p, params);
+	return compare((a, b) => a.startsWith(b), pathname, params);
 };
 
 /**
@@ -34,7 +32,7 @@ function compare(compareFn, pathname, params) {
 
 	if (params) {
 		if (base.name === '#') {
-			return compareFn(location.pathname, new URL(constructPath(pathname, params)).hash.slice(1));
+			return compareFn(location.pathname, constructPath(pathname, params).replace('/#', ''));
 		} else {
 			return compareFn(location.pathname, constructPath(pathname, params));
 		}

package/src/helpers/match-route.js

@@ -45,6 +45,11 @@ export function matchRoute(pathname, routes) {
 	/** @type {RouteMeta} */
 	let meta = {};
 
+	const rootRoute = routes['/'];
+	if (rootRoute && typeof rootRoute === 'object' && 'meta' in rootRoute && rootRoute.meta) {
+		meta = { ...meta, ...rootRoute.meta };
+	}
+
 	let breakFromLayouts = false;
 
 	outer: for (const route of allRoutes) {
@@ -76,7 +81,7 @@ export function matchRoute(pathname, routes) {
 				);
 				match = /** @type {RouteComponent} */ (routes[resolvedPath]);
 				break outer;
-			} else if (routePart !== pathPart?.toLowerCase()) {
+			} else if (routePart.toLowerCase() !== pathPart?.toLowerCase()) {
 				break;
 			}
 
@@ -88,6 +93,10 @@ export function matchRoute(pathname, routes) {
 				routes[/** @type {keyof Routes} */ ('/' + routeParts.join('/'))]
 			);
 
+			if (typeof routeMatch === 'function' && routeParts.length !== pathParts.length) {
+				continue;
+			}
+
 			if (!breakFromLayouts && 'layout' in routes && routes.layout) {
 				layouts.push(routes.layout);
 			}

package/src/helpers/utils.js

@@ -13,11 +13,12 @@ export function constructPath(path, params) {
 	}
 
 	if (base.name === '#') {
-		const url = new URL(globalThis.location.toString());
-		url.hash = path;
-		url.search = '';
-
-		return url.toString();
+		if (path === '/') {
+			return '/#/';
+		}
+		return join('#', path);
+	} else if (base.name) {
+		return join(base.name, path);
 	}
 
 	return path;