Incorrect `fix-indent` behaviour when writing for loops at root scope

[tomlau10]

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

The next line should be indented with the following code

• example 1

for i = 1, 10 do<enter>

• example 2

do
    for i = 1, 10 do<enter>

Actual Behaviour

The next line indented correctly initially (according to the indentationRules.increaseIndentPattern), but then it get removed by luals's "auto-fix-indent"...

Reproduction steps

• create a new file
• write the code snippet provided above
• then press enter and observe the behaviour

Additional Notes

I disabled the fix-indent by modifying luals code locally, and this bug stopped. So it's related to the fix-indent function added recently.

I add a do return end here to disable it:

lua-language-server/script/core/fix-indent.lua

Lines 194 to 195 in 01c6b61

	return function (uri, changes)
	if not client.getOption('fixIndents') then

---

As discussed in here #2786, these new indentation behaviours are somewhat annoying and may not be applicable for all of us. Can this be made as optional please 🥲 ? Say an option which can be turned on/off.

Log File

No response

[tomlau10]

我剛 checkout 了最新 3.10.4，發現 example 1 的問題仍然存在 😕 @sumneko
(example 2 則是解決了 👏 )

• 具體是在文件的 line 1 就輸入 for i = 1, 10 do<enter>，這時縮排會被 auto-fix 掉。

1 for i = 1, 10 do<enter>
2 |<-- wrong

• 但若先隔1個空行，則正確

1
2 for i = 1, 10 do<enter>
3     |<-- ok

• 稍為 debug 了下是 fixWrongIndent() 觸發的
  然後加了些 debug print log print(myBlock.bstart, lastOffset)
  • 出問題的 case (forloop 寫在 line1) 顯示為 14 16
  • 沒問題的 case (forloop 寫在 line2) 顯示為 10014 18

我不知道是什麼 logic 出了問題? 是 lastOffset 計算錯誤? 🙄

---

是否需要開新 issue 來 track? (這 issue 好像沒法 reopen 了)

另外這個 fixWrongIndent 是為了解決什麼問題的呀 😅
我在 discussion 那邊問了 @CppCXY 也沒有得到回覆。。。#2786 (reply in thread)

[sumneko]

为了解决 local s = 'function'

[tomlau10]

为了解决 local s = 'function'

我之前研究過可以用 vscode 的 increaseIndentPattern regex 處理 (雖然該 regex 是有些複雜)
簡單來說，該 regex 是由行首起，逐個 character 做 match，如果遇到 ' 或 "，則 跳過整個 string (然後繼續 match 下去)

const stage6 = /^((?!\-\-)[^"']|"[^"\\]*(\\.[^"\\]*)*"|'[^'\\]*(\\.[^'\\]*)*')*(\b(else|function|then|do|repeat)\b((?<=function)[^)]+\)?)?|[\{\(])\s*(\-\-.*)?$/;

我在 vscode 開了1個 issue: microsoft/vscode#199223 (comment), 裡邊也有測試代碼

---

但過程中發現 另1個 vscode 的問題。。。
vscode 會將 line 中的 string / comment 內容 先移除掉 bracket (指 ( ) { } [ ])
由於 lua 的 block quote string / comment 是用 [[ ]] / --[[ ]]
這就導致此特殊情況不可能用 regex 來解決，因為 if s --[[comment]] then 實際上被 vscode 換成 if s --comment then
然後才會調用 increaseIndentPattern

我也開了另1個 issue 來 track 這個: microsoft/vscode#223606
並提議 vscode 是把 inline 的 string / comment 完全去掉 (變成單個 space)，然後才 pass 給 increaseIndentPattern
這樣上 if s --[[comment]] then 可以換成 if s then => 可以如常用 increaseIndentPattern 處理
但完全沒得到任何關注 🤦‍♂️

[sumneko]

试试：

local s = 'abc\z
function'

[tomlau10]

分行後的 string 確實不行。。。因為 vscode 那個 regex 只能 match 單行
但是我的 regex 還可以修改

在 match 出 else|then|do|repeat keyword 後，我只允許後邊是 \s*(--.*)?
換句話以下這個 case 我的 regex 是能 handle 的

local s = 'abc\z
else'

但是 function 較特殊，因為 function 後邊可以有 arg list
我用最簡單的 (?<=function)[^)]+\)? 來 match 了
這裡可以優化一下，只允許 [\w\s,] 而不是 [^)]
應該也能解決你的 function' 🤔

[tomlau10]

當然也有 case 肯定不能用 regex 處理，比如是 block comment 內

--[[
this is a function
    |<--這個用 vscode 的 regex 機制肯定解決不了
]]

我當時有查看過 vscode auto indent 的相關 issue
有人是提出過，如果當前是在 comment / string 內，就不觸發 increaseIndentPattern
但好像一直沒有 implement 出來。。。

[CppCXY]

这些方案都不如让语言服务自己决定

[CppCXY]

vscode 基于正则的grammar和相关规则只是足够简单, 但并不是足够好用, 目前语言服务上能初步控制缩进的方式就是typeformat, 但他并不能很好的控制光标位置, 以及由于语法不完整导致的错误计算, 所以还得看未来LSP有没有什么新规范

[tomlau10]

这些方案都不如让语言服务自己决定

問一下，目前 luals 好像只能將 false positive 的 indent 做移除嗎?
我試了一下

if true --[[comment]] then

• 這句應該需要 indent
• 但因為 vscode 內建的 lua increaseIndentPattern 目前寫法是會忽略 -- 以後的內容
  => vscode 那邊不會 indent
  => false negative
• 然後 luals 這邊好像也不會增加 indent 🤔

[CppCXY]

这些方案都不如让语言服务自己决定

問一下，目前 luals 好像只能將 false positive 的 indent 做移除嗎? 我試了一下

if true --[[comment]] then

• 這句應該需要 indent
• 但因為 vscode 內建的 lua increaseIndentPattern 目前寫法是會忽略 -- 以後的內容
  => vscode 那邊不會 indent
  => false negative
• 然後 luals 這邊好像也不會增加 indent 🤔

不知道, 我不懂, 你问sumneko吧

[sumneko]

目前只做移除，少了缩进补回来比较简单。

[tomlau10]

如果 luals 是打算 自行做 indent
或許在終極版本下 (先假設沒有 bug 啦)，直接覆寫 increaseIndentPattern 不做任何 indent
然後每次按 enter 後，都由 luals 自行補上 indent ?

這樣就不需要考慮 做移除 🤔

---

edit: 好像不行，這個想法有些危險。。。
我看 vscode 文檔 increaseIndentPattern 會用於 paste / move line
https://code.visualstudio.com/api/language-extensions/language-configuration-guide#indentation-rules

indentationRules defines how the editor should adjust the indentation of current line or next line when you type, paste, and move lines.

如果沒了 increaseIndentPattern 似會爆炸 💥🙈