Rewrite argument handling in @mui/toolpad CLI with yargs

[bharatkashyap]

• Closes Support CLI --help command #1744

• Closes Getting started with Toolpad to be improved #1653

• Visual demonstration

Closes #1744

[Janpot]

• I propose we keep --dev instead of changing it to --next-prod because:
  • prod should be the default, so we need a flag to enable dev mode
  • Let's keep the name --dev to avoid breaking other contributor's workflow.
• --dev is for Toolpad contributors only, it doesn't have to be documented in the --help command, regular users shouldn't use this flag.
• Should we do the same for create-toolpad-app?

[bharatkashyap]

• I propose we keep --dev instead of changing it to --next-prod because:

  • prod should be the default, so we need a flag to enable dev mode
  • Let's keep the name --dev to avoid breaking other contributor's workflow.

For me, the only reason to move away from --dev is the confusion it creates with the command of the same name.

• --dev is for Toolpad contributors only, it doesn't have to be documented in the --help command, regular users shouldn't use this flag.

✅

• Should we do the same for create-toolpad-app?

Yes, added some thoughts in #1795

[Janpot]

For me, the only reason to move away from --dev is the confusion it creates with the command of the same name.

Ok, let's maybe change it to an environment variable TOOLPAD_NEXT_DEV? (we need it for the tests anyway), but not in this PR, let's leave it at --dev for this PR, undocumented.