Automatically filling in a table which is defined as a @class

[fgimian]

Hey there folks, really hope you're all doing well.

Suppose I have the following Lua code:

---@class (exact) Arguments
---@field source string: The source file path to copy.
---@field destination string: The destination file path to copy to.
---@field owner string?: The owner of the file.

---Copies a file.
---@param args Arguments
function copy(args) end

When calling copy(), I notice that you may hit Ctrl+Space in VS Code to complete the possible fields of the table class parameter:

e.g.

However, is there a way to:

1. Display those in the order they are defined (e.g. source, then destination, then owner)?
2. Automatically fill in all possible fields using a quick fix?

Here's an example of how this looks in Go:

And after running this quick fix, we have:

Importantly, the order of arguments are filled in exactly as defined.

Thank you so much in advance!
Fotis

[tomlau10]

I believe luals has no such features (both 1 & 2) currently.

And specifically displaying fields in the order they are defined may not fit how luals actually works 🤔 . In luals, a @class annotation can be defined multiple times in multiple files, that's for defining corresponding fields in different sub files of a large class. For example:

• test/a.lua

---@class Test
---@field a string

• test/b.lua

---@class Test
---@field b integer

• then luals will merge these field into the same Test class =>

Test = {
  a: string
  b: integer
}

Since a @class is allowed to be defined multiple times, and more importantly in different files, I believe there is no defined order concept for it 😕

[fgimian]

I believe luals has no such features (both 1 & 2) currently.

And specifically displaying fields in the order they are defined may not fit how luals actually works 🤔 . In luals, a @class annotation can be defined multiple times in multiple files, that's for defining corresponding fields in different sub files of a large class. For example:

* test/a.lua

---@class Test
---@field a string

* test/b.lua

---@class Test
---@field b integer

* then luals will **merge** these field into the same `Test` class =>

Test = {
  a: string
  b: integer
}

Since a @class is allowed to be defined multiple times, and more importantly in different files, I believe there is no defined order concept for it 😕

Ah I see, thank you so much for the detailed response, really appreciate it! 😄