sv-router 0.10.4 → 0.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sv-router",
-  "version": "0.10.4",
+  "version": "0.11.0",
   "description": "Modern Svelte Routing",
   "keywords": [
     "svelte",

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

@@ -26,7 +26,17 @@ export const base = {
 /** @type {{ value: import('svelte').Component[] }} */
 export let componentTree = $state({ value: [] });
 
-export let location = $state(updatedLocation());
+export let location = $state({ pathname: '/', search: '', state: null, hash: '' });
+
+if (BROWSER) {
+	queueMicrotask(() => {
+		const updated = updatedLocation();
+		location.pathname = updated.pathname;
+		location.search = updated.search;
+		location.state = updated.state;
+		location.hash = updated.hash;
+	});
+}
 
 /** @type {{ value: Record<string, string> }} */
 let params = $state({ value: {} });
@@ -247,7 +257,8 @@ export function onGlobalClick(event) {
 	if (
 		anchor.hasAttribute('target') ||
 		anchor.hasAttribute('download') ||
-		!anchor.hasAttribute('href')
+		!anchor.hasAttribute('href') ||
+		anchor.getAttribute('href')?.startsWith('#')
 	)
 		return;
 
@@ -260,10 +271,20 @@ export function onGlobalClick(event) {
 
 	event.preventDefault();
 	const { replace, state, scrollToTop, viewTransition } = anchor.dataset;
+
+	let parsedState;
+	if (state) {
+		try {
+			parsedState = JSON.parse(state);
+		} catch {
+			parsedState = state;
+		}
+	}
+
 	onNavigate(path, {
 		replace: replace === '' || replace === 'true',
 		search: url.search,
-		state,
+		state: parsedState,
 		hash,
 		scrollToTop: scrollToTop === 'false' ? false : /** @type ScrollBehavior */ (scrollToTop),
 		viewTransition: viewTransition === '' || viewTransition === 'true',

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

@@ -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;
 		}

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/index.d.ts

@@ -241,14 +241,14 @@ export type HooksContext = {
 	pathname: string;
 	replace?: boolean;
 	search: Record<string, string | number | boolean>;
-	state?: string;
+	state?: unknown;
 };
 
 export type NavigateOptions =
 	| {
 			replace?: boolean;
 			search?: Search;
-			state?: string;
+			state?: unknown;
 			hash?: string;
 			scrollToTop?: ScrollBehavior | false;
 			viewTransition?: boolean;

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';