/comment-helper-lua.nvim

Primary LanguageLuaMIT LicenseMIT

Add (at the moment, very basic) support for documenting Lua using comment-helper.

Preview

Features

  • Supports snippets if you have LuaSnip enabled.
  • Supports the following Lua node types:
    • function_declaration
    • variable_declaration (when right hand side is a function, i.e. local func = function(...) ... end)
    • assignment_statement (when right hand side is a function, i.e. M.func = function(...) ... end)

Installation

Plug 'ismaelpadilla/comment-helper.nvim' " base plugin
Plug 'ismaelpadilla/comment-helper-lua.nvim'

Configuration

local ch = require("comment_helper")
local ch_lua = require("comment_helper_lua")

ch.set_ignored_types("lua", {"chunk"})
ch.add("lua", "function_declaration", ch_lua.function_declaration)
ch.add("lua", "variable_declaration", ch_lua.variable_declaration)
ch.add("lua", "assignment_statement", ch_lua.assignment_statement)