https://github.com/ellisonleao/nvim-plugin-template

A neovim plugin template for github repos
https://github.com/ellisonleao/nvim-plugin-template

busted github lua neovim neovim-plugin nvim plenary plugin template templates

Last synced: 29 days ago
JSON representation

A neovim plugin template for github repos

• Host: GitHub
• URL: https://github.com/ellisonleao/nvim-plugin-template
• Owner: ellisonleao
• License: mit
• Created: 2022-02-14T20:15:54.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-01-18T17:12:18.000Z (11 months ago)
• Last Synced: 2024-11-07T04:11:57.595Z (about 1 month ago)
• Topics: busted, github, lua, neovim, neovim-plugin, nvim, plenary, plugin, template, templates
• Language: Lua
• Homepage:
• Size: 29.3 KB
• Stars: 283
• Watchers: 4
• Forks: 23
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - ellisonleao/nvim-plugin-template - Another neovim plugin template, using GitHub's template feature. (External / Boilerplate)

README

        
# A Neovim Plugin Template

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ellisonleao/nvim-plugin-template/lint-test.yml?branch=main&style=for-the-badge)

![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=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`

![](https://docs.github.com/assets/cb-36544/images/help/repository/use-this-template-button.png)

## Features and structure

- 100% Lua

- Github actions for:

  - running tests using [plenary.nvim](https://github.com/nvim-lua/plenary.nvim) and [busted](https://olivinelabs.com/busted/)

  - check for formatting errors (Stylua)

  - vimdocs autogeneration from README.md file

  - luarocks release (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

```