Run :TSLspOrganizeSync as formatter?

[agriffis]

Hi! I'm using prettier with null-ls, so if I want to organize then format I need to do something like:

:TSLspOrganizeSync
:lua vim.lsp.buf.formatting_seq_sync()

Is there a recommended way to register TSLspOrganizeSync as a formatter itself? I thought about calling from a null-ls generator but not sure that's the best approach.

Thanks!

[jose-elias-alvarez]

The safest way to do this is to set up a command that does both, something like this (untested but it should make sense):

_G.formatting = function()
    local bufnr = vim.api.nvim_get_current_buf()
    local tsserver_is_attached = false
    for _, client in ipairs(vim.lsp.buf_get_clients(bufnr)) do
        if client.name == "tsserver" then
            tsserver_is_attached = true
            break
        end
    end

    if tsserver_is_attached then
        require("nvim-lsp-ts-utils").organize_imports_sync(bufnr)
    end
    vim.lsp.buf.formatting_seq_sync()
end

If you really want to set this up as a null-ls formatter, it's possible, but it's pretty hacky and I can't guarantee that it'll work in all cases (it seems to work with a formatting_sync() autocommand, at least):

local organize_imports = {
    method = null_ls.methods.FORMATTING,
    name = "organize_imports",
    filetypes = { "typescript", "typescriptreact" },
    generator = {
        async = true,
        fn = function(params, done)
            require("nvim-lsp-ts-utils").organize_imports(params.bufnr, done)
        end,
    },
}

If you plan on trying out the custom source, make sure to update, since a1ba6c9 fixes an issue that would otherwise pop up.

[agriffis]

Thanks again! The first solution is what I'm using now. Really appreciate the guidance.

[agriffis]

@jose-elias-alvarez This is working well most of the time, but sometimes it seems like organize_imports_sync finishes after the subsequent call to prettier. When that happens, I have to rerun the formatter a few times until it races the right way.

I noticed that you override the default timeout to 500 ms here:

nvim-lsp-ts-utils/lua/nvim-lsp-ts-utils/organize-imports.lua

Line 28 in f769dc9

lsp.buf_request_sync(bufnr, METHOD, make_params(bufnr), 500)

Did you have a particular reason for that override? And any thoughts about how it could be more reliable? It seems like having two sync operations run out of order is something to avoid, even if it means recognizing the timeout and aborting the operation instead of carrying on.

[jose-elias-alvarez]

This was one of the first pieces of Lua code I wrote, actually, and I'm not sure what the logic was for the override, but it should be safe to remove it. If that fixes your issue, feel free to put in a PR.