template.nvim

This is a template for Neovim plugins.

What it includes

Neovim plugin boilerplate.
plenary.nvim for testing.
- You can choose to use vusted or busted instead or along-side plenary.nvim.
Selene linter.
StyLua formatter.
EditorConfig support.
Codespell spell checker.
GitHub Actions for continuous integration.
Github Templating.

Actions

Actions for the aforementioned tools are included in the .github/workflows directory.

Templating

This repository is configured to use GitHub Templates. To modify them, go to .github/ISSUE_TEMPLATE and .github/PULL_REQUEST_TEMPLATE.

How to use

Create a new repository from this template.
Modify the README.md and plugin name in lua/your_plugin and whatever you feel is appropriate.
Use :Telescope live_grep to search for instances of your_plugin or plugin.nvim or your_github_user in the codebase to replace them with your own.
Start coding! 🫡