Merge pull request #32 from aktasumut34/js-reserved-route-names

Add route prefix to reserved js keyword route names

Author: joetannenbaum

src/GenerateCommand.php

@@ -202,10 +202,8 @@ private function writeNamedFile(Collection $routes, string $namespace): void
         $imports = $routes->map(fn (Route $route) => $route->namedMethod())->implode(', ');
 
         $basename = basename($path, '.ts');
-        $base = Str::of($basename)->when(
-            str_contains($basename, '-'),
-            fn ($s) => $s->camel()
-        )->toString();
+
+        $base = TypeScript::safeMethod($basename, 'Route');
 
         if ($base !== $imports) {
             $this->appendContent($path, "const {$base} = { {$imports} }\n");

src/Route.php

@@ -56,12 +56,7 @@ public function originalJsMethod()
 
     public function namedMethod(): string
     {
-        $base = Str::afterLast($this->name(), '.');
-
-        return $this->finalJsMethod(
-            str_contains($base, '-') ?
-                Str::camel($base) : $base
-        );
+        return $this->finalJsMethod(Str::afterLast($this->name(), '.'));
     }
 
     public function controller(): string
@@ -165,51 +160,7 @@ public function controllerMethodLineNumber(): int
 
     private function finalJsMethod(string $method): string
     {
-        $reserved = [
-            'break',
-            'case',
-            'catch',
-            'class',
-            'const',
-            'continue',
-            'debugger',
-            'default',
-            'delete',
-            'do',
-            'else',
-            'export',
-            'extends',
-            'false',
-            'finally',
-            'for',
-            'function',
-            'if',
-            'import',
-            'in',
-            'instanceof',
-            'new',
-            'null',
-            'return',
-            'super',
-            'switch',
-            'this',
-            'throw',
-            'true',
-            'try',
-            'typeof',
-            'var',
-            'void',
-            'while',
-            'with',
-        ];
-
-        $method = in_array($method, $reserved) ? $method.'Method' : $method;
-
-        if (is_numeric($method)) {
-            return 'method'.$method;
-        }
-
-        return $method;
+        return TypeScript::safeMethod($method, 'Method');
     }
 
     private function relativePath(string $path)

src/TypeScript.php

@@ -6,6 +6,65 @@
 
 class TypeScript
 {
+    public const RESERVED_KEYWORDS = [
+        'break',
+        'case',
+        'catch',
+        'class',
+        'const',
+        'continue',
+        'debugger',
+        'default',
+        'delete',
+        'do',
+        'else',
+        'export',
+        'extends',
+        'false',
+        'finally',
+        'for',
+        'function',
+        'if',
+        'import',
+        'in',
+        'instanceof',
+        'new',
+        'null',
+        'return',
+        'super',
+        'switch',
+        'this',
+        'throw',
+        'true',
+        'try',
+        'typeof',
+        'var',
+        'void',
+        'while',
+        'with',
+    ];
+
+    public static function safeMethod(string $method, string $suffix): string
+    {
+        $method = str($method);
+
+        if ($method->contains('-')) {
+            $method = $method->camel();
+        }
+
+        $suffix = strtolower($suffix);
+
+        if (in_array($method, self::RESERVED_KEYWORDS)) {
+            return $method->append(ucfirst($suffix));
+        }
+
+        if (is_numeric((string) $method)) {
+            return $method->prepend($suffix);
+        }
+
+        return $method;
+    }
+
     public static function cleanUp(string $view): string
     {
         $replacements = [

tests/DisallowedMethodNames.test.ts

@@ -3,6 +3,7 @@ import DisallowedMethodNameController, {
     deleteMethod,
     method404,
 } from "../workbench/resources/js/actions/App/Http/Controllers/DisallowedMethodNameController";
+import route404 from "../workbench/resources/js/routes/disallowed/404";
 
 test("will append `method` to invalid methods", () => {
     expect(method404.url()).toBe("/disallowed/404");
@@ -12,3 +13,7 @@ test("will append `method` to invalid methods", () => {
     );
     expect(DisallowedMethodNameController[404].url()).toBe("/disallowed/404");
 });
+
+test("will append `method` to invalid methods", () => {
+    expect(route404.method404.url()).toBe("/disallowed/404");
+});

workbench/routes/web.php

@@ -66,7 +66,7 @@
 Route::get('/two-routes-one-action-2', [TwoRoutesSameActionController::class, 'same']);
 
 Route::get('/disallowed/delete', [DisallowedMethodNameController::class, 'delete']);
-Route::get('/disallowed/404', [DisallowedMethodNameController::class, '404']);
+Route::get('/disallowed/404', [DisallowedMethodNameController::class, '404'])->name('disallowed.404');
 
 Route::get('/anonymous-middleware', [AnonymousMiddlewareController::class, 'show']);