vscode-php-debug icon indicating copy to clipboard operation
vscode-php-debug copied to clipboard

Clarify the Readme "VS Code Configuration" section for current workflow

Open jerclarke opened this issue 5 years ago • 4 comments

Hi, thanks for this extension!

This is a small thing, but the following instruction got me tripped up for awhile:

In your project, go to the debugger and hit the little gear icon and choose PHP. A new launch configuration will be created for you with two configurations:

I think maybe it refers to an older version of VS Code, or maybe it just misses the experience on a fresh copy of VS Code.

For me, getting started required me to do the following (sorry it's not word-for-word, I can't find a way to get back to that "fresh state" again either):

  • Open debug sidebar
  • The bar is empty except for a text description of what to do next including a link to "Create launch.json file" (specifically, there's no "gear icon" that does what the description above claims)
  • Click that JSON button
  • Use the command bar to select from a list of the folders in the current workspace, then choose to create the json file

At that point, the whole UI of the debug sidebar changes, and I think it becomes the one you are expecting where there's a pulldown menu with more options and stuff.

It's too bad they are so different, because it puts the onus on you to describe everything twice, but maybe it's worth it to make sure that brand new users are able to get off the ground?

It could even be a statement like "If you are setting up debug for the ground, follow the on-screen instructions to set up a JSON file for the folder you want to debug." I wouldn't have gotten stuck if I'd been given that hint.

Thanks for considering it!

jerclarke avatar Aug 24 '20 14:08 jerclarke

@jerclarke Totally agree. Without your instructions I couldn't have set up debugging.

mocsa avatar Dec 01 '20 21:12 mocsa

thanks for the guide, added configuration according some other threads here

sKopheK avatar Feb 16 '21 14:02 sKopheK

Indeed, a better guide would be welcome.

zobo avatar Feb 16 '21 14:02 zobo

Perhaps the official VSCode documentation could also be used as reference: https://code.visualstudio.com/docs/editor/debugging

zobo avatar Feb 16 '21 14:02 zobo

Some parts of this were done (https://github.com/xdebug/vscode-php-debug/pull/389) and the VSC debugger UI changed a bit, so I'll be closing this.

zobo avatar Jul 28 '23 14:07 zobo