More documentation needed around the setup generators

[jacebenson]

I would love to get more documentation around how these setup generators work, what's available to them and how to really take advantage of them.

I had to do a bunch of digging to understand what was available in the generator syntax.

I found this file, scaffold.js helpful in figuring this out.

I really wanted access to things that weren't available when I was digging into this, but they just weren't available.

It would be awesome if we had for each type of generated thing, what is available to do. e.g.

• Routes.js (doesn't seem like we change how this generates routes.
• Pages (we can change how this works with updating them, however, not all variables are availalbe here like they are in cells)
  • Missing things like columns, editable columns, relations (this is probably on purpose, but I had to dig into the code to see it)
• Cells (we can change how this works with updating them, however, it's also not clear What is available here)
  • Missing things like relations

[Tobbe]

@jacebenson Hi Jace, just to make it clear. You want more details in these docs, right? https://redwoodjs.com/docs/cli-commands#setup-generator

[jacebenson]

I should have posted this the next day. When updating the scaffold it's unclear what variables your have access to and how you can use them. So not specifically on the setup command but documentation on how to use the given variables in those generates pages, components, layouts, services, and sdls.

[Tobbe]

I'll see what I can do!

Someone else please pick this up 🙂

[samthuang]

hey hey @jtoar - I'd like to help with this issue if no one is actively working on this 🙂. However, can you help me understand the issue here a bit more? I am unsure which part of the documentation needs more clarification or examples 🤨. cheers

updating the scaffold it's unclear what variables your have access to and how you can use them. So not specifically on the setup command but documentation on how to use the given variables in those generates pages, components, layouts, services, and sdls.

[samthuang]

hey @jtoar, I tried using the --no-test flag on the generate scaffold command, and it worked perfectly. However, I couldn't find any documentation on this optional flag. Is this what the issue is about? If so, could you please provide me with more details on how to document this, is it around here?

Also, I was trying to locate where the --no-test flag is implemented, but I couldn't find it. Can you please guide me to the right place? thank you!