chore: qwikRouterConfig is no longer needed

wmertens · wmertens · commit 7dc27bd0703e · 2025-07-15T19:17:40.000+02:00
it is imported internally but can still be overridden should someone be doing that
diff --git a/.changeset/green-drinks-strive.md b/.changeset/green-drinks-strive.md
@@ -0,0 +1,5 @@
+---
+'@qwik.dev/router': minor
+---
+
+FEAT: qwikRouter middleware no longer needs qwikRouterConfig, it handles it internally
diff --git a/e2e/adapters-e2e/src/entry.express.tsx b/e2e/adapters-e2e/src/entry.express.tsx
@@ -9,7 +9,6 @@
  */
 import { createQwikRouter } from '@qwik.dev/router/middleware/node';
 import 'dotenv/config';
-import qwikRouterConfig from '@qwik-router-config';
 import render from './entry.ssr';
 import express from 'express';
 import { fileURLToPath } from 'node:url';
@@ -25,7 +24,6 @@ const PORT = process.env.PORT ?? 3000;
 // Create the Qwik City Node middleware
 const { router, notFound } = createQwikRouter({
   render,
-  qwikRouterConfig,
   // getOrigin(req) {
   //   // If deploying under a proxy, you may need to build the origin from the request headers
   //   // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto
diff --git a/e2e/adapters-e2e/src/entry.preview.tsx b/e2e/adapters-e2e/src/entry.preview.tsx
@@ -11,9 +11,8 @@
  *
  */
 import { createQwikRouter } from '@qwik.dev/router/middleware/node';
-import qwikRouterConfig from '@qwik-router-config';
 // make sure qwikCityPlan is imported before entry
 import render from './entry.ssr';
 
 /** The default export is the QwikCity adapter used by Vite preview. */
-export default createQwikRouter({ render, qwikRouterConfig });
+export default createQwikRouter({ render });
diff --git a/packages/docs/src/entry.cloudflare-pages.tsx b/packages/docs/src/entry.cloudflare-pages.tsx
@@ -1,7 +1,6 @@
-import qwikRouterConfig from '@qwik-router-config';
 import { createQwikRouter } from '@qwik.dev/router/middleware/cloudflare-pages';
 import render from './entry.ssr';
 
-const fetch = createQwikRouter({ render, qwikRouterConfig });
+const fetch = createQwikRouter({ render });
 
 export { fetch };
diff --git a/packages/docs/src/entry.preview.tsx b/packages/docs/src/entry.preview.tsx
@@ -1,6 +1,5 @@
-import qwikRouterConfig from '@qwik-router-config';
 import { createQwikRouter } from '@qwik.dev/router/middleware/node';
 import render from './entry.ssr';
 
 /** The default export is the QwikRouter adapter used by Vite preview. */
-export default createQwikRouter({ render, qwikRouterConfig });
+export default createQwikRouter({ render });
diff --git a/packages/docs/src/routes/docs/deployments/cloudflare-pages/index.mdx b/packages/docs/src/routes/docs/deployments/cloudflare-pages/index.mdx
@@ -204,10 +204,9 @@ import {
   createQwikRouter,
   type PlatformCloudflarePages,
 } from '@qwik.dev/router/middleware/cloudflare-pages';
-import qwikRouterConfig from '@qwik-router-config';
 import render from './entry.ssr';
 
-const fetch = createQwikRouter({ render, qwikRouterConfig });
+const fetch = createQwikRouter({ render });
 
 export { fetch };
 ```
diff --git a/packages/docs/src/routes/docs/deployments/netlify-edge/index.mdx b/packages/docs/src/routes/docs/deployments/netlify-edge/index.mdx
@@ -130,10 +130,9 @@ When the `netlify-edge` adapter is added, a new entry file will be created at `s
 
 ```tsx title="src/entry.netlify-edge.tsx"
 import { createQwikRouter } from '@qwik.dev/router/middleware/netlify-edge';
-import qwikRouterConfig from '@qwik-router-config';
 import render from './entry.ssr';
 
-export default createQwikRouter({ render, qwikRouterConfig });
+export default createQwikRouter({ render });
 ```
 
 The compiled middleware will be built in the `.netlify/edge-functions` directory.
diff --git a/packages/docs/src/routes/docs/deployments/node/index.mdx b/packages/docs/src/routes/docs/deployments/node/index.mdx
@@ -164,8 +164,6 @@ If you want to disable CSRF protection, you can set `checkOrigin: false` in the
 // ...
 const { router, notFound, staticFile } = createQwikRouter({
   render,
-  qwikRouterConfig,
-  manifest,
   checkOrigin: false,
 });
 // ...
diff --git a/packages/docs/src/routes/docs/deployments/vercel-edge/index.mdx b/packages/docs/src/routes/docs/deployments/vercel-edge/index.mdx
@@ -136,10 +136,9 @@ When the `vercel-edge` adapter is added, a new entry file will be created at `sr
 
 ```tsx title="src/entry.vercel-edge.tsx"
 import { createQwikRouter } from '@qwik.dev/router/middleware/vercel-edge';
-import qwikRouterConfig from '@qwik-router-config';
 import render from './entry.ssr';
 
-export default createQwikRouter({ render, qwikRouterConfig });
+export default createQwikRouter({ render });
 ```
 
 The compiled middleware will be built in the `.vercel/output` directory.
diff --git a/packages/insights/src/entry.netlify-edge.tsx b/packages/insights/src/entry.netlify-edge.tsx
@@ -7,7 +7,6 @@
  * - https://qwik.dev/docs/deployments/netlify-edge/
  *
  */
-import qwikRouterConfig from '@qwik-router-config';
 import { createQwikRouter, type PlatformNetlify } from '@qwik.dev/router/middleware/netlify-edge';
 import render from './entry.ssr';
 
@@ -17,7 +16,6 @@ declare global {
 
 export default createQwikRouter({
   render,
-  qwikRouterConfig,
   // disable CSRF protection because we get called from everywhere
   checkOrigin: false,
 });
diff --git a/packages/insights/src/entry.preview.tsx b/packages/insights/src/entry.preview.tsx
@@ -10,9 +10,8 @@
  * - https://vitejs.dev/config/preview-options.html#preview-options
  *
  */
-import qwikRouterConfig from '@qwik-router-config';
 import { createQwikRouter } from '@qwik.dev/router/middleware/node';
 import render from './entry.ssr';
 
 /** The default export is the QwikRouter adapter used by Vite preview. */
-export default createQwikRouter({ render, qwikRouterConfig });
+export default createQwikRouter({ render });
diff --git a/packages/qwik-router/global.d.ts b/packages/qwik-router/global.d.ts
@@ -21,3 +21,5 @@ declare var __EXPERIMENTAL__: {
 };
 
 declare var __DEFAULT_LOADERS_SERIALIZATION_STRATEGY__: SerializationStrategy;
+
+declare var __NO_TRAILING_SLASH__: boolean;
diff --git a/packages/qwik-router/src/buildtime/vite/plugin.ts b/packages/qwik-router/src/buildtime/vite/plugin.ts
@@ -82,6 +82,7 @@ function qwikRouterPlugin(userOpts?: QwikRouterVitePluginOptions): any {
           'globalThis.__DEFAULT_LOADERS_SERIALIZATION_STRATEGY__': JSON.stringify(
             userOpts?.defaultLoadersSerializationStrategy || 'never'
           ),
+          'globalThis.__NO_TRAILING_SLASH__': JSON.stringify(userOpts?.trailingSlash === false),
         },
         appType: 'custom',
         resolve: {
diff --git a/packages/qwik-router/src/middleware/aws-lambda/index.ts b/packages/qwik-router/src/middleware/aws-lambda/index.ts
@@ -7,18 +7,17 @@ import type { ServerRenderOptions } from '@qwik.dev/router/middleware/request-ha
 interface AwsOpt {
   render: Render;
   manifest?: QwikManifest;
-  qwikRouterConfig: QwikRouterConfig;
-  /** @deprecated Use `QwikRouterConfig` instead. Will be removed in V3 */
+  /** @deprecated Not used */
+  qwikRouterConfig?: QwikRouterConfig;
+  /** @deprecated Not used */
   qwikCityPlan?: QwikCityPlan;
 }
 
 /** @public */
 export function createQwikRouter(opts: AwsOpt) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
   try {
     const { router, staticFile, notFound } = createQwikRouterNode({
@@ -37,7 +36,7 @@ export function createQwikRouter(opts: AwsOpt) {
     });
 
     const fixPath = (pathT: string) => {
-      if (opts.qwikRouterConfig.trailingSlash) {
+      if (!globalThis.__NO_TRAILING_SLASH__) {
         const url = new URL(pathT, 'http://aws-qwik.local');
         if (url.pathname.includes('.', url.pathname.lastIndexOf('/'))) {
           return pathT;
diff --git a/packages/qwik-router/src/middleware/azure-swa/index.ts b/packages/qwik-router/src/middleware/azure-swa/index.ts
@@ -51,10 +51,8 @@ interface AzureCookie {
 /** @public */
 export function createQwikRouter(opts: QwikRouterAzureOptions): AzureFunction {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
   const qwikSerializer: QwikSerializer = {
     _deserialize,
diff --git a/packages/qwik-router/src/middleware/bun/index.ts b/packages/qwik-router/src/middleware/bun/index.ts
@@ -19,10 +19,8 @@ import { MIME_TYPES } from '../request-handler/mime-types';
 /** @public */
 export function createQwikRouter(opts: QwikRouterBunOptions) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
   // @qwik.dev/router/middleware/bun
   // still missing from bun: last check was bun version 1.1.8
@@ -129,7 +127,7 @@ export function createQwikRouter(opts: QwikRouterBunOptions) {
     let filePath: string;
     if (fileName.includes('.')) {
       filePath = join(staticFolder, pathname);
-    } else if (opts.qwikRouterConfig!.trailingSlash) {
+    } else if (!globalThis.__NO_TRAILING_SLASH__) {
       filePath = join(staticFolder, pathname + 'index.html');
     } else {
       filePath = join(staticFolder, pathname, 'index.html');
diff --git a/packages/qwik-router/src/middleware/cloudflare-pages/index.ts b/packages/qwik-router/src/middleware/cloudflare-pages/index.ts
@@ -17,17 +17,14 @@ import {
 /** @public */
 export function createQwikRouter(opts: QwikRouterCloudflarePagesOptions) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
   try {
     // https://developers.cloudflare.com/workers/configuration/compatibility-dates/#streams-constructors
     // this will throw if CF compatibility_date < 2022-11-30
     new globalThis.TextEncoderStream();
-  } catch (e) {
-    // @ts-ignore
+  } catch {
     globalThis.TextEncoderStream = _TextEncoderStream_polyfill;
   }
   const qwikSerializer = { _deserialize, _serialize, _verifySerializable };
diff --git a/packages/qwik-router/src/middleware/deno/index.ts b/packages/qwik-router/src/middleware/deno/index.ts
@@ -30,10 +30,8 @@ export interface ServeHandlerInfo {
 /** @public */
 export function createQwikRouter(opts: QwikRouterDenoOptions) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
   const qwikSerializer: QwikSerializer = {
     _deserialize,
@@ -132,7 +130,7 @@ export function createQwikRouter(opts: QwikRouterDenoOptions) {
     let filePath: string;
     if (fileName.includes('.')) {
       filePath = join(staticFolder, pathname);
-    } else if (opts.qwikRouterConfig!.trailingSlash) {
+    } else if (!globalThis.__NO_TRAILING_SLASH__) {
       filePath = join(staticFolder, pathname + 'index.html');
     } else {
       filePath = join(staticFolder, pathname, 'index.html');
diff --git a/packages/qwik-router/src/middleware/firebase/index.ts b/packages/qwik-router/src/middleware/firebase/index.ts
@@ -5,10 +5,8 @@ import type { ServerRenderOptions } from '@qwik.dev/router/middleware/request-ha
 /** @public */
 export function createQwikRouter(opts: QwikRouterFirebaseOptions) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
   const { staticFile, notFound, router } = createQwikRouterNode({
     render: opts.render,
diff --git a/packages/qwik-router/src/middleware/netlify-edge/index.ts b/packages/qwik-router/src/middleware/netlify-edge/index.ts
@@ -17,10 +17,8 @@ declare const Deno: any;
 /** @public */
 export function createQwikRouter(opts: QwikRouterNetlifyOptions) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
   const qwikSerializer: QwikSerializer = {
     _deserialize,
diff --git a/packages/qwik-router/src/middleware/node/index.ts b/packages/qwik-router/src/middleware/node/index.ts
@@ -18,10 +18,8 @@ import { computeOrigin, fromNodeHttp, getUrl } from './http';
 /** @public */
 export function createQwikRouter(opts: QwikRouterNodeRequestOptions | QwikCityNodeRequestOptions) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
 
   const qwikSerializer: QwikSerializer = {
@@ -108,7 +106,7 @@ export function createQwikRouter(opts: QwikRouterNodeRequestOptions | QwikCityNo
         let filePath: string;
         if (basename(pathname).includes('.')) {
           filePath = join(staticFolder, pathname);
-        } else if (opts.qwikRouterConfig!.trailingSlash) {
+        } else if (!globalThis.__NO_TRAILING_SLASH__) {
           filePath = join(staticFolder, pathname + 'index.html');
         } else {
           filePath = join(staticFolder, pathname, 'index.html');
diff --git a/packages/qwik-router/src/middleware/request-handler/middleware.request-handler.api.md b/packages/qwik-router/src/middleware/request-handler/middleware.request-handler.api.md
@@ -204,7 +204,7 @@ export interface ServerRenderOptions extends RenderOptions {
     checkOrigin?: boolean;
     // @deprecated (undocumented)
     qwikCityPlan?: QwikCityPlan;
-    // (undocumented)
+    // @deprecated (undocumented)
     qwikRouterConfig?: QwikRouterConfig;
     // (undocumented)
     render: Render;
diff --git a/packages/qwik-router/src/middleware/request-handler/request-handler.ts b/packages/qwik-router/src/middleware/request-handler/request-handler.ts
@@ -4,6 +4,7 @@ import type { QwikRouterConfig, RebuildRouteInfoInternal } from '../../runtime/s
 import { renderQwikMiddleware, resolveRequestHandlers } from './resolve-request-handlers';
 import type { QwikSerializer, ServerRenderOptions, ServerRequestEvent } from './types';
 import { getRouteMatchPathname, runQwikRouter, type QwikRouterRun } from './user-response';
+import qwikRouterConfigActual from '@qwik-router-config';
 
 /**
  * The request handler for QwikRouter. Called by every integration.
@@ -15,7 +16,7 @@ export async function requestHandler<T = unknown>(
   opts: ServerRenderOptions,
   qwikSerializer: QwikSerializer
 ): Promise<QwikRouterRun<T> | null> {
-  const { render, qwikRouterConfig, checkOrigin } = opts;
+  const { render, qwikRouterConfig = qwikRouterConfigActual, checkOrigin } = opts;
   if (!qwikRouterConfig) {
     throw new Error('qwikRouterConfig is required.');
   }
diff --git a/packages/qwik-router/src/middleware/request-handler/types.ts b/packages/qwik-router/src/middleware/request-handler/types.ts
@@ -48,9 +48,10 @@ export type ServerResponseHandler<T = any> = (
 export interface ServerRenderOptions extends RenderOptions {
   render: Render;
 
-  /** @deprecated Use `QwikRouterConfig` instead. Will be removed in V3 */
+  /** @deprecated Not used */
   qwikCityPlan?: QwikCityPlan;
 
+  /** @deprecated Not used */
   qwikRouterConfig?: QwikRouterConfig;
   /**
    * Protection against cross-site request forgery (CSRF) attacks.
diff --git a/packages/qwik-router/src/middleware/vercel-edge/index.ts b/packages/qwik-router/src/middleware/vercel-edge/index.ts
@@ -20,10 +20,8 @@ const BASE_URL = 'BASE_URL';
 /** @public */
 export function createQwikRouter(opts: QwikRouterVercelEdgeOptions) {
   if (opts.qwikCityPlan && !opts.qwikRouterConfig) {
-    console.warn('qwikCityPlan is deprecated. Use qwikRouterConfig instead.');
+    console.warn('qwikCityPlan is deprecated. Simply remove it.');
     opts.qwikRouterConfig = opts.qwikCityPlan;
-  } else if (!opts.qwikRouterConfig) {
-    throw new Error('qwikRouterConfig is required.');
   }
   const qwikSerializer: QwikSerializer = {
     _deserialize,
diff --git a/starters/adapters/aws-lambda/src/entry_aws-lambda.tsx b/starters/adapters/aws-lambda/src/entry_aws-lambda.tsx
@@ -7,7 +7,6 @@
  * - https://qwik.dev/docs/deployments/aws/
  *
  */
-import qwikRouterConfig from "@qwik-router-config";
 import {
   createQwikRouter,
   type PlatformAwsLambda,
@@ -20,10 +19,7 @@ declare global {
   interface QwikRouterPlatform extends PlatformAwsLambda {}
 }
 
-export const { handle } = createQwikRouter({
-  render,
-  qwikRouterConfig,
-});
+export const { handle } = createQwikRouter({ render });
 
 export const qwikApp = serverless({ handle }, { binary: true });
 // handler is the default export for the lambda functions
diff --git a/starters/adapters/azure-swa/src/entry.azure-swa.tsx b/starters/adapters/azure-swa/src/entry.azure-swa.tsx
@@ -7,7 +7,6 @@
  * - https://qwik.dev/docs/deployments/azure-swa/
  *
  */
-import qwikRouterConfig from "@qwik-router-config";
 import {
   createQwikRouter,
   type PlatformAzure,
@@ -18,4 +17,4 @@ declare global {
   interface QwikRouterPlatform extends PlatformAzure {}
 }
 
-export default createQwikRouter({ render, qwikRouterConfig });
+export default createQwikRouter({ render });
diff --git a/starters/adapters/bun/src/entry.bun.ts b/starters/adapters/bun/src/entry.bun.ts
@@ -8,14 +8,12 @@
  * - https://bun.sh/docs/api/http
  *
  */
-import qwikRouterConfig from "@qwik-router-config";
 import { createQwikRouter } from "@qwik.dev/router/middleware/bun";
 import render from "./entry.ssr";
 
 // Create the Qwik Router Bun middleware
 const { router, notFound, staticFile } = createQwikRouter({
   render,
-  qwikRouterConfig,
   static: {
     cacheControl: "public, max-age=31536000, immutable",
   },
diff --git a/starters/adapters/cloud-run/src/entry.cloud-run.tsx b/starters/adapters/cloud-run/src/entry.cloud-run.tsx
diff --git a/starters/adapters/cloudflare-pages/src/entry.cloudflare-pages.tsx b/starters/adapters/cloudflare-pages/src/entry.cloudflare-pages.tsx
diff --git a/starters/adapters/deno/src/entry.deno.ts b/starters/adapters/deno/src/entry.deno.ts
diff --git a/starters/adapters/express/src/entry.express.tsx b/starters/adapters/express/src/entry.express.tsx
diff --git a/starters/adapters/fastify/src/plugins/fastify-qwik.ts b/starters/adapters/fastify/src/plugins/fastify-qwik.ts
diff --git a/starters/adapters/firebase/src/entry-firebase.tsx b/starters/adapters/firebase/src/entry-firebase.tsx
diff --git a/starters/adapters/netlify-edge/src/entry.netlify-edge.tsx b/starters/adapters/netlify-edge/src/entry.netlify-edge.tsx
diff --git a/starters/adapters/node-server/src/entry.node-server.tsx b/starters/adapters/node-server/src/entry.node-server.tsx
diff --git a/starters/adapters/vercel-edge/src/entry.vercel-edge.tsx b/starters/adapters/vercel-edge/src/entry.vercel-edge.tsx
diff --git a/starters/apps/base/src/entry.preview.tsx b/starters/apps/base/src/entry.preview.tsx
diff --git a/starters/apps/preloader-test/src/entry.preview.tsx b/starters/apps/preloader-test/src/entry.preview.tsx
diff --git a/starters/dev-server.ts b/starters/dev-server.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@qwik.dev/router': minor
 +---
++
 +FEAT: qwikRouter middleware no longer needs qwikRouterConfig, it handles it internally