LuaLS / LuaLS/lua-language-server

Cannot for the life of me configure formatting

Open
#2,046 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feat/formatter
Dominant language
Lua
Stars
4.4k
Forks
442
PR merge metrics
No merged PRs in 30d

Description

### How are you using the lua-language-server?

Visual Studio Code Extension (sumneko.lua)

### Which OS are you using?

MacOS

### What is the issue affecting?

Formatting

### Expected Behaviour

Formatting adds 6 spaces for indentation.

### Actual Behaviour

Formatting adds the default 2.

### Reproduction steps

I have it set as the default formatter in my `settings.json`:

```
"[lua]": {
"editor.quickSuggestions": {
"other": true,
"comments": true,
"strings": true
},
"editor.tabCompletion": "on",
"editor.quickSuggestionsDelay": 1,
"editor.suggest.snippetsPreventQuickSuggestions": false,
"editor.defaultFormatter": "sumneko.lua",
},
```

I put in `.luarc.json` in my workspace:

```
{
"Lua.format.defaultConfig": {
"indent_style": "space",
"indent_size": "6"
}
}
```

But no luck,

I put in `.vscode/settings.json` in my workspace:

```
{
"Lua.format.defaultConfig": {
"indent_style": "space",
"indent_size": "6"
}
}
```

I try various ways of adding this to the core `settings.json` used by VSCode, either adding it under the `[lua]` entry, or as a top level entry, but no luck.

What am I missing?!

thanks!

### Additional Notes

_No response_

### Log File

_No response_

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the formatting behavior in Visual Studio Code using the shown settings.json, .luarc.json, and .vscode/settings.json configurations. Trace how the language server reads the formatting configuration and determine why indent_size 6 is ignored; done means the documented workspace configuration produces six-space indentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
lua, vscode
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.