Refactor/conform

[oriori1703]

1. Change format_on_save to a blacklist
2. Use stylua's lsp for formatting instead of its CLI

fixes #1819

[nathanzeng]

If the theme of this PR is to reduce unexpected formatting on save, I think these lines should be removed.

[nathanzeng]

Ah but then the lua formatting will not work. Hmm not sure.

[nathanzeng]

Anyway, that comment is not correct. Fallback means using LSP when no other formatters are available, not prioritizing it.

See conform documentation here

[oriori1703]

those lines were added just so you don't have to repeat it in 2 places (previously it was in 693 and 674)

[nathanzeng]

What is the reason for switching to stylua's LSP instead of its CLI? I think it was more clear when stylua was defined in the formatters_by_ft block.

[SebastianBr11]

I tried using the Stylua LSP for formatting and removing it from formatters_by_ft in the conform settings, I also disabled formatting in the lua_ls settings, but then pressing <leader>f no longer formatted the file. I imagine, Conform tries lua_ls, but it doesn't do anything and stylua is ignored

[oriori1703]

I tried using the Stylua LSP for formatting and removing it from formatters_by_ft in the conform settings, I also disabled formatting in the lua_ls settings, but then pressing <leader>f no longer formatted the file. I imagine, Conform tries lua_ls, but it doesn't do anything and stylua is ignored

did you also disable the formatting server capability by adding the following line in on_init?
Without this I got the same issues:

           client.server_capabilities.documentFormattingProvider = false -- Disable formatting (formatting is done by stylua)

It seems it is caused by a race condition betweeen stylua and lua_ls. They both run on the same input, and stylua's result arrives earlier, so it was getting overriden by lua_ls.
If you only disable formatting in lua_ls' settings it seems to still "try" to format, but without any changes, so it still causes the issue. My solution was disabling it's ability to format entirely, by removing the capability.

Another solution that worked for me was setting async=false in conform.format, which avoids the race condition by running them synchronously, but also a bit slower.

[SebastianBr11]

Oh yeah, I didn't see that, my bad

[oriori1703]

Oh yeah, I didn't see that, my bad

Does it work now?