Fix barrel self-import when a route name is both a leaf and a prefix … (#317)

* Fix barrel self-import when a route name is both a leaf and a prefix of "index"

A barrel child named "index" is written to "index/index.ts", but the
generated import referenced "./index". Every resolver prefers the sibling
"index.ts", so the barrel imported itself.

With `photos.index` and `photos.index.window`, `photos/index.ts` emitted
`import index<hash> from './index'`, producing TS7022 and TS2303 under tsc.
Bundlers accepted it silently because `Object.assign(index, undefined)` is a
no-op, so `photos.index.window` was dropped with no warning.

When the "index" prefix has no leaf route of its own, such as
`albums.index.recent`, the previous `$key !== 'index'` filter removed the
import altogether while still emitting `Object.assign(index, index)`, leaving
`index` undeclared: TS2304, and a ReferenceError at runtime.

Import such a child by its full path instead, and narrow the filter so it only
drops an "index" child that has no grandchildren, keeping the actions path
unchanged.

* just do map and implode once

* Update GenerateCommand.php

---------

Co-authored-by: Joe Tannenbaum <joe.tannenbaum@laravel.com>

Author: imanimen

src/GenerateCommand.php

@@ -398,11 +398,17 @@ private function writeBarrelFiles(array|Collection $children, string $parent): v
             ];
         });
 
-        if (! ($this->content[$indexPath] ?? false)) {
-            $imports = $childKeys->filter(fn ($_, $key) => $key !== 'index')->map(fn ($alias, $key) => "import {$alias['safe']} from './{$key}'")->implode(PHP_EOL);
-        } else {
-            $imports = $childKeys->only($keysWithGrandkids->keys())->map(fn ($alias, $key) => "import {$alias['safe']} from './{$key}'")->implode(PHP_EOL);
-        }
+        // A child named "index" is written to "index/index.ts", but every resolver
+        // prefers the sibling "index.ts" for "./index", so it has to be imported
+        // by its full path or the barrel silently ends up importing itself.
+        $importPath = fn ($key) => $key === 'index' ? './index/index' : "./{$key}";
+
+        $importable = ($this->content[$indexPath] ?? false)
+            ? $childKeys->only($keysWithGrandkids->keys())
+            // A childless "index" is a leaf written into this same file, so it needs no import.
+            : $childKeys->filter(fn ($_, $key) => $key !== 'index' || $keysWithGrandkids->has($key));
+
+        $imports = $importable->map(fn ($alias, $key) => "import {$alias['safe']} from '{$importPath($key)}'")->implode(PHP_EOL);
 
         if ($imports) {
             $this->prependContent($indexPath, $imports);

tests/IndexNamedRoute.test.ts

@@ -0,0 +1,12 @@
+import { expect, it } from "vitest";
+import albums from "../workbench/resources/js/routes/albums";
+import photos from "../workbench/resources/js/routes/photos";
+
+it("can handle a route name that is both a leaf and a prefix of 'index'", () => {
+    expect(photos.index().url).toBe("/photos");
+    expect(photos.index.window().url).toBe("/photos/window");
+});
+
+it("can handle an 'index' prefix with no leaf route of its own", () => {
+    expect(albums.index.recent().url).toBe("/albums/recent");
+});

workbench/routes/web.php

@@ -104,3 +104,8 @@
         Route::get('/', fn () => 'ok')->name('index');
     });
 });
+
+Route::get('/photos', fn () => 'ok')->name('photos.index');
+Route::get('/photos/window', fn () => 'ok')->name('photos.index.window');
+
+Route::get('/albums/recent', fn () => 'ok')->name('albums.index.recent');