feat: automatically generate ziggy types with vite

Author: SantosVilanculos

package-lock.json

@@ -20,7 +20,8 @@
         "prettier": "^3.4.2",
         "prettier-plugin-organize-imports": "^4.1.0",
         "prettier-plugin-tailwindcss": "^0.6.11",
-        "typescript-eslint": "^8.23.0"
+        "typescript-eslint": "^8.23.0",
+        "vite-plugin-run": "^0.6.1"
     },
     "dependencies": {
         "@headlessui/react": "^2.2.0",

package.json

@@ -0,0 +1,45 @@
+/* This file is generated by Ziggy. */
+declare module 'ziggy-js' {
+  interface RouteList {
+    "home": [],
+    "dashboard": [],
+    "profile.edit": [],
+    "profile.update": [],
+    "profile.destroy": [],
+    "password.edit": [],
+    "password.update": [],
+    "appearance": [],
+    "register": [],
+    "login": [],
+    "password.request": [],
+    "password.email": [],
+    "password.reset": [
+        {
+            "name": "token",
+            "required": true
+        }
+    ],
+    "password.store": [],
+    "verification.notice": [],
+    "verification.verify": [
+        {
+            "name": "id",
+            "required": true
+        },
+        {
+            "name": "hash",
+            "required": true
+        }
+    ],
+    "verification.send": [],
+    "password.confirm": [],
+    "logout": [],
+    "storage.local": [
+        {
+            "name": "path",
+            "required": true
+        }
+    ]
+}
+}
+export {};

resources/js/types/ziggy.d.ts

@@ -3,6 +3,7 @@ import react from '@vitejs/plugin-react';
 import laravel from 'laravel-vite-plugin';
 import { resolve } from 'node:path';
 import { defineConfig } from 'vite';
+import { run } from 'vite-plugin-run';
 
 export default defineConfig({
     plugins: [
@@ -13,6 +14,14 @@ export default defineConfig({
         }),
         react(),
         tailwindcss(),
+        run({
+            input: [
+                {
+                    run: ['php', 'artisan', 'ziggy:generate', '--types-only', 'resources/js/types/ziggy.d.ts'],
+                    pattern: ['config/ziggy.php', 'routes/**/*.php'],
+                },
+            ],
+        }),
     ],
     esbuild: {
         jsx: 'automatic',