Fix db/generate (nested command-dirs) help messages

[jtoar]

Doing something like yarn rw db seed --help displays the help message for yarn rw db instead of yarn rw db seed:

Output for yarn rw db help

~/redwood-app$ yarn rw db --help
yarn run v1.22.4
$ /redwood-app/node_modules/.bin/rw db help
rw <command>

Commands:
  rw db down           Migrate your database down.
  rw db generate       Generate the Prisma client.
  rw db introspect     Introspect your database and generate the models in
                       api/prisma/schema.prisma (overwrites existing models).
  rw db save [name..]  Create a new migration.
  rw db seed           Seed your database with test data.
  rw db up             Generate the Prisma client and apply migrations.

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
Done in 0.88s.

Output for yarn rw db seed --help

~/redwood-app$ yarn rw db seed help
yarn run v1.22.4
$ /redwood-app/node_modules/.bin/rw db seed help
rw <command>

Commands:
  rw db down           Migrate your database down.
  rw db generate       Generate the Prisma client.
  rw db introspect     Introspect your database and generate the models in
                       api/prisma/schema.prisma (overwrites existing models).
  rw db save [name..]  Create a new migration.
  rw db seed           Seed your database with test data.
  rw db up             Generate the Prisma client and apply migrations.

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
Done in 0.90s.

This fix correctly "scopes" help output for db (and generate):

New output for yarn rw db seed --help

~/redwood-app$ yarn rw db seed --help
yarn run v1.22.4
$ /redwood-app/node_modules/.bin/rw db seed --help
rw db seed

Seed your database with test data.

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]
Done in 0.89s.

The fix

The fix was simply removing .args from the builder of db.js and generate.js:

// db.js
- yargs.commandDir('./dbCommands').demandCommand().argv
+ yargs.commandDir('./dbCommands').demandCommand()

// generate.js
- yargs.commandDir('./generate', { recurse: true }).demandCommand().argv
+ yargs.commandDir('./generate', { recurse: true }).demandCommand()

[thedavidprice]

🤯

This might be my new favorite PR. All. Time. I'm so glad I complained about this while we were talking 😆

If you are able to take this one step further, all the commands need to be constrained for errors using either .strict() or .strictCommands().

You can see the history of Peter and I's attempts starting in this comment from PR #136

I think ideally this should be used one time at the top-level builder, src/index.js, but we also experimented using it within generator.js (for example). Just make sure wherever it goes that it does not become too restrictive and either throw false error on other commands or not all all options for all commands to be use.

No worries if you don't want to dig into this part. Just let me know and I'll pick up the work in #136

[jtoar]

Be careful what you complain about--I might just fix it. 😅 And I started looking at that after throwing this one up. I ran into the generate commands error you mentioned in that thread. Definitely down to dig in here.

[jtoar]

@thedavidprice A top-level (index.js) strict() seems to be working for generators since v0.7.0. When you have the chance, could you confirm that yarn rw g commands work with this PR on your machine too?

This still might not be ideal for db commands (they still work, but can take more varied options if I remember correctly?), but generators weren’t working at all on the previous release and seem to work now for some reason.

[peterp]

This looks good to me!

@thedavidprice any reservations?

[thedavidprice]

Nice! I'll take this for a test drive today and loop back.

[thedavidprice]

K, super loving this.

Also, super rad unexpected behavior --> just yesterday I updated the build.js command to use a dynamic default for the build option array of Sides. I check for existing directories and then add them to the "option default" array:

  app: {
    choices: ['api', 'web'],
    default: optionDefault(webExists, apiExists),
  },

When the Yargs --help is run, I totally expected it to output optionDefault(webExists, apiExists) as a string or some nonsense. But it works!

$ yarn rw build --help
...
# in case of both directories existing
  --app                         [choices: "api", "web"] [default: ["web","api"]]

# in case where only web/ exists
  --app                               [choices: "api", "web"] [default: ["web"]]

I just 😍when the details JustWork™

[thedavidprice]

Closes #136

This one is working 💯. Merging now.