Repository files navigation

This repository is a template for Neovim plugins written in Lua.

The intention is that you use this template to create a new repository where you then adapt this readme and add your plugin code.The template includes the following:

• GitHub workflows and configurations to run linters and tests
• Packaging of tagged releases and upload toLuaRocksif aLUAROCKS_API_KEY is addedto theGitHub Actions secrets
• Minimal test setup:
  • Ascmrockspec,nvim-lua-plugin-scm-1.rockspec
  • A.busted file
• EditorConfig
• A .luacheckrc

To get started writing a Lua plugin, I recommend reading:help lua-guide and:help write-plugin.

Anything that the majority of plugin authors will want to have is in scope ofthis starter template. Anything that is controversial is out-of-scope.

• ClickUse this template. Do not fork.
• Renamenvim-lua-plugin-scm-1.rockspec and change thepackage nameto the name of your plugin.

The template itself is licensed under theMIT license.The template doesn't include a LICENSE file. You should add one after creating your repository.

The remainder of the README is text that can be preserved in your plugin:

Running tests requires either

• luarocks
• orbusted andnlua

to be installed¹.

You can then run:

luarockstest --local# orbusted

Or if you want to run a single test file:

luarockstest spec/path_to_file.lua --local# orbusted spec/path_to_file.lua

If you see an error likemodule 'busted.runner' not found:

eval$(luarocks path --no-bin)

For this to work you need to have Lua 5.1 set as your default version forluarocks. If that's not the case you can pass--lua-version 5.1 to all theluarocks commands above.