m00qek/plugin-template.nvim

github github
neovim-lua-development plugin
star 22
stars
alert-circle 0
open issues
users 2
subscribers
git-branch 1
forks
CREATED

2021-04-24

UPDATED

6 months ago

packer

require('packer').startup(function()
  use 'm00qek/plugin-template.nvim'
end)

paq

require "paq" { 
  'm00qek/plugin-template.nvim'
}

plugin-template.nvim

Integration

A template to create Neovim plugins written in Lua

Using

Clone/download it locally and change the references to my_plugin, my_module accordingly to your new plugin name.

You'll need to install Lua and LuaRocks to run the linter.

Testing

This uses busted, luassert (both through plenary.nvim) and matcher_combinators to define tests in spec/ directory. These dependencies are required only to run tests, that´s why they are installed as git submodules. To run them just execute

$ make test

If you have entr(1) installed you may use it to run all tests whenever a file is changed using:

$ make watch

Github actions

An Action will run all the tests and the linter on every commit on the main branch and also on Pull Request.