[productivity] (vscode) add server test launch configurations

[pq]

Spending a bit of time on devtools yesterday, I found myself really appreciating the pre-populated run configurations. It would be great (especially for casual contributors) to do the same for server/analyzer/linter.

---

Launches

• server test: all
• linter test: all

Tasks

• server generate files

[FMorschel]

I was debugging just now with the latest commit and my vscode launch got automatically changed to one of the inner launch-configs (I think this is the default behaviour since that one is more specific). I got a bit confused because I had just a few tests (running pkg\analysis_server\test\src\services\correction\assist\flutter_wrap_builder_test.dart) and now it was running many tests I didn't even know about.

I was talking to @DanTup, and he suggested these launch files could have a "single file" launch too and have that first. WDYT?

Something like:

{
  "name": "Current file",
  "request": "launch",
  "type": "dart",
  "program": "${file}",
}

[DanTup]

My personal recommendation would generally be for the first launch config to always be for the current file (note you don't need to explicitly include $file, because we can infer it - and that works better for things like Flutter apps where the script you want to launch is a well-known location like lib/main.dart for most files in the project).

For example, my analysis server workspace file has configs starting like this:

By having this first, the default experience is for F5 to continue to do what it would do without the launch config (it will attempt to do the right thing for the file you have open), however you can still change launch config on the Debug sidebar (and this value will persist) if you'd prefer some other behaviour (like always having F5 run all tests).

Although I'll also note that when I pulled changes and opened my analysis server workspace, it didn't revert to the "first" one in the list and continued to use mine, so I wouldn't have triggered the issue @FMorschel hit:

[FMorschel]

Although I'll also note that when I pulled changes and opened my analysis server workspace, it didn't revert to the "first" one in the list and continued to use mine

Did you open the test file I mentioned above? It is completely possible I did something by mistake but I don't remember anything similar to this. I figured since I had that file opened it swapped since it was the closer launch setting.

[DanTup]

Did you open the test file I mentioned above?

I didn't, but I just tried and it didn't change anything. But I wouldn't have expected it to - I think your issue with that test file was just that the selected launch config was one with a hard-coded program, and I wouldn't expect opening any files to change the selected launch config (I think there's also no API for an extension to change the selected debug config either).

I wonder if opening some other combination of folders may have pre-selected the test: all config from the analysis server, and then that persisted when you came back to your main workspace?

[FMorschel]

I don't open my SDK folder without the workspace file (the workspace file is pinned on the taskbar vscode launch - named Server2 because I had a first copy I don't have anymore), and I had basically just done git fetch and git checkout origin/main -b my-new-branch-name.

But anyway, it is all working now. Hopefully, it was only me and this doesn't happen for anybody else.

[pq]

So interesting! I actually hit this too and was flummoxed but attributed that to my relative newness to VS Code launch configs. This is all really helpful. It sounds like a "current file" config would be generally valued so I'll follow-up with that. Thanks!

If there are other launch/task configs that you think would be useful, please let me know.

Thanks so much!

[DanTup]

If there are other launch/task configs that you think would be useful, please let me know.

I don't know if they're universally helpful, but I use a custom .code-workspace file when working on the analysis server (so I could have my own configs and settings without having to commit them), and the most useful launch configs are probably these:

{
	"name": "Dart & Flutter",
	"request": "launch",
	"type": "dart",
},
{
	"name": "Generate LSP classes",
	"request": "launch",
	"type": "dart",
	"program": "tool/lsp_spec/generate_all.dart",
	"cwd": "D:/Dev/Google/dart-sdk/sdk/pkg/analysis_server",
},
{
	"name": "Generate LSP classes w/ Download",
	"request": "launch",
	"type": "dart",
	"program": "tool/lsp_spec/generate_all.dart",
	"cwd": "D:/Dev/Google/dart-sdk/sdk/pkg/analysis_server",
	"args": [
		"--download"
	]
},
{
	"name": "Generate Legacy classes",
	"request": "launch",
	"type": "dart",
	"program": "tool/spec/generate_all.dart",
	"cwd": "D:/Dev/Google/dart-sdk/sdk/pkg/analysis_server",
},
{
	"name": "Generate Legacy classes (analyzer_plugin)",
	"request": "launch",
	"type": "dart",
	"program": "tool/spec/generate_all.dart",
	"cwd": "D:/Dev/Google/dart-sdk/sdk/pkg/analyzer_plugin",
},

I'm not sure why I have absolute paths in cwds, they should also work as relative paths!