Renaming "EmmyLua Annotations"

[carsakiller]

Since v3, the language server's annotations have no longer been cross-compatible with EmmyLua Annotations. When I redid the wiki, I refrained from given the annotation style any name and just refered to them as "annotations based off of EmmyLua annotations". I think it could be helpful to assign them a memorable name though so it can be standardized a bit better.

Sumneko Annotations or Sumneko Lua Annotations are obvious candidates but the name isn't as memorable as something like LuaDoc (which is already in use) or LDoc (also in use). @sumneko I am not sure how you feel about this or what kind of process you would like for finding a new name. Maybe people can suggest names in this thread?

EDIT:
Created a poll to help figure this out #1587

[serg3295]

The sumneko's "lua-language-server" is de facto standard for many text editors. The stable phrase lua-language-server is used as the package name for installing in Neovim and Emacs.

So maybe LLS annotations would be a good choice.

[serg3295]

If you do a search on the internet, then you will see that there is only one "lua-language-server". And this is "sumneko's LLS "
Yes, this is one of the language servers, but this is lua-language-server.
If another LLS ever appears, then the problem - how to name the annotations - will already have that guy.
LLS is a more common used abbreviation and it will be remembered faster, IMO.
BTW, everyone can consider the letter S as sumneko or as server 😄

[flrgh]

+1 for this. I personally see no value in giving the annotation syntax a unique name when its implementation is so tightly coupled to the server. When referring to annotations I write for this project to colleagues, I just call them "lua-language-server-compatible annotations," and this has never sown confusion.

IMO if the goal is to give things a unique name, the right place to start would be with the server itself. While not entirely opposed to a rename, I also don't feel there is a compelling reason to do so. Anecdotally, most search engines I've tried yield this repo as the top result for the query lua language server and one of the top 5 for lua lsp, so it seems plenty discoverable. According to langserver and Microsoft's data, a significant share of the popular language server implementations tend to have generic names (${lang}-language-server/${lang}-lsp/${lang}-ls), so lua-language-server seems to be in good company here.

[serg3295]

IMO if the goal is to give things a unique name, the right place to start would be with the server itself. While not entirely opposed to a rename, I also don't feel there is a compelling reason to do so.

The unique name of the product is very important, as it allows you to uniquely identify the product on the market, attract more users and therefore feedback. Which in turn leads to product development, not stagnation.
'emmylua' is associated with another extension, although it is only a subset of 'LLS annotations' 😸 at the moment.

Properly the extension description is also important. For instance, in 2020, I first chose extension 'Lua language support for Visual Studio Code written by keyring' from extension marketplace only because the description of this extension was suitable for my request. If you look at the installation counter, then many users are doing so now.

[carsakiller]

Alright, well, I think we'll go with LLS Annotations then 🙂

[serg3295]

I have tried using the lls word. I think it's too short. For anyone who has not read this discussion, this word means nothing. Maybe it's better to use LuaLS? The Lua word is present explicitly.

EmmyLua
stylua
something Lua
lualib
LuaLS 😸

Although I do not insist.

[sumneko]

I just want it to be as short as possible and not include my English name.

My friend once admonished me as a Chinese how to choose a good English name:

1. Don't make English names look like Japanese pronunciations.
2. To be less than 2 syllables.

Then I forgot his admonition and now I regret it.

[carsakiller]

I don't think it is that big of a deal. Sumneko is still way easier for any English speaker to say and refer to than 最萌小汐, heck, I wouldn't even be able to type it 😄! Are there more familiar names? Yes, but it does also mean Sumneko is unique!

[carsakiller]

Some random name ideas:

• LuaNote
  • LNote
• TripleDash
  • TriDash
• LuaMark
  • LMark
  • LMarkup
• LuaDef
  • LDef
• SumLua Annotations (lol)

[serg3295]

Another variant of the name:
LuaLS