How do I create my own plugin?

[sebwr]

I have read the following page and saved the files under ~\.vscode\extensions\sumneko.lua-3.5.5-win32-x64\server\meta\3rd\example. Then I created my own files and saved them under ~\.vscode\extensions\sumneko.lua-3.5.5-win32-x64\server\meta\3rd\sebwr.

The folder structure is as in the example:

├───example
│   │   config.lua
│   │   plugin.lua
│   │
│   └───library
│           love.lua
│
└───sebwr
    │   config.lua
    │
    └───library
            sebwr.lua

1. config.lua

-- if not set, the folder name will be used
name    = 'TEST Modding'
-- list of matched words
words   = {'item'}

2. sebwr.lua

--- Item class which contains all the parameters of an item
--- @class item
--- @field public id string
--- @field public name string 
--- @field public desc string 
--- @field public probability float 
local item = class()

--- @param name string The name of the protocol.
--- @param desc string The description of the item.
function item.setTest(name, desc) end

The next time I started Visual Studio, it asked me if I wanted to load TEST Modding config and the following Seetings file was created:

{
    "Lua.workspace.library": [
        "${3rd}/sebwr/library"
    ],
    "Lua.workspace.checkThirdParty": false
}

If I now try to trigger the plugin in a new LUA file, it finds neither the fields nor the method.

I recorded the following gif:

I probably missed something in your documentation or misunderstood something.

I would be very happy if someone could explain to me what I did wrong or how I "install" a plugin correctly.

[serg3295]

---@meta

--- Item class which contains all the parameters of an item
--- @class item
--- @field public id string
--- @field public name string
--- @field public desc string
--- @field public probability float   -- <- number
 item = class()  -- <-- or  item = {}

--- @param name string The name of the protocol.
--- @param desc string The description of the item.
function item.setTest(name, desc) end

return item

[sebwr]

Thank you very munch. After I fixed the LUA errors the code completion works.

Is there any documentation on why you need the @meta tag and the return statement or can someone explain it to me.

I would like to expand the wiki page on plugins so that newbies like me can more easily create their own plugin. What would be the best way to achieve this? Clone the wiki and submit a pull request?

[serg3295]

@meta link to wiki
return statement Adding a return to the end of library file allows local item = require "item" to work properly
@carsakiller is maintainer of wiki

[serg3295]

Using return is not necessary. If 'item' is global item = {} you get autocomplete without return.
If local item = {} you should use return in library file and require the file explicitly

local item = require("sebwr")
item.

[carsakiller]

I have personally never attempted to make a plugin, so the content that is on the page currently was - I believe - written by another user. As I have never made one, I don't have the experience/knowledge to make that page as informational as possible.

I have thought of making an example "environment configuration" project that includes definitions, a config.lua, and a plugin. Would that make it easier to understand?

If you would like to add to the wiki, you can open an issue and contribute that way!

[sebwr]

@serg3295 Thank you, for the detailed explanations.

@carsakiller Ok, yes I would like to write such a Starter Guide. When I am done I open an Issue.