Question 1

How do I set up testing for my Neovim plugin using plugin-template.nvim?

Accepted Answer

Clone the template, navigate to the test directory, and run `make prepare` to install dependencies. Then use `make test` to run all tests or `make watch` with entr installed for automatic testing on file changes.

Question 2

Does plugin-template.nvim support Neovim nightly builds?

Accepted Answer

Yes, the included GitHub Actions workflow runs tests on both stable and nightly versions of Neovim, ensuring your plugin is compatible with the latest developments.

Question 3

Can I use a different linter instead of the one provided?

Accepted Answer

The template is configured to use Lua and LuaRocks for linting. While you can modify it, the out-of-the-box setup is tightly integrated with these tools, so switching might require significant changes.

Question 4

How does plugin-template.nvim compare to other Neovim plugin templates like nvim-lua/template?

Accepted Answer

plugin-template.nvim focuses heavily on integrated testing and CI with Busted and GitHub Actions, while others might offer different structures or tooling. It's best for developers who prioritize testing from day one.

Question 5

Is this template suitable for Windows development?

Accepted Answer

The Makefile commands are standard, but may require adjustments for Windows. You might need to use alternatives like WSL or adapt the commands for your environment.

Question 6

How to add new modules or files to the project structure?

Accepted Answer

After cloning, edit the placeholder names and directories as per the README. The template provides a clear layout, so you can add files in the appropriate folders, such as `lua/` for Lua modules.

Question 7

What if I don't want to use GitHub Actions for CI?

Accepted Answer

The template is pre-configured for GitHub Actions, but you can remove or modify the `.github/workflows` directory to use other CI providers, though it requires manual setup.

plugin-template.nvim

What is plugin-template.nvim?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions