VSC: disable automatic annotation prefix on new lines, indentation jank?

[PinewoodPip]

Honestly I'm not sure if this is was caused by a VS Code update or an LLS one, but since a few days ago, starting a new line after writing an annotation causes the ---@ prefix to be automatically added, which is incredibly frustrating as it screws with my muscle memory.

Ex. if I start an annotation like so:

---@class SomeClass

and I press enter, I get ---@ added immediately:

---@class SomeClass
---@

Pressing enter again just makes another line with ---@, so it's incredibly frustrating to start a normal code line now as I have to manually delete the ---@ every time.

Does anyone know how to turn this off?

New lines within tables are also acting very strange, just screwing up the indentation. This is me pressing enter twice inbetween two table fields:

2024-08-06.11-33-10.mp4

[PinewoodPip]

Seems like setting "Editor: Auto Indent" to one of the settings that doesn't have "invoke onEnterRules" removes the ---@ auto-prefix, however the indentation issue only disappears if I fully disable it, which is highly undesirable.

[tomlau10]

I also noticed this behavior, and I think this is added recently in LuaLS v3.10.0. From the change log
https://github.com/LuaLS/lua-language-server/blob/master/changelog.md#3100

• NEW Improved behavior for inserting new lines:
  • When inside an annotation, an annotation tag will be added at the beginning of the line (VSCode).

---

I also found this a bit annoying, or not as smart enough.
For example, if it can support that when the line is just ---@ and after I press enter once, then it will cancel out this auto-added ---@ (reverting the current line back to empty) , maybe it will be better.
Because for sometimes I just want to write:

---@class Test
local Test = {}

without adding other annotation line in between.

I've yet found an option to disable it ☹️

[PinewoodPip]

Pressing twice to dismiss it would be ideal, I agree.
I noted in a previous reply that the "Editor: Auto Indent" setting can be used to disable this (#2786 (comment))

[tomlau10]

I noted in a previous reply that the "Editor: Auto Indent" setting can be used to disable this

Yeah I see that, but changing it to say brackets will as well skip the invocation of indentationRules, and it stops the auto indent for keywords ☹️

• if true then<enter> => no indent

Currently Lua's auto indentation relies on the vscode built-in indentationRules to work:
https://github.com/microsoft/vscode/blob/main/extensions/lua/language-configuration.json#L25-L28

But this rule is not perfect as it doesn't handle keywords in string, which makes false positive auto indent like this #2766
Also it causes false negative when keywords exists after --[[block comment in middle]], eg if true --[[comment]] then => no indent
I've attempted to write an improved one here: #2786 (reply in thread), but found more problems on vscode's side 🤦‍♂️

---

I guess LuaLS side's fix-indent is tried to solve these false positive issues? I observed that it automatically removes the extra indentation. If that's the case, I guess we can have a less strict indentationRules (which have even more false positive, but NO false negative), and let LuaLS auto-fix the false positive cases 👀
edit: opps~ seems it's not the case...

[CppCXY]

because:
https://github.com/LuaLS/vscode-lua/blob/cdafefeba9699c6585d80960c54577ba57858aa2/client/src/languageConfiguration.ts#L16C4-L67C3

[CppCXY]

Last week we discussed a bug related to indentation. sumneko incidentally made some changes regarding this, but the feedback indicates that the experience is not very good.

[tomlau10]

New lines within tables are also acting very strange, just screwing up the indentation
...
however the indentation issue only disappears if I fully disable it, which is highly undesirable.

I didn't notice this until I followed the reproduction video 🙈 definitely a 🐛
I guess this is related to the newly added logic in this file: https://github.com/LuaLS/lua-language-server/blob/master/script/core/fix-indent.lua. I see that it uses proto.request('workspace/applyEdit' which causes a noticeable delay (?) when changing the editor state, and somehow it causes incorrect indent behavior as well ☹️ .

---

Last week we discussed a bug related to indentation

May I know what indentation bugs your team is trying to solve? @CppCXY
I know one here #2766 which related to keywords inside string, and I come up with a better regex here: microsoft/vscode#199223 (comment)
(detailed explanation of this regex inside the comment)

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

I tested this regex in my local vscode and it works well. But then I found another big problem related to vscode, vscode will remove the brackets in string / comment in the line before passing it to the regex module, so I cannot handle [[string]] nor --[[comment]] ... 🤦‍♂️ (the [[ / ]] are already stripped off in the text that tested against with regex pattern)

I opened another issue here: microsoft/vscode#223606 with a proposed simple fix. With that simple fix in vscode side, no regex change is needed ‼️ However no one pay attention to me... 😭

[PinewoodPip]

I haven't tried it, but the indentation issue appears to have been worked on in 16a7c65 .

[tomlau10]

I just tested LLS with latest master and yeah seems it got fixed 🎉

[swajj]

Can confirm that turning "Editor: Auto Indent" to 'brackets' or lower disables this unwanted behavior, but then I lose auto-indent after e.g. if.

I was also able to fix it by reverting all the way to 3.9.3.

To be honest, the new auto-insertion of ---@ is so counterproductive that I've been sticking with 3.9.3 ever since the change was introduced.

[tomlau10]

the new auto-insertion of ---@

Yes, this is added since recent version as pointed out by @CppCXY above: #2786 (comment)
And now those codes are moved to server side:

lua-language-server/script/provider/language-configuration.lua

Lines 54 to 81 in 6614170

	{
	beforeText = [[^\s*---@]],
	action = {
	indentAction = IndentAction.None,
	appendText = "---@"
	}
	},
	{
	beforeText = [[^\s*--- @]],
	action = {
	indentAction = IndentAction.None,
	appendText = "--- @"
	}
	},
	{
	beforeText = [[^\s*--- ]],
	action = {
	indentAction = IndentAction.None,
	appendText = "--- "
	}
	},
	{
	beforeText = [[^\s*---]],
	action = {
	indentAction = IndentAction.None,
	appendText = "---"
	}
	},

I don't know if extension author will be willing to revert it or not (or at least add an option to toggle off this insertion behavior ☹️ ) And I think may be this should be first converted into an issue in order to get more attentions.

---

I was also able to fix it by reverting all the way to 3.9.3.

Meanwhile maybe you can patch the code in your local luals copy just like I did 🙈
I just commented out those onEnterRules in script/provider/language-configuration.lua

[swajj]

#2861