adding lua annotations. Close nvim-java#7

ellisonleao · ellisonleao · commit aed46b150b8d · 2023-07-28T15:58:47.000-03:00
diff --git a/lua/plugin_name.lua b/lua/plugin_name.lua
@@ -1,20 +1,25 @@
 -- main module file
 local module = require("plugin_name.module")
 
-local M = {}
-M.config = {
-  -- default config
-  opt = "Hello!",
+---@class Config
+---@field opt string Your config option
+local config = {
+  opt = "Hello!"
 }
 
--- setup is the public method to setup your plugin
+---@class MyModule
+local M = {}
+
+---@type Config
+M.config = config
+
+---@param args Config?
+-- you can define your setup function here. Usually configurations can be merged, accepting outside params and
+-- you can also put some validation here for those.
 M.setup = function(args)
-  -- you can define your setup function here. Usually configurations can be merged, accepting outside params and
-  -- you can also put some validation here for those.
   M.config = vim.tbl_deep_extend("force", M.config, args or {})
 end
 
--- "hello" is a public method for the plugin
 M.hello = function()
   module.my_first_function()
 end
diff --git a/lua/plugin_name/module.lua b/lua/plugin_name/module.lua
@@ -1,6 +1,7 @@
--- module represents a lua module for the plugin
+---@class CustomModule
 local M = {}
 
+---@return string
 M.my_first_function = function()
   return "hello world!"
 end
