Build LSP directly in destination so source maps are correct

[lionel-]

We were building inside apps/lsp/dist, then copying over to apps/vscode/out/lsp. But the source maps are relative so they were no longer pointing to the correct locations.

Since this is a mono repo, I thought we could just directly build in the vscode's output directory.

With this change, we can set breakpoints inside the LSP. You'll first need to use the "Attach to LSP" launch action once the LSP process has been spawned.

[cscheid]

@juliasilge is this change safe for you? I wonder specifically if the action that builds the vsix installers will work under this change.

[lionel-]

Good point, I've checked that vsce package still works locally but I should do a manual run of the action on this PR.

[lionel-]

hmm that action was running automatically in #748 but here it didn't start.

[lionel-]

okay the GH actions were not watching over apps/lsp changes, now fixed

[cscheid]

Do similar changes need to happen in https://github.com/quarto-dev/quarto/blob/main/.github/workflows/publish.yaml? There's references to apps/vscode there as well.

[lionel-]

I don't think so. We don't need to watch LSP files in that workflow and regarding build dependencies, the dependency of apps/vscode on apps/lsp is internally defined. There is a prepublish step that calls turbo run build at top-level before building the extension:

quarto/apps/vscode/package.json

Line 1410 in a1513ef

"vscode:prepublish": "rm -rf ./out/markdownit && cd ../.. && turbo run build --force --filter quarto...",

This ensures apps/lsp is built (into vscode's out directory with the changes in this PR). I was curious how that worked and found out that's because all subfolders in apps/ are defined as Turbo workspaces there:

quarto/package.json

Line 6 in a1513ef

"apps/*",

. turbo looks for dependencies, including internal ones, in each package.json file. Since quarto-lsp (the module name of apps/lsp/) is a dendency of apps/vscode, the build order is guaranteed.

I wonder if we're actually building apps/vscode twice, once in the prepublish step and once in the build step. 🤔

[juliasilge]

It took me a couple of tries to get it to work, but I did manage to set a breakpoint in the LSP with this PR.

How would you feel about adding something in README.md or a new CONTRIBUTING.md about how to get that set up?

I cannot tell if we are building apps/vscode twice. 😬