createModelReference

[cdietrich]

Hi, do know how createModelReference and what is actually sent to the language server.
something like

  const modelRef = await createModelReference(Uri.parse("dully.our.extension"), `package x entity Y {}`)
  modelRef.object.setLanguageId("our-language-id")

works

now we try to funnel addtional config files to the server

const modelRef2 = await createModelReference(Uri.parse("dully.json"), `{"a":"b"}`)
modelRef2.object.setLanguageId("json")

but how will this end up in the server.

do you have another idea how we can funnel config to the server?

[CGNonofr]

It's your responsability to keep client and server filesystem in sync.

Btw, I don't recommend using the second parameter of createModelReference, you better register your file in the virtual filesystem, or using a custom filesystem provider, then use createModelReference.

What I recommend is:

• You first create all the required files on the server filesystem
• You implement your custom FileSystemProvider, that read and write files on your server via the protocol of your choice
• You use createModelReference to open files that exists on your server

[CGNonofr]

vscode.workspace.openTextDocument triggers those LSP messages in the end:

FYI vscode.workspace.openTextDocument just call createModelReference internally, and dispose the reference after a timeout

@CGNonofr do you have more resources / docs regarding usage of file system providers in a worker context or general file system sync recipes with LSP?

I can tell you how @CodinGame: we've extended the LSP to add 4 new methods file/read, file/write, file/stats and file/readdir. The server act as a LSP proxy, intercept all requests, handle those 4 requests, and forward everything else to the delegate language server.
On the client side:

• We add in the initialization request initializationOptions all the open file content in the client, the server proxy use it to initialize the filesystem then remove it from the request
• we use the 4 additional methods to implement a custom FileSystemProvider we registrer

Does it answer your question? I don't have much to say about workers

[kaisalmen]

Does it answer your question? I don't have much to say about workers

Yes, thank you that helps.

I can tell you how https://github.com/CodinGame: we've extended the LS

Is that code open or closed source? I was thinking if we should have something here. We had a discussion about server tools in the past in some issue, but I don't remember where exactly.

[CGNonofr]

The client code is at https://github.com/CodinGame/monaco-languageclient-wrapper/blob/main/src/customRequests.ts / https://github.com/CodinGame/monaco-languageclient-wrapper/blob/b7711e9c3be026d4c1b495f91af384cc73627a35/src/extensions.ts#L144 / https://github.com/CodinGame/monaco-languageclient-wrapper/blob/b7711e9c3be026d4c1b495f91af384cc73627a35/src/infrastructure.ts#L121-L141

The server code is not published anywhere public

[kaisalmen]

@CGNonofr thank you. I think we should integrate this functionality here (addition to monaco-languageclient itself), at least client and maybe also something reusable for the server. We could demonstrate the application with pyright.

[CGNonofr]

I agree, that's a very common pain point