sv-router 0.10.5 → 0.11.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sv-router",
-  "version": "0.10.5",
+  "version": "0.11.1",
   "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

@@ -27,4 +27,7 @@ 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/config.js

@@ -1,22 +1,24 @@
 /**
  * @type {{
  * 	allLazy: boolean;
- * 	routesInJs: boolean;
- * 	routesPath: string;
+ * 	ignore: RegExp[];
+ * 	readonly genCodeAlias: string;
  * 	readonly genCodeDirPath: string;
  * 	readonly routerPath: string;
  * 	readonly tsconfigPath: string;
- * 	readonly genCodeAlias: string;
+ * 	routesInJs: boolean;
+ * 	routesPath: string;
  * }}
  */
 export const genConfig = {
 	allLazy: false,
-	routesInJs: false,
-	routesPath: 'src/routes',
+	genCodeAlias: 'sv-router/generated',
 	genCodeDirPath: '.router',
+	ignore: [],
 	get routerPath() {
 		return '.router/router.' + (this.routesInJs ? 'js' : 'ts');
 	},
+	routesInJs: false,
+	routesPath: 'src/routes',
 	tsconfigPath: '.router/tsconfig.json',
-	genCodeAlias: 'sv-router/generated',
 };

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

@@ -5,7 +5,7 @@ import path from 'node:path';
 
 /**
  * @typedef {{
- * 	[key: string]: string | GeneratedRoutes;
+ * 	[key: string]: string | string[] | GeneratedRoutes;
  * }} GeneratedRoutes
  */
 
@@ -18,7 +18,7 @@ const META_FILENAME_REGEX = /(?<=[/.]|^)(meta)(\.svelte)?\.(js|ts)$/; // meta.js
 
 /**
  * @param {string} routesPath
- * @param {{ allLazy?: boolean; js?: boolean }} [options]
+ * @param {{ allLazy?: boolean; js?: boolean; ignore?: RegExp[] }} [options]
  * @returns {string}
  */
 export function generateRouterCode(routesPath, options) {
@@ -26,29 +26,31 @@ export function generateRouterCode(routesPath, options) {
 	if (!fs.existsSync(absoluteRoutesPath)) {
 		throw new Error(`Routes directory not found at \`${routesPath}\``);
 	}
-	const fileTree = buildFileTree(absoluteRoutesPath);
+	const fileTree = buildFileTree(absoluteRoutesPath, options?.ignore ?? []);
 	const routeMap = createRouteMap(fileTree);
 	return createRouterCode(routeMap, path.posix.join('..', routesPath), options);
 }
 
 /**
  * @param {string} routesPath
+ * @param {RegExp[]} ignores
  * @returns {FileTree}
  */
-export function buildFileTree(routesPath) {
+export function buildFileTree(routesPath, ignores) {
 	const entries = fs.readdirSync(routesPath);
 	/** @type {FileTree} */
 	const tree = [];
 	for (const entry of entries) {
 		const stat = fs.lstatSync(path.join(routesPath, entry));
 		if (stat.isDirectory()) {
-			tree.push({ name: entry, tree: buildFileTree(path.join(routesPath, entry)) });
+			tree.push({ name: entry, tree: buildFileTree(path.join(routesPath, entry), ignores) });
 			continue;
 		}
 		if (
-			!entry.endsWith('.svelte') &&
-			!HOOKS_FILENAME_REGEX.test(entry) &&
-			!META_FILENAME_REGEX.test(entry)
+			(!entry.endsWith('.svelte') &&
+				!HOOKS_FILENAME_REGEX.test(entry) &&
+				!META_FILENAME_REGEX.test(entry)) ||
+			ignores.some((ignore) => ignore.test(entry))
 		) {
 			continue;
 		}
@@ -142,22 +144,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}\``);
 		}
@@ -184,12 +192,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

@@ -35,6 +35,7 @@ export function writeRouterCode() {
 		const routerCode = generateRouterCode(genConfig.routesPath, {
 			allLazy: genConfig.allLazy,
 			js: genConfig.routesInJs,
+			ignore: genConfig.ignore,
 		});
 		const written = writeFileIfDifferent(genConfig.routerPath, routerCode);
 

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) {

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;

package/src/vite-plugin/index.d.ts

@@ -19,6 +19,12 @@ export type RouterOptions = {
 	 * @default 'src/routes'
 	 */
 	path?: string;
+	/**
+	 * Regular expressions for files to ignore when generating routes.
+	 *
+	 * @default empty array
+	 */
+	ignore?: RegExp[];
 };
 
 export const router: (options?: RouterOptions) => Plugin;

package/src/vite-plugin/plugin.js

@@ -8,6 +8,7 @@ import { writeRouterCode } from '../gen/write-router-code.js';
  */
 export function router(options) {
 	genConfig.allLazy = options?.allLazy || false;
+	genConfig.ignore = options?.ignore || [];
 	genConfig.routesInJs = options?.js || false;
 	genConfig.routesPath = options?.path || 'src/routes';