Formatter in 3.6.10 ignores Lua.format.defaultConfig settings

[lkrms]

How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

Which OS are you using?

Linux

What is the issue affecting?

Formatting

Expected Behaviour

From following the formatter docs link, it looks like there's been a major upstream release, which might explain this.

Here's my configuration:

{
    "Lua.format.defaultConfig": {
        "keep_line_after_do_statement": "maxLine:1",
        "keep_line_after_expression_statement": "maxLine:1",
        "keep_line_after_for_statement": "maxLine:1",
        "keep_line_after_function_define_statement": "keepLine:1",
        "keep_line_after_if_statement": "maxLine:1",
        "keep_line_after_local_or_assign_statement": "maxLine:1",
        "keep_line_after_repeat_statement": "maxLine:1",
        "keep_line_after_while_statement": "maxLine:1",
        "keep_one_space_between_table_and_bracket": "false"
    },
}

Actual Behaviour

I expect my formatting settings to be used whenever I format Lua code, but they aren't anymore. Subsequent blank lines aren't collapsed, and spaces are added inside table brackets.

Reproduction steps

• Configure Lua's format settings as per documentation.
• Format a Lua file in Visual Studio Code.
• Check formatting.

Additional Notes

No response

Log File

No response

[CppCXY]

I rename all the option, please reference to https://github.com/CppCXY/EmmyLuaCodeStyle/blob/master/lua.template.editorconfig

the documentation being rewritten

[Weiberle17]

I don't know if this is related but since 3.6.10 formatting in neovim seems to ignore the editor's indentation and defaultConfig settings.
Setting indent_style and indent_size doesn't seem to change anything either (which I think is default behavior). It looks like it uses the template settings of "space" and "4".

[CppCXY]

I don't know if this is related but since 3.6.10 formatting in neovim seems to ignore the editor's indentation and defaultConfig settings. Setting indent_style and indent_size doesn't seem to change anything either (which I think is default behavior). It looks like it uses the template settings of "space" and "4".

Is there any version information and related configurations?

[CppCXY]

The defaultConfig indentation is always overridden by the editor indentation, this is defined by the LSP specification

[Weiberle17]

I am using Neovim v0.8.3 with shiftwidth and tabstop set to 2 and autoindent true. This has not changed since it was working.
My LSP config for lua is:
lsp.configure('sumneko_lua', {
settings = {
Lua = {
runtime = {
-- Tell the language server which version of Lua you're using (most likely LuaJIT in the case of Neovim)
version = 'LuaJIT',
},
diagnostics = {
globals = { 'vim', 'beautiful', 'awesome', 'client' },
},
workspace = {
-- Make the server aware of Neovim runtime files
library = {
[vim.fn.expand "$VIMRUNTIME/lua"] = true,
[vim.fn.stdpath "config" .. "/lua"] = true,
},
},
format = {
enable = true,
defaultConfig = {
indent_style = "space",
indent_size = "2",
max_line_length = "unset",
}
},
-- Do not send telemetry data containing a randomized but unique identifier
telemetry = {
enable = false,
},
}
}
})
This worked well but now files which where previously formatted with it are formatted with two additional spaces for each indentation.

I hope this is what you asked for.

[CppCXY]

I am using Neovim v0.8.3 with shiftwidth and tabstop set to 2 and autoindent true. This has not changed since it was working. My LSP config for lua is: lsp.configure('sumneko_lua', { settings = { Lua = { runtime = { -- Tell the language server which version of Lua you're using (most likely LuaJIT in the case of Neovim) version = 'LuaJIT', }, diagnostics = { globals = { 'vim', 'beautiful', 'awesome', 'client' }, }, workspace = { -- Make the server aware of Neovim runtime files library = { [vim.fn.expand "$VIMRUNTIME/lua"] = true, [vim.fn.stdpath "config" .. "/lua"] = true, }, }, format = { enable = true, defaultConfig = { indent_style = "space", indent_size = "2", max_line_length = "unset", } }, -- Do not send telemetry data containing a randomized but unique identifier telemetry = { enable = false, }, } } })

I hope this is what you asked for.

can you try defining an .editorconfig to see if it works

[Weiberle17]

That works! And I figured out what the problem was. Apparently the option continuation_indent which was changed in commit: "1909d3ea355413ec3137138aa8078dfda004bbe5" from continuation_indent_size overwrites it now. If I add continuation_indent = "2", to my lsp setup it works similiar to before. I don't know if this is intended but thanks a lot for helping me so quickly.

[Weiberle17]

Ok so follow up: There seems to be a bug with this continuation_indent option. This always decides how far my text is indented. And for something like this: ("_" show indentation)
llocal clock = awful.widget.watch(
_"date +'%a %d %b %R'", 60,
_function(widget, stdout)
__widget:set_markup(" " .. markup.font(wibar.font, stdout))
_end
)
It will now indent everything after the first line one more time. So formatting results in:
local clock = awful.widget.watch(
__"date +'%a %d %b %R'", 60,
__function(widget, stdout)
___widget:set_markup(" " .. markup.font(wibar.font, stdout))
__end
_)
How do I fix/prevent this from happening?

[CppCXY]

Ok so follow up: There seems to be a bug with this continuation_indent option. This always decides how far my text is indented. And for something like this: ("_" show indentation) llocal clock = awful.widget.watch( _"date +'%a %d %b %R'", 60, _function(widget, stdout) __widget:set_markup(" " .. markup.font(wibar.font, stdout)) _end ) It will now indent everything after the first line one more time. So formatting results in: local clock = awful.widget.watch( __"date +'%a %d %b %R'", 60, __function(widget, stdout) ___widget:set_markup(" " .. markup.font(wibar.font, stdout)) __end _) How do I fix/prevent this from happening?

In the latest version I have fixed this issue

[bondzula]

I'm experiencing the same issue, tabstop and shiftwidth are both 2, however LSP keeps formatting to 4, and It's not even consistent, as I can see some places that are formatted correctly to 2. Setting continuation_indent to 2, does kind of fix it, but I still gets some weird formats like this:

vim.lsp.handlers["textDocument/hover"] = vim.lsp.with(vim.lsp.handlers.hover, {
    border = "rounded",
  })

this is my .editorconfig

root = true

[*.lua]
indent_style = space
indent_size = 2
tab_width = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
charset = utf-8
continuation_indent = 2

and this is my LSP config:

lspconfig.sumneko_lua.setup({
  on_attach = on_attach,
  capabilities = capabilities,
  settings = {
    Lua = {
      format = {
        enable = true,
        defaultConfig = {
          indent_style = "space",
          indent_size = "2",
          quote_style = "double",
        },
      },
    },
  },
})

[Weiberle17]

I just wanted to thank you for replying so quickly and also fixing it so quickly. It works very well now. Thanks a lot!

[lkrms]

I think everything mentioned here has been resolved now? If not, it should probably go in a new issue anyway. Thanks for your work on this, @CppCXY!