feat(cli): Make scaffolded layout routing type-safe (#11542)

redwoodjs · Sep 15, 2024 · 4eb1fb6 · 4eb1fb6
1 parent b998283
commit 4eb1fb6
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 8 deletions.
diff --git a/.changesets/11542.md b/.changesets/11542.md
@@ -0,0 +1,5 @@
+- feat(cli): Make scaffolded layout routing type-safe (#11542) by @Tobbe
+
+With this feature we now make sure only valid route names are passed as `titleTo` and `buttonTo` props to the scaffolded layout.
+
+This also means you get helpful code completion when typing out the prop values
diff --git a/__fixtures__/test-project/web/src/layouts/ScaffoldLayout/ScaffoldLayout.tsx b/__fixtures__/test-project/web/src/layouts/ScaffoldLayout/ScaffoldLayout.tsx
@@ -3,9 +3,9 @@ import { Toaster } from '@redwoodjs/web/toast'
 
 type LayoutProps = {
   title: string
-  titleTo: string
+  titleTo: keyof typeof routes
   buttonLabel: string
-  buttonTo: string
+  buttonTo: keyof typeof routes
   children: React.ReactNode
 }
 

diff --git a/packages/cli/src/commands/generate/scaffold/__tests__/__snapshots__/scaffold.test.js.snap b/packages/cli/src/commands/generate/scaffold/__tests__/__snapshots__/scaffold.test.js.snap
@@ -2440,9 +2440,9 @@ import { Toaster } from '@redwoodjs/web/toast'
 
 type LayoutProps = {
   title: string
-  titleTo: string
+  titleTo: keyof typeof routes
   buttonLabel: string
-  buttonTo: string
+  buttonTo: keyof typeof routes
   children: React.ReactNode
 }
 

diff --git a/...es/cli/src/commands/generate/scaffold/__tests__/__snapshots__/scaffoldNoNest.test.js.snap b/...es/cli/src/commands/generate/scaffold/__tests__/__snapshots__/scaffoldNoNest.test.js.snap
@@ -1500,9 +1500,9 @@ import { Toaster } from '@redwoodjs/web/toast'
 
 type LayoutProps = {
   title: string
-  titleTo: string
+  titleTo: keyof typeof routes
   buttonLabel: string
-  buttonTo: string
+  buttonTo: keyof typeof routes
   children: React.ReactNode
 }
 

diff --git a/packages/cli/src/commands/generate/scaffold/templates/layouts/ScaffoldLayout.tsx.template b/packages/cli/src/commands/generate/scaffold/templates/layouts/ScaffoldLayout.tsx.template
@@ -3,9 +3,9 @@ import { Toaster } from '@redwoodjs/web/toast'
 
 type LayoutProps = {
   title: string
-  titleTo: string
+  titleTo: keyof typeof routes
   buttonLabel: string
-  buttonTo: string
+  buttonTo: keyof typeof routes
   children: React.ReactNode
 }