feat(qwik-router): add exclude option to rewriteRoutes

Skip generating rewritten route entries for matching path patterns, so a
section can opt out of being rewritten under each config. Patterns use
the same glob syntax as the SSG `include`/`exclude`, matched per config
before the rewrite node is created.

Author: briancarbone

.changeset/rewrite-routes-exclude.md

@@ -0,0 +1,5 @@
+---
+'@qwik.dev/router': minor
+---
+
+feat(router): add an `exclude` option to `rewriteRoutes` to skip generating localized routes for matching path patterns.

packages/docs/src/routes/docs/(qwikrouter)/routing/index.mdx

@@ -428,6 +428,22 @@ export default defineConfig(async () => {
 });
 ```
 
+By default a config rewrites every matching route. Add `exclude` to skip routes that should not be rewritten under that config. The patterns use the same glob syntax as the SSG `include`/`exclude` and are matched per config:
+
+```tsx
+rewriteRoutes: [
+  {
+    prefix: 'it',
+    paths: {
+      'docs': 'documentazione',
+      'products': 'prodotti',
+    },
+    // `/blog` stays English-only: no `/it` mirror is generated for it.
+    exclude: ['/blog/*'],
+  },
+],
+```
+
 ## Advanced routing
 
 Qwik Router also supports:

packages/qwik-router/src/buildtime/build-pages-rewrited.unit.ts

@@ -333,3 +333,14 @@ testSameRoutes(
     assert.equal(r.pathname, '/produkt/');
   }
 );
+
+const testExclude = testAppSuite('Rewrite routes with exclude', {
+  rewriteRoutes: [{ prefix: 'it', paths: {}, exclude: ['/docs/*'] }],
+});
+
+testExclude('exclude skips localized mirrors for matched routes', ({ ctx }) => {
+  const it = ctx.routeTrie.children.get('it');
+  assert.ok(it, 'prefix mirror "it" should exist for non-excluded routes');
+  assert.ok(it!.children.get('about-us'), 'non-excluded route is mirrored under "it"');
+  assert.is(it!.children.get('docs'), undefined, '"/docs/*" is excluded from the "it" mirror');
+});

packages/qwik-router/src/buildtime/build.ts

@@ -1,6 +1,7 @@
 import { addError, addWarning } from '../utils/format';
 import { createFileId, getPathnameFromDirPath } from '../utils/fs';
 import { ensureSlash } from '../utils/pathname';
+import { createRouteTester } from '../ssg/routes';
 import { resolveMenu } from './markdown/menu';
 import { resolveLayout, resolveRoute } from './routing/resolve-source-file';
 import { routeSortCompare } from './routing/sort-routes';
@@ -323,8 +324,15 @@ function applyRewriteRoutes(root: BuildTrieNode, rewriteConfigs: RewriteRouteOpt
   for (const config of rewriteConfigs) {
     const translations = config.paths || {};
     const translatable = new Set(Object.keys(translations).map((k) => k.toLowerCase()));
+    const isExcluded = config.exclude?.length
+      ? createRouteTester('/', config.exclude, undefined)
+      : undefined;
 
     for (const { steps } of routables) {
+      const originalKeyPath = steps.map((s) => s.key).join('/');
+      if (isExcluded?.('/' + originalKeyPath)) {
+        continue;
+      }
       // Check if any segment is translatable or if there's a prefix
       const hasTranslatable = steps.some((s) => translatable.has(s.key));
       if (!hasTranslatable && !config.prefix) {
@@ -335,9 +343,6 @@ function applyRewriteRoutes(root: BuildTrieNode, rewriteConfigs: RewriteRouteOpt
         continue;
       }
 
-      // Build the original key path
-      const originalKeyPath = steps.map((s) => s.key).join('/');
-
       // Build translated steps
       const translatedSteps: TriePathStep[] = [];
 

packages/qwik-router/src/buildtime/types.ts

@@ -135,6 +135,7 @@ export interface ParsedMenuItem {
 export interface RewriteRouteOption {
   prefix?: string;
   paths: Record<string, string>;
+  exclude?: string[];
 }
 
 /** @public */