Auto execute Next steps

[brillout]

The following is a copy-paste of some DMs between Joel and Rom.

---

On peut commencer a juste les afficher au "Next steps"
A priori, les executer en sois c'est j'imagine la parti simple
Collecter les commands c'est la parti interessante (e.g. ordering)
On peut aussi demander: "Do you want me to execute these commands on your behalf?"
Idee: on pourrait faire un beau commit history
On commit apres chaque command
A la fin on dit: run git log to see the list of commands run, and git log -p to see the result of each command
Du coup je me dis on peut ptet bien executer les commands par defaut... on garde les "Next steps" afficher a l'utilisateurs
Idee pel mel:

• On ajoute les Next steps au TODO.md (on les affiche quand meme avant de les executer)
• On affiche "Hit Ctrl-C to abort and run the "Next steps" (see TODO.md) commands yourself, see "Next steps" at TODO.md )"
• A la fin on supprime les "Next steps" du TODO.md
• Un countdown:

  Executing Next Steps on your behalf in 5 seconds (press <Enter> to execute now, or Ctrl-C to abort and run them manually instead)
  Executing Next Steps on your behalf in 4 seconds (press <Enter> to execute now, or Ctrl-C to abort and run them manually instead)
  Executing Next Steps on your behalf in 3 seconds (press <Enter> to execute now, or Ctrl-C to abort and run them manually instead)
  Executing Next Steps on your behalf in 2 seconds (press <Enter> to execute now, or Ctrl-C to abort and run them manually instead)
  Executing Next Steps on your behalf in 1 seconds (press <Enter> to execute now, or Ctrl-C to abort and run them manually instead)
  

Juste des idees, par soucis d'efficacé on peut skip des idees
Par example, ptet que ca ne vaut pas le coup d'ajouter les Next steps au TODO.md
Ou on les ajoute que si il aborte, c'est ptet plus simple (et si c'est fiable d'ecrire su le FS avant exit)

[magne4000]

The first iteration would be:

• Update bati.config.ts to declare succinct next steps (commands + their prerequisites if any)
• Show this information in the CLI, with proper ordering (use order magic number)

#635

[magne4000]

Second iteration:

• Add ordered "Extra Steps" to TODO.md
• Propose to auto exec the steps, and update TODO.md while progressing: [ ] -> [x]
• If encountering a manual step, abort and print extra steps

[magne4000]

Third iteration:

• Interactive mode for manual steps whenever possible

[brillout]

I wonder if there is a boilerplate that requires a manual TODO to start the dev server.

Maybe it could make sense to distinguish between:

• TODO required for development
• TODO required for deployment
• extra TODOs (e.g. wrangler types)

And maybe treat them differently (e.g. only showing the dev TODOs in Next steps).

[brillout]

I increasingly think categories could be quite neat (while only marginally adding implementation complexity, AFAICT).

TODO.md

Install:
[x] 1. `pnpm install`

Database:
[x] 1. ...
[x] 2. ...
[x] 3. ...

> See [Database](#database) for more information.

TypeScript:
[x] 1. ...

> See [TypeScript](#typescript) for more information.

Deployment:
[ ] 1. ...
[ ] 2. ...

> See [Deployment](#deployment) for more information.

Extras:
[ ] 1. ...
[ ] 2. ...


## Database

...

## TypeScript

...

## Deployment

...

Note

Maybe we can give every step a proper category — we don't Extras then.

CLI

Next steps (required for development):
  $ cd my-app/
  $ pnpm install
  $ pnpm wrangler d1 create my-vike-demo-database
  $ pnpm d1:migrate
  $ pnpm prisma init --db
  $ pnpm dev

See TODO.md for further steps for TypeScript and deployment.

Auto-running TODO steps in 3 seconds (hit **Ctrl-C** to abort, or **<Enter>** to start now).

Note

• Next steps are the minimal steps required to make pnpm dev work.
• for further steps [include all categories that have a step not included in the Next steps above].
• There isn't a 1-1 mapping between Next steps and the steps in TODO.md => a numbered list for Next steps would be counter productive.

Auto-run

I think the auto run should run as much as possible (more than just Next steps). It makes the initial startup slower, but I AFAICT it's worth it.

[magne4000]

I increasingly think categories could be quite neat (while only marginally adding implementation complexity, AFAICT).

I was thinking the same thing. We probably should also show the categories in the Next Steps CLI when the user decides to not auto-run:

Next steps (required for development):
  $ cd my-app/
  $ pnpm install
Database:
  $ pnpm wrangler d1 create my-vike-demo-database
  $ pnpm d1:migrate
  $ pnpm prisma init --db
Run dev server:
  $ pnpm dev

[magne4000]

I think the auto run should run as much as possible (more than just Next steps). It makes the initial startup slower, but I AFAICT it's worth it.

What do you mean by "more than just Next steps"?

[brillout]

👍 Maybe to make it clearer that required for development refers to all steps:

Next steps (required for development):
  $ cd my-app/
  $ pnpm install
  Database [colorette.dim()]
  $ pnpm wrangler d1 create my-vike-demo-database
  $ pnpm d1:migrate
  $ pnpm prisma init --db
  Run dev server [colorette.dim()]
  $ pnpm dev

[brillout]

What do you mean by "more than just Next steps"?

For example pnpm wrangler types, so far I think it shouldn't be part of the shown Next steps but should be auto-executed.