VS Code launch configuration to debug the user's Indiekit installation #769
Conversation
There was a problem hiding this comment.
This is really interesting, and can see how it would help people onboard to the project! That said, I think it should be optional, much like adding Docker files to a project. We can do this by asking something like ‘Would you like to enable debugging in VS Code?’ as the final setup prompt.
| "name": "Debug Indiekit", | ||
| "skipFiles": ["<node_internals>/**"], | ||
| "program": "${workspaceFolder}/node_modules/@indiekit/indiekit/bin/cli.js", | ||
| // "args": ["--config", "path/to/your/indiekit.config.js"] |
There was a problem hiding this comment.
Is this commented out code needed?
There was a problem hiding this comment.
I wasn't sure which arguments were accepted by cli.js. Later I ended up using this:
"args": ["--config", "indiekit.config.js", "serve"]| @@ -19,7 +19,7 @@ | |||
| "type": "module", | |||
| "main": "index.js", | |||
| "bin": { | |||
| "create-indiekit": "bin/create.js" | |||
| "create-indiekit": "bin/create.js delete-me" | |||
There was a problem hiding this comment.
What does delete-me do here? I need to revisit this, but I think this script is called when you run npm init indiekit [directory name] or npm create indiekit [directory name]. Does this interfere with that?
There was a problem hiding this comment.
Yes, I was using delete-me as a placeholder for [directory name]
I agree. Better to make it optional like Docker. |
paulrobertlloyd
force-pushed
the
main
branch
2 times, most recently
from
1b91b6e to
69936a4
Compare
paulrobertlloyd
force-pushed
the
main
branch
4 times, most recently
from
3225b55 to
7934b22
Compare
paulrobertlloyd
force-pushed
the
main
branch
2 times, most recently
from
f8d0cc8 to
f877637
Compare
This PR adds a template for a VS Code launch configuration that will be will materialize at
.vscode/launch.jsonin the user's Indiekit installation after they run thecreate-indiekitCLI.This file will allow the user to just press
F5and start debugging their Indiekit installation.