Example of real file system connection

[vivekburman]

Hi, I'm tying to wrap my head around how to connect with a real golang project with monaco editor at front. Right now I'm stuck in opening and syncing changes to real file and getting feedback on changes.

I would love, if someone can point me to any article or code snippet to get started. I saw few snippets where "registerFileSystemOverlay" is used to create a virtual file and then call "vscode.workspace.openTextDocument". But it does not provide any "textDocument/publishDiagonstics" report when I edit in monaco.

[kaisalmen]

Hi @vivekburman this is the best example to take a look at, I think. It has a python client that opens TextDocuments that are picked up by pyright language server:
https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/src/python/client/main.ts

You can test this locally only because you have to launch the backend locally.

[vivekburman]

let me try this out. Also any article which explains the "registerFileSystemOverlay" and what it does?

[CGNonofr]

Not really 🤔 but I think it's pretty straighforward, similar to the behavior of overlayfs: you can register multiple layers of filesystem in a defined order:

• write requests go to the first accepting layer
• read requests return the file from the first layer having that file

It can be useful if you want to "merge" a local filesytem with a remote readonly one, but you can also chose to replace the overlay filesystem by one of the builtin implementation

[vivekburman]

Hi, I tried the steps. But couldn't get back feedback from gopls when file is updated.

{"jsonrpc":"2.0","id":0,"method":"initialize","params":{"processId":null,"clientInfo":{"name":"Code - OSS","version":"1.95.3"},"locale":"en","rootPath":"c:\\Users\\vivek\\AppData\\Roaming\\streamcraft\\lsp\\accelq_project","rootUri":"file:///c%3A/Users/vivek/AppData/Roaming/streamcraft/lsp/accelq_project","capabilities":{"workspace":{"applyEdit":true,"workspaceEdit":{"documentChanges":true,"resourceOperations":["create","rename","delete"],"failureHandling":"textOnlyTransactional","normalizesLineEndings":true,"changeAnnotationSupport":{"groupsOnLabel":true}},"configuration":true,"didChangeWatchedFiles":{"dynamicRegistration":true,"relativePatternSupport":true},"symbol":{"dynamicRegistration":true,"symbolKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]},"tagSupport":{"valueSet":[1]},"resolveSupport":{"properties":["location.range"]}},"codeLens":{"refreshSupport":true},"executeCommand":{"dynamicRegistration":true},"didChangeConfiguration":{"dynamicRegistration":true},"foldingRange":{"refreshSupport":true},"semanticTokens":{"refreshSupport":true},"fileOperations":{"dynamicRegistration":true,"didCreate":true,"didRename":true,"didDelete":true,"willCreate":true,"willRename":true,"willDelete":true},"inlineValue":{"refreshSupport":true},"inlayHint":{"refreshSupport":true},"diagnostics":{"refreshSupport":true}},"textDocument":{"publishDiagnostics":{"relatedInformation":true,"versionSupport":false,"tagSupport":{"valueSet":[1,2]},"codeDescriptionSupport":true,"dataSupport":true},"synchronization":{"dynamicRegistration":true,"willSave":true,"willSaveWaitUntil":true,"didSave":true},"completion":{"dynamicRegistration":true,"contextSupport":true,"completionItem":{"snippetSupport":true,"commitCharactersSupport":true,"documentationFormat":["markdown","plaintext"],"deprecatedSupport":true,"preselectSupport":true,"tagSupport":{"valueSet":[1]},"insertReplaceSupport":true,"resolveSupport":{"properties":["documentation","detail","additionalTextEdits"]},"insertTextModeSupport":{"valueSet":[1,2]},"labelDetailsSupport":true},"insertTextMode":2,"completionItemKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25]},"completionList":{"itemDefaults":["commitCharacters","editRange","insertTextFormat","insertTextMode","data"]}},"hover":{"dynamicRegistration":true,"contentFormat":["markdown","plaintext"]},"signatureHelp":{"dynamicRegistration":true,"signatureInformation":{"documentationFormat":["markdown","plaintext"],"parameterInformation":{"labelOffsetSupport":true},"activeParameterSupport":true},"contextSupport":true},"definition":{"dynamicRegistration":true,"linkSupport":true},"references":{"dynamicRegistration":true},"documentHighlight":{"dynamicRegistration":true},"documentSymbol":{"dynamicRegistration":true,"symbolKind":{"valueSet":[1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]},"hierarchicalDocumentSymbolSupport":true,"tagSupport":{"valueSet":[1]},"labelSupport":true},"codeAction":{"dynamicRegistration":true,"isPreferredSupport":true,"disabledSupport":true,"dataSupport":true,"resolveSupport":{"properties":["edit"]},"codeActionLiteralSupport":{"codeActionKind":{"valueSet":["","quickfix","refactor","refactor.extract","refactor.inline","refactor.rewrite","source","source.organizeImports"]}},"honorsChangeAnnotations":true},"codeLens":{"dynamicRegistration":true},"formatting":{"dynamicRegistration":true},"rangeFormatting":{"dynamicRegistration":true,"rangesSupport":true},"onTypeFormatting":{"dynamicRegistration":true},"rename":{"dynamicRegistration":true,"prepareSupport":true,"prepareSupportDefaultBehavior":1,"honorsChangeAnnotations":true},"documentLink":{"dynamicRegistration":true,"tooltipSupport":true},"typeDefinition":{"dynamicRegistration":true,"linkSupport":true},"implementation":{"dynamicRegistration":true,"linkSupport":true},"colorProvider":{"dynamicRegistration":true},"foldingRange":{"dynamicRegistration":true,"rangeLimit":5000,"lineFoldingOnly":true,"foldingRangeKind":{"valueSet":["comment","imports","region"]},"foldingRange":{"collapsedText":false}},"declaration":{"dynamicRegistration":true,"linkSupport":true},"selectionRange":{"dynamicRegistration":true},"callHierarchy":{"dynamicRegistration":true},"semanticTokens":{"dynamicRegistration":true,"tokenTypes":["namespace","type","class","enum","interface","struct","typeParameter","parameter","variable","property","enumMember","event","function","method","macro","keyword","modifier","comment","string","number","regexp","operator","decorator"],"tokenModifiers":["declaration","definition","readonly","static","deprecated","abstract","async","modification","documentation","defaultLibrary"],"formats":["relative"],"requests":{"range":true,"full":{"delta":true}},"multilineTokenSupport":false,"overlappingTokenSupport":false,"serverCancelSupport":true,"augmentsSyntaxTokens":true},"linkedEditingRange":{"dynamicRegistration":true},"typeHierarchy":{"dynamicRegistration":true},"inlineValue":{"dynamicRegistration":true},"inlayHint":{"dynamicRegistration":true,"resolveSupport":{"properties":["tooltip","textEdits","label.tooltip","label.location","label.command"]}},"diagnostic":{"dynamicRegistration":true,"relatedDocumentSupport":false}},"window":{"showMessage":{"messageActionItem":{"additionalPropertiesSupport":true}},"showDocument":{"support":true},"workDoneProgress":true},"general":{"staleRequestSupport":{"cancel":true,"retryOnContentModified":["textDocument/semanticTokens/full","textDocument/semanticTokens/range","textDocument/semanticTokens/full/delta"]},"regularExpressions":{"engine":"ECMAScript","version":"ES2020"},"markdown":{"parser":"marked","version":"1.1.0"},"positionEncodings":["utf-16"]},"notebookDocument":{"synchronization":{"dynamicRegistration":true,"executionSummarySupport":true}}},"trace":"off","workspaceFolders":[{"uri":"file:///c%3A/Users/vivek/AppData/Roaming/streamcraft/lsp/accelq_project","name":"w-2"}]}}

And below is the JSONRPC message sent from monaco editor. But no feedback "publishDiagnostics" from gopls

{
  "jsonrpc": "2.0",
  "method": "textDocument/didChange",
  "params": {
    "textDocument": {
      "uri": "file:///transformers/test_transformer.go",
      "version": 4
    },
    "contentChanges": [
      {
        "range": {
          "start": {
            "line": 5,
            "character": 38
          },
          "end": {
            "line": 5,
            "character": 38
          }
        },
        "rangeLength": 0,
        "text": "s"
      }
    ]
  }
}

So fundamentally what I'm trying to understand here is do I need to write these changes to the real file as well or gopls will take care of it. Because right now when I open the real file, it stays same. Is that the reason no feedback comes back?

Right now the current arch is React Monaco <-> Golang Server <-> Gopls.

Also as you can see from below gopls logs. Looks like the text change requests are at halt. Started queued but not completed.

[Main](http://localhost:60910/) [Info](http://localhost:60910/info) [Memory](http://localhost:60910/memory) [Profiling](http://localhost:60910/debug/pprof) [Metrics](http://localhost:60910/metrics) [RPC](http://localhost:60910/rpc) [Trace](http://localhost:60910/trace) [Analysis](http://localhost:60910/analysis)
Trace Information
[$/cancelRequest](http://localhost:60910/trace/$/cancelRequest) last: 0s, longest: 1.0264ms
[initialize](http://localhost:60910/trace/initialize) last: 1.3409ms, longest: 1.3409ms
[lsp.Server.initialize](http://localhost:60910/trace/lsp.Server.initialize) last: 804.9µs, longest: 804.9µs
[queued](http://localhost:60910/trace/queued) last: 0s, longest: 0s
Recent spans (oldest first)
A finite number of recent span start/end times are shown below. The nesting represents the children of a parent span (and the log events within a span). A span may appear twice: chronologically at toplevel, and nested within its parent.

20:44:30.758 start initialize method="initialize" direction="in" id="#0"
20:44:30.758 start queued
20:44:30.758 end queued (+0s)
20:44:30.759 start lsp.Server.initialize
20:44:30.760 end lsp.Server.initialize (+804.9µs)
20:44:30.760 end initialize (+1.3409ms) method="initialize" direction="in" id="#0"
20:44:30.760 event (+1.3409ms) label= status.code="OK"
20:44:30.758 start queued
20:44:30.758 end queued (+0s)
20:44:30.759 start lsp.Server.initialize
20:44:30.760 end lsp.Server.initialize (+804.9µs)
20:44:45.778 start initialized method="initialized" direction="in"
20:44:45.778 start queued
20:44:45.778 end queued (+0s)
20:44:45.778 start lsp.Server.initialized
20:44:45.778 start window/workDoneProgress/create method="window/workDoneProgress/create" direction="out" id="#1"
20:45:00.812 start textDocument/didOpen method="textDocument/didOpen" direction="in"
20:45:00.812 start queued
20:45:15.831 start textDocument/codeAction method="textDocument/codeAction" direction="in" id="#1"
20:45:15.831 start queued
20:45:30.866 start textDocument/documentLink method="textDocument/documentLink" direction="in" id="#2"
20:45:30.866 start queued
20:45:45.899 start textDocument/inlayHint method="textDocument/inlayHint" direction="in" id="#3"
20:45:45.899 start queued
20:46:00.917 start textDocument/documentSymbol method="textDocument/documentSymbol" direction="in" id="#4"
20:46:00.917 start queued
20:46:15.967 start textDocument/semanticTokens/full method="textDocument/semanticTokens/full" direction="in" id="#6"
20:46:15.967 start queued
20:46:30.985 start textDocument/foldingRange method="textDocument/foldingRange" direction="in" id="#5"
20:46:30.985 start queued
20:46:46.019 start textDocument/semanticTokens/range method="textDocument/semanticTokens/range" direction="in" id="#7"
20:46:46.019 start queued
20:47:01.037 start textDocument/codeLens method="textDocument/codeLens" direction="in" id="#8"
20:47:01.037 start queued
20:47:16.057 start textDocument/hover method="textDocument/hover" direction="in" id="#9"
20:47:16.058 start queued
20:47:31.078 start $/cancelRequest method="$/cancelRequest" direction="in"
20:47:31.078 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:47:31.078 event (+0s) label= status.code="OK"
20:47:46.092 start textDocument/documentHighlight method="textDocument/documentHighlight" direction="in" id="#10"
20:47:46.092 start queued
20:48:01.125 start $/cancelRequest method="$/cancelRequest" direction="in"
20:48:01.125 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:48:01.125 event (+0s) label= status.code="OK"
20:48:16.145 start textDocument/codeAction method="textDocument/codeAction" direction="in" id="#11"
20:48:16.145 start queued
20:48:31.178 start textDocument/codeLens method="textDocument/codeLens" direction="in" id="#12"
20:48:31.178 start queued
20:48:46.210 start $/cancelRequest method="$/cancelRequest" direction="in"
20:48:46.210 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:48:46.210 event (+0s) label= status.code="OK"
20:49:01.244 start $/cancelRequest method="$/cancelRequest" direction="in"
20:49:01.244 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:49:01.244 event (+0s) label= status.code="OK"
20:49:16.262 start $/cancelRequest method="$/cancelRequest" direction="in"
20:49:16.262 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:49:16.262 event (+0s) label= status.code="OK"
20:49:31.314 start $/cancelRequest method="$/cancelRequest" direction="in"
20:49:31.314 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:49:31.314 event (+0s) label= status.code="OK"
20:49:46.348 start $/cancelRequest method="$/cancelRequest" direction="in"
20:49:46.348 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:49:46.348 event (+0s) label= status.code="OK"
20:50:01.382 start $/cancelRequest method="$/cancelRequest" direction="in"
20:50:01.383 end $/cancelRequest (+1.0264ms) method="$/cancelRequest" direction="in"
20:50:01.383 event (+1.0264ms) label= status.code="OK"
20:50:16.417 start textDocument/didChange method="textDocument/didChange" direction="in"
20:50:16.418 start queued
20:50:31.454 start $/cancelRequest method="$/cancelRequest" direction="in"
20:50:31.454 end $/cancelRequest (+505.1µs) method="$/cancelRequest" direction="in"
20:50:31.454 event (+505.1µs) label= status.code="OK"
20:50:46.485 start textDocument/codeAction method="textDocument/codeAction" direction="in" id="#13"
20:50:46.485 start queued
20:51:01.520 start textDocument/documentSymbol method="textDocument/documentSymbol" direction="in" id="#14"
20:51:01.520 start queued
20:51:16.538 start textDocument/foldingRange method="textDocument/foldingRange" direction="in" id="#15"
20:51:16.538 start queued
20:51:31.571 start textDocument/semanticTokens/range method="textDocument/semanticTokens/range" direction="in" id="#16"
20:51:31.571 start queued
20:51:46.588 start textDocument/inlayHint method="textDocument/inlayHint" direction="in" id="#17"
20:51:46.588 start queued
20:52:01.607 start textDocument/codeLens method="textDocument/codeLens" direction="in" id="#18"
20:52:01.607 start queued
20:52:16.650 start $/cancelRequest method="$/cancelRequest" direction="in"
20:52:16.650 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:52:16.650 event (+0s) label= status.code="OK"
20:52:31.694 start textDocument/inlayHint method="textDocument/inlayHint" direction="in" id="#19"
20:52:31.694 start queued
20:52:46.711 start $/cancelRequest method="$/cancelRequest" direction="in"
20:52:46.711 end $/cancelRequest (+0s) method="$/cancelRequest" direction="in"
20:52:46.711 event (+0s) label= status.code="OK"
20:53:01.764 start textDocument/documentLink method="textDocument/documentLink" direction="in" id="#20"
20:53:01.764 start queued