[Question] Plan on supporting textDocument/rangeFormatting?

[jcs090218]

I noticed this feature isn't supported. Is there a reason why this feature isn't implemented? 🤔

[Techatrix]

I don't think there is much reason to implement this feature since your entire document should just be formatted based on zig fmt. What is the use case?

[jcs090218]

I used zls in Emacs through lsp-mode, but I couldn't get the formatting work by formatting the entire buffer. It makes sense since formatting the whole buffer still uses the textDocument/rangeFormatting and not textDocument/formatting. I opened up this issue and was hoping the UX could be improved (on the Emacs side). But feel free to close this if this is not planned, and sorry for the noise.

[Techatrix]

It makes sense since formatting the whole buffer still uses the textDocument/rangeFormatting and not textDocument/formatting.

Could you show me how you performed formatting and checked that it used textDocument/rangeFormatting?

I was able to use lsp-mode to format a file. The default keybindings were documented here. The s-l = r keybinding which formatted only a range did not work as expected but s-l = = did.

The zig-mode plugin also has :zig-format-buffer which uses zig fmt direclty without needing ZLS. Keep in mind that zig-mode needs to find your Zig executable to perform formatting while lsp-mode with ZLS does not.

[jcs090218]

A variable lsp-enable-indentation will allow formatting while doing the regular indent in Emacs.

See the source from lsp-mode.el:

      (when (and lsp-enable-indentation
                 (lsp-feature? "textDocument/rangeFormatting"))
        (add-function :override (local 'indent-region-function) #'lsp-format-region))

I know there is a command lsp-format-buffer; however, it won't work with the regular indent since it only uses the textDocument/rangeFormatting (see the code above).

It's not a big issue since we can always use lsp-format-buffer, but it's annoying because the regular indent functions are meaningless in Zig's buffer.