Question 1

How do I start a new plugin using nvim-plugin-template?

Accepted Answer

Use the GitHub CLI with 'gh repo create my-plugin -p ellisonleao/nvim-plugin-template' or click 'Use this template' on GitHub. This clones the template with all pre-configured files ready for customization, as described in the README.

Question 2

nvim-plugin-template vs kickstart.nvim for Neovim plugins?

Accepted Answer

nvim-plugin-template offers a full-featured, opinionated setup with testing and CI/CD, while kickstart.nvim is minimal and focused on configuration. Choose this template if you need built-in tools for quality assurance and publishing.

Question 3

Does nvim-plugin-template support Vimscript plugins?

Accepted Answer

No, it's specifically designed for 100% Lua plugins, as emphasized in the features. For Vimscript support, you'd need to modify the template or use an alternative.

Question 4

How do I customize tests in nvim-plugin-template?

Accepted Answer

Edit the test files in the 'tests' directory and adjust the GitHub Actions workflow if needed. The template uses plenary.nvim and busted, with a Makefile for running tests locally, as shown in the structure.

Question 5

What formatting tools are included in nvim-plugin-template?

Accepted Answer

It integrates Stylua for automatic Lua code formatting, with GitHub Actions checking for errors. This ensures consistent style without manual intervention.

Question 6

Is nvim-plugin-template good for beginners in Neovim development?

Accepted Answer

It assumes familiarity with Lua and Neovim's API, so it might have a learning curve for beginners. However, it can help learn best practices through its structured approach.

nvim-plugin-template

What is nvim-plugin-template?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions