Also cover _index segments at the end

Author: onurtemizkan

packages/remix/src/config/createRemixRouteManifest.ts

@@ -56,6 +56,7 @@ export function convertRemixRouteToPath(filename: string): { path: string; isDyn
  const segments = normalizedBasename.split('.');
  const pathSegments: string[] = [];
  let isDynamic = false;
+ let isIndexRoute = false;
 
  for (let i = 0; i < segments.length; i++) {
  const segment = segments[i];
@@ -68,7 +69,16 @@ export function convertRemixRouteToPath(filename: string): { path: string; isDyn
  continue;
  }
 
+ // Handle '_index' segments at the end (always skip - indicates an index route)
+ if (segment === '_index' && i === segments.length - 1) {
+ isIndexRoute = true;
+ continue;
+ }
+
+ // Handle 'index' segments at the end (skip only if there are path segments,
+ // otherwise root index is handled by the early return above)
  if (segment === 'index' && i === segments.length - 1 && pathSegments.length > 0) {
+ isIndexRoute = true;
  continue;
  }
 
@@ -87,13 +97,13 @@ export function convertRemixRouteToPath(filename: string): { path: string; isDyn
  }
  }
 
- // If all segments were skipped (pathless layout route like _layout.tsx, _auth.tsx),
- // return null to indicate this file should not be added to the route manifest
- if (pathSegments.length === 0) {
+ // If all segments were skipped AND it's not an index route,
+ // it's a pathless layout route (like _layout.tsx, _auth.tsx) - exclude from manifest
+ if (pathSegments.length === 0 && !isIndexRoute) {
  return null;
  }
 
- const path = `/${pathSegments.join('/')}`;
+ const path = pathSegments.length > 0 ? `/${pathSegments.join('/')}` : '/';
  return { path, isDynamic };
 }
 

packages/remix/src/utils/utils.ts

@@ -76,7 +76,13 @@ export function convertRemixRouteIdToPath(routeId: string): string {
  continue;
  }
 
- // Handle 'index' segments at the end (they don't add to the path)
+ // Handle '_index' segments at the end (always skip - indicates an index route)
+ if (segment === '_index' && i === segments.length - 1) {
+ continue;
+ }
+
+ // Handle 'index' segments at the end (skip only if there are path segments,
+ // otherwise root index is handled by the early return above)
  if (segment === 'index' && i === segments.length - 1 && pathSegments.length > 0) {
  continue;
  }

packages/remix/test/config/manifest/createRemixRouteManifest.test.ts

@@ -133,4 +133,95 @@ describe('createRemixRouteManifest', () => {
  );
  });
  });
+
+ describe('_index route handling', () => {
+ it('should handle root _index route', () => {
+ const { tempDir, routesDir } = createTestDir();
+
+ fs.writeFileSync(path.join(routesDir, '_index.tsx'), '// root index');
+
+ const manifest = createRemixRouteManifest({ rootDir: tempDir });
+
+ expect(manifest.staticRoutes).toHaveLength(1);
+ expect(manifest.staticRoutes).toContainEqual({ path: '/' });
+ });
+
+ it('should handle nested _index routes using flat file convention', () => {
+ const { tempDir, routesDir } = createTestDir();
+
+ // Flat file convention: users._index.tsx represents /users index
+ fs.writeFileSync(path.join(routesDir, '_index.tsx'), '// root index');
+ fs.writeFileSync(path.join(routesDir, 'users._index.tsx'), '// users index');
+ fs.writeFileSync(path.join(routesDir, 'users.$id.tsx'), '// user detail');
+
+ const manifest = createRemixRouteManifest({ rootDir: tempDir });
+
+ // Both root and users index should map to their parent paths
+ expect(manifest.staticRoutes).toContainEqual({ path: '/' });
+ expect(manifest.staticRoutes).toContainEqual({ path: '/users' });
+
+ // users.$id.tsx should be a dynamic route
+ expect(manifest.dynamicRoutes).toContainEqual(
+ expect.objectContaining({
+ path: '/users/:id',
+ regex: '^/users/([^/]+)$',
+ paramNames: ['id'],
+ }),
+ );
+
+ // Should NOT contain /users/_index as a path
+ expect(manifest.staticRoutes).not.toContainEqual({ path: '/users/_index' });
+ });
+
+ it('should handle deeply nested _index routes', () => {
+ const { tempDir, routesDir } = createTestDir();
+
+ // Flat file convention for deeply nested index
+ fs.writeFileSync(path.join(routesDir, 'admin.settings._index.tsx'), '// admin settings index');
+
+ const manifest = createRemixRouteManifest({ rootDir: tempDir });
+
+ expect(manifest.staticRoutes).toContainEqual({ path: '/admin/settings' });
+ expect(manifest.staticRoutes).not.toContainEqual({ path: '/admin/settings/_index' });
+ });
+
+ it('should handle _index in directory-based nested routes', () => {
+ const { tempDir, routesDir } = createTestDir();
+ const usersDir = path.join(routesDir, 'users');
+ fs.mkdirSync(usersDir, { recursive: true });
+
+ fs.writeFileSync(path.join(routesDir, '_index.tsx'), '// root index');
+ fs.writeFileSync(path.join(usersDir, '_index.tsx'), '// users index');
+ fs.writeFileSync(path.join(usersDir, '$id.tsx'), '// user detail');
+
+ const manifest = createRemixRouteManifest({ rootDir: tempDir });
+
+ expect(manifest.staticRoutes).toContainEqual({ path: '/' });
+ expect(manifest.staticRoutes).toContainEqual({ path: '/users' });
+ expect(manifest.dynamicRoutes).toContainEqual(
+ expect.objectContaining({
+ path: '/users/:id',
+ }),
+ );
+ });
+
+ it('should handle _index with layout routes', () => {
+ const { tempDir, routesDir } = createTestDir();
+
+ // _auth is a pathless layout, _auth._index is its index
+ fs.writeFileSync(path.join(routesDir, '_auth.tsx'), '// auth layout');
+ fs.writeFileSync(path.join(routesDir, '_auth._index.tsx'), '// auth index');
+ fs.writeFileSync(path.join(routesDir, '_auth.login.tsx'), '// login page');
+
+ const manifest = createRemixRouteManifest({ rootDir: tempDir });
+
+ // _auth layout should be excluded (pathless layout)
+ // _auth._index should map to / (root under pathless layout)
+ // _auth.login should map to /login
+ expect(manifest.staticRoutes).toContainEqual({ path: '/' });
+ expect(manifest.staticRoutes).toContainEqual({ path: '/login' });
+ expect(manifest.staticRoutes).not.toContainEqual({ path: '/_auth' });
+ expect(manifest.staticRoutes).not.toContainEqual({ path: '/_auth/_index' });
+ });
+ });
 });

packages/remix/test/utils/utils.test.ts

@@ -1,6 +1,6 @@
 import type { AgnosticRouteObject } from '@remix-run/router';
 import { describe, expect, it } from 'vitest';
-import { getTransactionName } from '../../src/utils/utils';
+import { convertRemixRouteIdToPath, getTransactionName } from '../../src/utils/utils';
 
 describe('getTransactionName', () => {
  const mockRoutes: AgnosticRouteObject[] = [
@@ -74,5 +74,110 @@ describe('getTransactionName', () => {
  expect(name).toBe('/docs/:*');
  expect(source).toBe('route');
  });
+
+ it('should handle nested _index routes', () => {
+ const routesWithNestedIndex: AgnosticRouteObject[] = [
+ {
+ id: 'routes/users._index',
+ path: '/users',
+ },
+ ];
+
+ const url = new URL('http://localhost/users');
+ const [name, source] = getTransactionName(routesWithNestedIndex, url);
+
+ // Should return /users, not /users/_index
+ expect(name).toBe('/users');
+ expect(source).toBe('route');
+ });
+ });
+});
+
+describe('convertRemixRouteIdToPath', () => {
+ describe('basic routes', () => {
+ it('should convert root _index route', () => {
+ expect(convertRemixRouteIdToPath('routes/_index')).toBe('/');
+ });
+
+ it('should convert root index route', () => {
+ expect(convertRemixRouteIdToPath('routes/index')).toBe('/');
+ });
+
+ it('should convert static routes', () => {
+ expect(convertRemixRouteIdToPath('routes/about')).toBe('/about');
+ expect(convertRemixRouteIdToPath('routes/contact')).toBe('/contact');
+ });
+
+ it('should convert dynamic routes', () => {
+ expect(convertRemixRouteIdToPath('routes/user.$id')).toBe('/user/:id');
+ expect(convertRemixRouteIdToPath('routes/blog.$slug')).toBe('/blog/:slug');
+ });
+ });
+
+ describe('_index route handling', () => {
+ it('should handle nested _index routes (flat file convention)', () => {
+ // users._index should map to /users, not /users/_index
+ expect(convertRemixRouteIdToPath('routes/users._index')).toBe('/users');
+ });
+
+ it('should handle deeply nested _index routes', () => {
+ expect(convertRemixRouteIdToPath('routes/admin.settings._index')).toBe('/admin/settings');
+ expect(convertRemixRouteIdToPath('routes/api.v1.users._index')).toBe('/api/v1/users');
+ });
+
+ it('should handle _index with dynamic segments', () => {
+ // This represents an index route under a dynamic segment
+ expect(convertRemixRouteIdToPath('routes/users.$id._index')).toBe('/users/:id');
+ });
+
+ it('should handle _index under pathless layouts', () => {
+ // _auth is a pathless layout, _auth._index is its index (maps to /)
+ expect(convertRemixRouteIdToPath('routes/_auth._index')).toBe('/');
+ // _dashboard.settings._index maps to /settings (skipping _dashboard)
+ expect(convertRemixRouteIdToPath('routes/_dashboard.settings._index')).toBe('/settings');
+ });
+
+ it('should NOT include _index as a path segment', () => {
+ const result = convertRemixRouteIdToPath('routes/users._index');
+ expect(result).not.toContain('_index');
+ });
+ });
+
+ describe('index route handling (non-underscore)', () => {
+ it('should handle nested index routes', () => {
+ expect(convertRemixRouteIdToPath('routes/users.index')).toBe('/users');
+ });
+
+ it('should handle deeply nested index routes', () => {
+ expect(convertRemixRouteIdToPath('routes/admin.settings.index')).toBe('/admin/settings');
+ });
+ });
+
+ describe('layout routes', () => {
+ it('should skip pathless layout segments', () => {
+ expect(convertRemixRouteIdToPath('routes/_auth.login')).toBe('/login');
+ expect(convertRemixRouteIdToPath('routes/_dashboard.settings')).toBe('/settings');
+ });
+
+ it('should handle multiple pathless layouts', () => {
+ expect(convertRemixRouteIdToPath('routes/_auth._layout.login')).toBe('/login');
+ });
+ });
+
+ describe('splat routes', () => {
+ it('should convert splat routes', () => {
+ expect(convertRemixRouteIdToPath('routes/docs.$')).toBe('/docs/:*');
+ expect(convertRemixRouteIdToPath('routes/$')).toBe('/:*');
+ });
+ });
+
+ describe('complex nested routes', () => {
+ it('should handle multiple dynamic segments', () => {
+ expect(convertRemixRouteIdToPath('routes/users.$userId.posts.$postId')).toBe('/users/:userId/posts/:postId');
+ });
+
+ it('should handle mixed static and dynamic segments', () => {
+ expect(convertRemixRouteIdToPath('routes/api.v1.users.$id.comments')).toBe('/api/v1/users/:id/comments');
+ });
  });
 });