mrcjkb/nvim-lua-nix-plugin-template

A starter template for a Neovim plugin written in Lua with a Nix CI

An opinionated Neovim Lua plugin template with a Nix CI

This repository is a template for Neovim plugins written in Lua.

Features

• GitHub Actions workflows with a locally reproducible CI, using nix flakes.
• Run tests with both neovim stable and neovim nightly using neorocksTest.
• Lints and a nix shell with pre-commit-hooks:
  • luacheck
  • stylua
  • lua-language-server static type checks
  • alejandra
  • editorconfig-checker
  • markdownlint
• vimPlugin nix flake output.
• Automatically publish tags to LuaRocks with the luarocks-tag-release action.
• Automatic release PRs using conventional commits with release-please.
• Automatically comment PRs with a review checklist.

Setup

1. Click on Use this template to start a repo based on this template. Do not fork it.
2. If your plugin depends on other plugins, add them to nvim-wrapped in the ci-overlay.nix.
3. Add the name of your plugin to flake.nix.
4. Add busted specs to the tests directory.
5. Create a LuaRocks API key.
6. Add the API key to the repository's GitHub Actions secrets.
7. Text that needs to be updated is marked with TODO: comments.
8. Rename plugin-template.nvim-scm-1.rockspec.
9. Delete the content of CHANGELOG.md.

Contributing

All contributions are welcome! See CONTRIBUTING.md.

License

This template is licensed according to GPL version 2, with the following exception:

The license applies only to the Nix CI infrastructure provided by this template repository, including any modifications made to the infrastructure. Any software that uses or is derived from this template may be licensed under any OSI approved open source license, without being subject to the GPL version 2 license of this template.