chore: make trailingSlash a build constant

wmertens · wmertens · commit 1d5993e61d11 · 2025-07-15T21:23:28.000+02:00
diff --git a/packages/qwik-router/global.d.ts b/packages/qwik-router/global.d.ts
@@ -22,4 +22,5 @@ declare var __EXPERIMENTAL__: {
 
 declare var __DEFAULT_LOADERS_SERIALIZATION_STRATEGY__: SerializationStrategy;
 
+/** Should routes not have a trailing slash? */
 declare var __NO_TRAILING_SLASH__: boolean;
diff --git a/packages/qwik-router/src/buildtime/context.ts b/packages/qwik-router/src/buildtime/context.ts
@@ -92,10 +92,6 @@ function normalizeOptions(
   const url = new URL(opts.basePathname, 'https://qwik.dev/');
   opts.basePathname = url.pathname;
 
-  if (typeof opts.trailingSlash !== 'boolean') {
-    opts.trailingSlash = true;
-  }
-
   opts.mdx = opts.mdx || {};
   opts.platform = opts.platform || {};
 
diff --git a/packages/qwik-router/src/buildtime/markdown/markdown-url.ts b/packages/qwik-router/src/buildtime/markdown/markdown-url.ts
@@ -49,10 +49,10 @@ export function getMarkdownRelativeUrl(
     }
   } else if (extension === '') {
     if (url.endsWith('/')) {
-      if (!opts.trailingSlash) {
+      if (globalThis.__NO_TRAILING_SLASH__) {
         url = url.slice(0, -1);
       }
-    } else if (opts.trailingSlash) {
+    } else if (!globalThis.__NO_TRAILING_SLASH__) {
       url += '/';
     }
   }
diff --git a/packages/qwik-router/src/buildtime/markdown/markdown-url.unit.ts b/packages/qwik-router/src/buildtime/markdown/markdown-url.unit.ts
@@ -66,10 +66,9 @@ const menuFilePath = join(routesDir, 'docs', 'menu.md');
     expect: './getting-started.txt',
   },
 ].forEach((t) => {
-  test(`getMarkdownRelativeUrl ${t.href}`, () => {
+  test(`getMarkdownRelativeUrl ${t.href} ${t.trailingSlash ? 'with' : 'without'} slash`, () => {
     const opts: NormalizedPluginOptions = {
       basePathname: '/',
-      trailingSlash: !!t.trailingSlash,
       routesDir,
       serverPluginsDir,
       mdxPlugins: {
@@ -82,6 +81,7 @@ const menuFilePath = join(routesDir, 'docs', 'menu.md');
       rewriteRoutes: [],
       defaultLoadersSerializationStrategy: 'never',
     };
+    globalThis.__NO_TRAILING_SLASH__ = !t.trailingSlash;
     assert.equal(getMarkdownRelativeUrl(opts, menuFilePath, t.href), t.expect);
   });
 });
diff --git a/packages/qwik-router/src/buildtime/routing/resolve-source-file.unit.ts b/packages/qwik-router/src/buildtime/routing/resolve-source-file.unit.ts
@@ -40,7 +40,6 @@ test('resolveLayout', () => {
       routesDir: '',
       serverPluginsDir: '',
       basePathname: '/',
-      trailingSlash: false,
       mdxPlugins: {
         remarkGfm: true,
         rehypeSyntaxHighlight: true,
diff --git a/packages/qwik-router/src/buildtime/runtime-generation/generate-qwik-router-config.ts b/packages/qwik-router/src/buildtime/runtime-generation/generate-qwik-router-config.ts
@@ -24,15 +24,13 @@ export function generateQwikRouterConfig(
 
   createEntries(ctx, c);
 
-  c.push(`export const trailingSlash = ${JSON.stringify(!!ctx.opts.trailingSlash)};`);
+  c.push(`export const trailingSlash = ${JSON.stringify(!globalThis.__NO_TRAILING_SLASH__)};`);
 
   c.push(`export const basePathname = ${JSON.stringify(ctx.opts.basePathname)};`);
 
   c.push(`export const cacheModules = ${JSON.stringify(!ctx.isDevServer)};`);
 
-  c.push(
-    `export default { routes, serverPlugins, menus, trailingSlash, basePathname, cacheModules };`
-  );
+  c.push(`export default { routes, serverPlugins, menus, basePathname, cacheModules };`);
 
   return esmImports.join('\n') + c.join('\n');
 }
diff --git a/packages/qwik-router/src/buildtime/types.ts b/packages/qwik-router/src/buildtime/types.ts
@@ -145,7 +145,7 @@ export interface MdxPlugins {
   rehypeAutolinkHeadings: boolean;
 }
 
-export interface NormalizedPluginOptions extends Required<PluginOptions> {
+export interface NormalizedPluginOptions extends Omit<Required<PluginOptions>, 'trailingSlash'> {
   assetsDir?: string;
 }
 
diff --git a/packages/qwik-router/src/buildtime/vite/dev-server.ts b/packages/qwik-router/src/buildtime/vite/dev-server.ts
@@ -44,7 +44,7 @@ export function ssrDevMiddleware(ctx: BuildContext, server: ViteDevServer) {
         return { route, params };
       }
 
-      if (ctx.opts.trailingSlash && !pathname.endsWith('/')) {
+      if (!globalThis.__NO_TRAILING_SLASH__ && !pathname.endsWith('/')) {
         params = matchRoute(route.pathname, pathname + '/');
         if (params) {
           return { route, params };
@@ -129,7 +129,7 @@ export function ssrDevMiddleware(ctx: BuildContext, server: ViteDevServer) {
     return { serverPlugins, loadedRoute };
   };
   const resolveRoute = (routeModulePaths: WeakMap<RouteModule<unknown>, string>, url: URL) => {
-    const matchPathname = getRouteMatchPathname(url.pathname, ctx.opts.trailingSlash);
+    const matchPathname = getRouteMatchPathname(url.pathname);
     routePs[matchPathname] ||= _resolveRoute(routeModulePaths, matchPathname).finally(() => {
       delete routePs[matchPathname];
     });
@@ -251,7 +251,6 @@ export function ssrDevMiddleware(ctx: BuildContext, server: ViteDevServer) {
             loadedRoute,
             requestHandlers,
             rebuildRouteInfo,
-            ctx.opts.trailingSlash,
             ctx.opts.basePathname,
             qwikSerializer
           );
diff --git a/packages/qwik-router/src/middleware/request-handler/request-event.ts b/packages/qwik-router/src/middleware/request-handler/request-event.ts
@@ -37,7 +37,6 @@ export const RequestEvQwikSerializer = Symbol('RequestEvQwikSerializer');
 export const RequestEvLoaderSerializationStrategyMap = Symbol(
   'RequestEvLoaderSerializationStrategyMap'
 );
-export const RequestEvTrailingSlash = Symbol('RequestEvTrailingSlash');
 export const RequestRouteName = '@routeName';
 export const RequestEvSharedActionId = '@actionId';
 export const RequestEvSharedActionFormData = '@actionFormData';
@@ -51,7 +50,6 @@ export function createRequestEvent(
   serverRequestEv: ServerRequestEvent,
   loadedRoute: LoadedRoute | null,
   requestHandlers: RequestHandler<any>[],
-  trailingSlash: boolean,
   basePathname: string,
   qwikSerializer: QwikSerializer,
   resolved: (response: any) => void
@@ -64,7 +62,7 @@ export function createRequestEvent(
   const url = new URL(request.url);
   if (url.pathname.endsWith(QDATA_JSON)) {
     url.pathname = url.pathname.slice(0, -QDATA_JSON_LEN);
-    if (trailingSlash && !url.pathname.endsWith('/')) {
+    if (!globalThis.__NO_TRAILING_SLASH__ && !url.pathname.endsWith('/')) {
       url.pathname += '/';
     }
     sharedMap.set(IsQData, true);
@@ -155,7 +153,6 @@ export function createRequestEvent(
     [RequestEvLoaders]: loaders,
     [RequestEvLoaderSerializationStrategyMap]: new Map(),
     [RequestEvMode]: serverRequestEv.mode,
-    [RequestEvTrailingSlash]: trailingSlash,
     get [RequestEvRoute]() {
       return loadedRoute;
     },
@@ -339,7 +336,6 @@ export interface RequestEventInternal extends RequestEvent, RequestEventLoader {
   [RequestEvLoaders]: Record<string, ValueOrPromise<unknown> | undefined>;
   [RequestEvLoaderSerializationStrategyMap]: Map<string, SerializationStrategy>;
   [RequestEvMode]: ServerRequestMode;
-  [RequestEvTrailingSlash]: boolean;
   [RequestEvRoute]: LoadedRoute | null;
   [RequestEvQwikSerializer]: QwikSerializer;
 
@@ -372,10 +368,6 @@ export function getRequestLoaderSerializationStrategyMap(requestEv: RequestEvent
   return (requestEv as RequestEventInternal)[RequestEvLoaderSerializationStrategyMap];
 }
 
-export function getRequestTrailingSlash(requestEv: RequestEventCommon) {
-  return (requestEv as RequestEventInternal)[RequestEvTrailingSlash];
-}
-
 export function getRequestRoute(requestEv: RequestEventCommon) {
   return (requestEv as RequestEventInternal)[RequestEvRoute];
 }
diff --git a/packages/qwik-router/src/middleware/request-handler/request-handler.ts b/packages/qwik-router/src/middleware/request-handler/request-handler.ts
@@ -33,7 +33,7 @@ export async function requestHandler<T = unknown>(
   }
 
   const pathname = serverRequestEv.url.pathname;
-  const matchPathname = getRouteMatchPathname(pathname, qwikRouterConfig.trailingSlash);
+  const matchPathname = getRouteMatchPathname(pathname);
   const routeAndHandlers = await loadRequestHandlers(
     qwikRouterConfig,
     matchPathname,
@@ -46,7 +46,7 @@ export async function requestHandler<T = unknown>(
     const [route, requestHandlers] = routeAndHandlers;
 
     const rebuildRouteInfo: RebuildRouteInfoInternal = async (url: URL) => {
-      const matchPathname = getRouteMatchPathname(url.pathname, qwikRouterConfig.trailingSlash);
+      const matchPathname = getRouteMatchPathname(url.pathname);
       const routeAndHandlers = await loadRequestHandlers(
         qwikRouterConfig,
         matchPathname,
@@ -68,7 +68,6 @@ export async function requestHandler<T = unknown>(
       route,
       requestHandlers,
       rebuildRouteInfo,
-      qwikRouterConfig.trailingSlash,
       qwikRouterConfig.basePathname,
       qwikSerializer
     );
diff --git a/packages/qwik-router/src/middleware/request-handler/resolve-request-handlers.ts b/packages/qwik-router/src/middleware/request-handler/resolve-request-handlers.ts
@@ -27,7 +27,6 @@ import {
   getRequestLoaderSerializationStrategyMap,
   getRequestLoaders,
   getRequestMode,
-  getRequestTrailingSlash,
   type RequestEventInternal,
 } from './request-event';
 import { getQwikRouterServerData } from './response-page';
@@ -397,13 +396,12 @@ async function pureServerFunction(ev: RequestEvent) {
 }
 
 function fixTrailingSlash(ev: RequestEvent) {
-  const trailingSlash = getRequestTrailingSlash(ev);
   const { basePathname, originalUrl, sharedMap } = ev;
   const { pathname, search } = originalUrl;
   const isQData = sharedMap.has(IsQData);
   if (!isQData && pathname !== basePathname && !pathname.endsWith('.html')) {
     // only check for slash redirect on pages
-    if (trailingSlash) {
+    if (!globalThis.__NO_TRAILING_SLASH__) {
       // must have a trailing slash
       if (!pathname.endsWith('/')) {
         // add slash to existing pathname
@@ -442,12 +440,12 @@ export function isLastModulePageRoute(routeModules: RouteModule[]) {
   return lastRouteModule && typeof (lastRouteModule as PageModule).default === 'function';
 }
 
-export function getPathname(url: URL, trailingSlash: boolean | undefined) {
+export function getPathname(url: URL) {
   url = new URL(url);
   if (url.pathname.endsWith(QDATA_JSON)) {
     url.pathname = url.pathname.slice(0, -QDATA_JSON.length);
   }
-  if (trailingSlash) {
+  if (!globalThis.__NO_TRAILING_SLASH__) {
     if (!url.pathname.endsWith('/')) {
       url.pathname += '/';
     }
@@ -500,7 +498,6 @@ export function renderQwikMiddleware(render: Render) {
       responseHeaders.set('Content-Type', 'text/html; charset=utf-8');
     }
 
-    const trailingSlash = getRequestTrailingSlash(requestEv);
     const { readable, writable } = new TextEncoderStream();
     const writableStream = requestEv.getWritableStream();
     const pipe = readable.pipeTo(writableStream, { preventClose: true });
@@ -522,7 +519,7 @@ export function renderQwikMiddleware(render: Render) {
         loaders: getRequestLoaders(requestEv),
         action: requestEv.sharedMap.get(RequestEvSharedActionId),
         status: status !== 200 ? status : 200,
-        href: getPathname(requestEv.url, trailingSlash),
+        href: getPathname(requestEv.url),
       };
       if (typeof (result as any as RenderToStringResult).html === 'string') {
         // render result used renderToString(), so none of it was streamed
@@ -587,7 +584,6 @@ export async function renderQData(requestEv: RequestEvent) {
 
   const status = requestEv.status();
   const redirectLocation = requestEv.headers.get('Location');
-  const trailingSlash = getRequestTrailingSlash(requestEv);
 
   const requestHeaders: Record<string, string> = {};
   requestEv.request.headers.forEach((value, key) => (requestHeaders[key] = value));
@@ -612,13 +608,13 @@ export async function renderQData(requestEv: RequestEvent) {
         // send minimal data to the client
         loaders,
         status: status !== 200 ? status : 200,
-        href: getPathname(requestEv.url, trailingSlash),
+        href: getPathname(requestEv.url),
       }
     : {
         loaders,
         action: requestEv.sharedMap.get(RequestEvSharedActionId),
         status: status !== 200 ? status : 200,
-        href: getPathname(requestEv.url, trailingSlash),
+        href: getPathname(requestEv.url),
         redirect: redirectLocation ?? undefined,
         isRewrite: requestEv.sharedMap.get(RequestEvIsRewrite),
       };
diff --git a/packages/qwik-router/src/middleware/request-handler/resolve-request-handlers.unit.ts b/packages/qwik-router/src/middleware/request-handler/resolve-request-handlers.unit.ts
@@ -4,31 +4,31 @@ import { getPathname, isContentType } from './resolve-request-handlers';
 describe('resolve-request-handler', () => {
   describe('getPathname', () => {
     it('should remove q-data.json', () => {
-      expect(getPathname(new URL('http://server/path/q-data.json?foo=bar#hash'), true)).toBe(
+      globalThis.__NO_TRAILING_SLASH__ = false;
+      expect(getPathname(new URL('http://server/path/q-data.json?foo=bar#hash'))).toBe(
         '/path/?foo=bar#hash'
       );
-      expect(getPathname(new URL('http://server/path/q-data.json?foo=bar#hash'), false)).toBe(
+      globalThis.__NO_TRAILING_SLASH__ = true;
+      expect(getPathname(new URL('http://server/path/q-data.json?foo=bar#hash'))).toBe(
         '/path?foo=bar#hash'
       );
     });
 
     it('should pass non q-data.json through', () => {
-      expect(getPathname(new URL('http://server/path?foo=bar#hash'), true)).toBe(
-        '/path/?foo=bar#hash'
-      );
-      expect(getPathname(new URL('http://server/path/?foo=bar#hash'), false)).toBe(
-        '/path?foo=bar#hash'
-      );
+      globalThis.__NO_TRAILING_SLASH__ = false;
+      expect(getPathname(new URL('http://server/path?foo=bar#hash'))).toBe('/path/?foo=bar#hash');
+      globalThis.__NO_TRAILING_SLASH__ = true;
+      expect(getPathname(new URL('http://server/path/?foo=bar#hash'))).toBe('/path?foo=bar#hash');
     });
 
     it('should remove internal search params', () => {
-      expect(getPathname(new URL('http://server/path?qaction=123&qdata=data'), true)).toBe(
-        '/path/'
-      );
-      expect(getPathname(new URL('http://server/path?foo=1&qfunc=f&bar=2'), false)).toBe(
+      globalThis.__NO_TRAILING_SLASH__ = false;
+      expect(getPathname(new URL('http://server/path?qaction=123&qdata=data'))).toBe('/path/');
+      globalThis.__NO_TRAILING_SLASH__ = true;
+      expect(getPathname(new URL('http://server/path?foo=1&qfunc=f&bar=2'))).toBe(
         '/path?foo=1&bar=2'
       );
-      expect(getPathname(new URL('http://server/path?foo=1&qloaders=f&bar=2'), false)).toBe(
+      expect(getPathname(new URL('http://server/path?foo=1&qloaders=f&bar=2'))).toBe(
         '/path?foo=1&bar=2'
       );
     });
diff --git a/packages/qwik-router/src/middleware/request-handler/user-response.ts b/packages/qwik-router/src/middleware/request-handler/user-response.ts
@@ -41,7 +41,6 @@ export function runQwikRouter<T>(
   loadedRoute: LoadedRoute | null,
   requestHandlers: RequestHandler<any>[],
   rebuildRouteInfo: RebuildRouteInfoInternal,
-  trailingSlash = true,
   basePathname = '/',
   qwikSerializer: QwikSerializer
 ): QwikRouterRun<T> {
@@ -51,7 +50,6 @@ export function runQwikRouter<T>(
     serverRequestEv,
     loadedRoute,
     requestHandlers,
-    trailingSlash,
     basePathname,
     qwikSerializer,
     resolve!
@@ -144,9 +142,9 @@ async function runNext(
  * The pathname used to match in the route regex array. A pathname ending with /q-data.json should
  * be treated as a pathname without it.
  */
-export function getRouteMatchPathname(pathname: string, trailingSlash: boolean | undefined) {
+export function getRouteMatchPathname(pathname: string) {
   if (pathname.endsWith(QDATA_JSON)) {
-    const trimEnd = pathname.length - QDATA_JSON_LEN + (trailingSlash ? 1 : 0);
+    const trimEnd = pathname.length - QDATA_JSON_LEN + (globalThis.__NO_TRAILING_SLASH__ ? 0 : 1);
     pathname = pathname.slice(0, trimEnd);
     if (pathname === '') {
       pathname = '/';
diff --git a/packages/qwik-router/src/runtime/src/qwik-router-component.tsx b/packages/qwik-router/src/runtime/src/qwik-router-component.tsx
@@ -419,10 +419,10 @@ export const useQwikRouter = (props?: QwikRouterProps) => {
 
         // ensure correct trailing slash
         if (trackUrl.pathname.endsWith('/')) {
-          if (!qwikRouterConfig.trailingSlash) {
+          if (globalThis.__NO_TRAILING_SLASH__) {
             trackUrl.pathname = trackUrl.pathname.slice(0, -1);
           }
-        } else if (qwikRouterConfig.trailingSlash) {
+        } else if (!globalThis.__NO_TRAILING_SLASH__) {
           trackUrl.pathname += '/';
         }
         let loadRoutePromise = loadRoute(
diff --git a/packages/qwik-router/src/runtime/src/qwik-router-config.ts b/packages/qwik-router/src/runtime/src/qwik-router-config.ts
@@ -4,7 +4,7 @@ import type { MenuData, RouteData, RouteModule } from './types';
 export const routes: RouteData[] = [];
 export const menus: MenuData[] = [];
 export const serverPlugins: RouteModule[] = [];
-export const trailingSlash = false;
+export const trailingSlash = !globalThis.__NO_TRAILING_SLASH__;
 export const basePathname = '/';
 export const cacheModules = false;
 
diff --git a/packages/qwik-router/src/utils/fs.ts b/packages/qwik-router/src/utils/fs.ts
@@ -28,7 +28,7 @@ export function getPathnameFromDirPath(opts: NormalizedPluginOptions, dirPath: s
   // ensure file system path uses / (POSIX) instead of \\ (windows)
   let pathname = normalizePath(relFilePath);
 
-  pathname = normalizePathname(pathname, opts.basePathname, opts.trailingSlash)!
+  pathname = normalizePathname(pathname, opts.basePathname)!
     .split('/')
     // remove grouped layout segments
     .filter((segment) => !isGroupedLayoutName(segment))
@@ -42,7 +42,11 @@ export function getPathnameFromDirPath(opts: NormalizedPluginOptions, dirPath: s
 export function getMenuPathname(opts: NormalizedPluginOptions, filePath: string) {
   let pathname = normalizePath(relative(opts.routesDir, filePath));
   pathname = `/` + normalizePath(dirname(pathname));
-  return normalizePathname(pathname, opts.basePathname, true)!;
+  let result = normalizePathname(pathname, opts.basePathname)!;
+  if (!result.endsWith('/')) {
+    result += '/';
+  }
+  return result;
 }
 
 export function getExtension(fileName: string) {
diff --git a/packages/qwik-router/src/utils/fs.unit.ts b/packages/qwik-router/src/utils/fs.unit.ts
diff --git a/packages/qwik-router/src/utils/pathname.ts b/packages/qwik-router/src/utils/pathname.ts
diff --git a/packages/qwik-router/src/utils/pathname.unit.ts b/packages/qwik-router/src/utils/pathname.unit.ts

Original file line number	Diff line number	Diff line change
`@@ -22,4 +22,5 @@ declare var __EXPERIMENTAL__: {`
`22`	`22`
`23`	`23`	`declare var __DEFAULT_LOADERS_SERIALIZATION_STRATEGY__: SerializationStrategy;`
`24`	`24`
	`25`	`+/** Should routes not have a trailing slash? */`
`25`	`26`	`declare var __NO_TRAILING_SLASH__: boolean;`
Original file line number	Diff line number	Diff line change
`@@ -49,10 +49,10 @@ export function getMarkdownRelativeUrl(`
`49`	`49`	`}`
`50`	`50`	`} else if (extension === '') {`
`51`	`51`	`if (url.endsWith('/')) {`
`52`		`- if (!opts.trailingSlash) {`
	`52`	`+ if (globalThis.__NO_TRAILING_SLASH__) {`
`53`	`53`	`url = url.slice(0, -1);`
`54`	`54`	`}`
`55`		`- } else if (opts.trailingSlash) {`
	`55`	`+ } else if (!globalThis.__NO_TRAILING_SLASH__) {`
`56`	`56`	`url += '/';`
`57`	`57`	`}`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ export interface MdxPlugins {`
`145`	`145`	`rehypeAutolinkHeadings: boolean;`
`146`	`146`	`}`
`147`	`147`
`148`		`-export interface NormalizedPluginOptions extends Required<PluginOptions> {`
	`148`	`+export interface NormalizedPluginOptions extends Omit<Required<PluginOptions>, 'trailingSlash'> {`
`149`	`149`	`assetsDir?: string;`
`150`	`150`	`}`
`151`	`151`