Skip to content

ellisonleao/nvim-plugin-template

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
lua
 
 
 
 
 
 
 
 
 
 
 
 
 
 

A Neovim Plugin Template

GitHub Workflow Status Lua

A template repository for Neovim plugins.

Using it

Via gh:

$ gh repo create my-plugin -p ellisonleao/nvim-plugin-template

Via github web page:

Click on Use this template

Features and structure

  • 100% Lua
  • Github actions to run tests and check for formatting errors (Stylua)
  • Tests created with busted + plenary.nvim
  • luarocks release support (LUAROCKS_API_KEY secret configuration required)

Plugin structure

.
├── lua
│   ├── plugin_name
│   │   └── module.lua
│   └── plugin_name.lua
├── Makefile
├── plugin
│   └── plugin_name.lua
├── README.md
├── tests
│   ├── minimal_init.lua
│   └── plugin_name
│       └── plugin_name_spec.lua