Return key does not trigger Language Server `onTypeFormatting` request (no `end` completion)

[andyw8]

Ruby LSP has a feature to automatically add ends, e.g. after def method_name. It uses the textDocument/onTypeFormatting language server request.

In Zed, this doesn't work. I suspect this is a bug in Zed rather than the extension, but I'm logging it here first until I learn more.

Example (comparing with VS Code)

In Ruby LSP with VS Code, enable verbose logging.

You'll also need to enable "editor.formatOnType": true since it's disabled by default.

Now type the following:

def foo

The logs will show a request:

Sending request 'textDocument/onTypeFormatting - (41)'.
{
    "textDocument": { "uri": "file:///Users/andy/src/github.com/Shopify/ruby-lsp/x.rb" },
    "position": { "line": 3, "character": 1 },
    "ch": "d",
    "options": { "tabSize": 2, "insertSpaces": true }
}

and an empty response

Received response 'textDocument/onTypeFormatting - (41)' in 1ms.

Now press return and you'll see a second request:

Sending request 'textDocument/onTypeFormatting - (48)'.
{
    "textDocument": { "uri": "file:///Users/andy/src/github.com/Shopify/ruby-lsp/x.rb" },
    "position": { "line": 4, "character": 2 },
    "ch": "\n",
    "options": {
        "tabSize": 2,
        "insertSpaces": true
    }
}

and a response, which causes an end to be added:

[
    {
        "range": {
            "start": { "line": 4, "character": 2 },
            "end": { "line": 4, "character": 2 }
        },
        "newText": "\n"
    },
    {
        "range": {
            "start": { "line": 4, "character": 2 },
            "end": { "line": 4, "character": 2 }
        },
        "newText": "end"
    },
    {
        "range": {
            "start": {  "line": 4, "character": 2 },
            "end": { "line": 4, "character": 2 }
        },
        "newText": "$0"
    }
]

In Zed, we see the first request:

// Send:
{"jsonrpc":"2.0","id":39,"method":"textDocument/onTypeFormatting",
"params":{"textDocument":{"uri":"file:///Users/andy/src/github.com/Shopify/ruby-lsp/x.rb"},"position":{"line":0,"character":1},
"ch":"d",
"options":{"tabSize":2,"insertSpaces":true,"trimTrailingWhitespace":true,"insertFinalNewline":true,"trimFinalNewlines":true}}}

// Receive:
{"id":39,"result":[],"jsonrpc":"2.0"}

but after pressing return, there is no second request.

#38 may be related.

[andyw8]

I looked to see how the Lua extension handles this, since it also has end, but it's a different approach. It's based on textDocument/publishDiagnostics. So after you type if true then, a suggested fix pops up to add the end, and hitting return selects that.

// Receive:
{
  "jsonrpc": "2.0",
  "method": "textDocument/publishDiagnostics",
  "params": {
    "diagnostics": [
      {
        "code": "miss-exp",
        "data": "syntax",
        "message": "<exp> expected.",
        "range": {
          "end": {
            "character": 2,
            "line": 0
          },
          "start": {
            "character": 2,
            "line": 0
          }
        },
        "severity": 1,
        "source": "Lua Syntax Check."
      },
      {
        "code": "miss-end",
        "data": "syntax",
        "message": "Miss corresponding `end` .",
        "range": {
          "end": {
            "character": 2,
            "line": 0
          },
          "start": {
            "character": 0,
            "line": 0
          }
        },
        "severity": 1,
        "source": "Lua Syntax Check."
      }
    ],
    "uri": "/Users/andy/src/github.com/Shopify/ruby-lsp/x.lua",
    "version": 238
  }
}

// Receive:
{
  "id": 926,
  "jsonrpc": "2.0",
  "result": {
    "insertText": "if $1 then\n\t$0\nend",
    "insertTextFormat": 2,
    "kind": 15,
    "label": "if .. then",
    "sortText": "0001"
  }
}

[andyw8]

This likely relates to more_trigger_character:

https://github.com/Shopify/ruby-lsp/blob/f3ff6a36afbc7134d640c8e6be54c7c8f63f0aaf/lib/ruby_lsp/requests/on_type_formatting.rb#L15

Mentioned here (moreTriggerCharacter) in the spec:

https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocument_onTypeFormatting