nvim-lua-toolchain

Category: Tools & Productivity | Uploader: HanakumaChifuyu | Downloads: 0 | Version: v1.0（Latest）

Set up or update local development and test toolchains for Lua projects, especially Neovim Lua plugin development. Use when Claude needs to scaffold or standardize plenary.nvim tests, luacov coverage, headless Neovim test workflows, stylua formatting, luacheck linting, lefthook git hooks, or AI code review for a Lua or Neovim plugin repository.

Changelog: Source: GitHub https://github.com/HanakumaChifuyu/nvim-lua-toolchain

Directory Structure

Current level: Root

📁 doc/
- 📄 README.zh-CN.md 5.0 KB
📁 references/
- 📄 nvim-lua-tooling.md 4.9 KB
📁 scripts/
- 📄 install-tools.sh 7.5 KB
📁 template_plugin/
- 📁 lua/
  - 📁 my_namespace/
    
    📄 tools.lua 1.0 KB
- 📁 plugin/
  - 📄 my_namespace.lua 686 B
- 📁 scripts/
  - 📄 code-review.sh 5.4 KB
- 📁 tests/
  - 📁 .rocks/
    
    📁 bin/
    
    📄 luacov 655 B
    
    📁 share/
    
    📁 lua/
    
    📁 5.1/
    
    📁 datafile/
    
    📁 openers/
    
    📄 caller.lua 1.1 KB
    
    📄 luarocks.lua 3.3 KB
    
    📄 unix.lua 1.5 KB
    
    📄 xdg.lua 1.4 KB
    
    📄 util.lua 1.5 KB
    
    📁 luacov/
    
    📁 reporter/
    
    📁 html/
    
    📄 template.lua 2.7 KB
    
    📄 default.lua 32 B
    
    📄 html.lua 6.9 KB
    
    📄 defaults.lua 2.8 KB
    
    📄 hook.lua 2.1 KB
    
    📄 linescanner.lua 10.9 KB
    
    📄 reporter.lua 13.6 KB
    
    📄 runner.lua 21.5 KB
    
    📄 stats.lua 2.0 KB
    
    📄 tick.lua 323 B
    
    📄 util.lua 2.3 KB
    
    📄 datafile.lua 1.9 KB
    
    📄 luacov.lua 281 B
  - 📄 minimal_init.lua 4.9 KB
  - 📄 tools_spec.lua 1.6 KB
- 📄 .luacheckrc 901 B
- 📄 .luacov 444 B
- 📄 justfile 2.5 KB
- 📄 lefthook.yml 723 B
- 📄 stylua.toml 142 B
📄 .gitignore 5.7 KB
📄 install.sh 2.8 KB
📄 LICENSE 1.0 KB
📄 README.md 5.4 KB
📄 SKILL.md 3.9 KB

SKILL.md

---
name: nvim-lua-toolchain
description: Set up or update local development and test toolchains for Lua projects, especially Neovim Lua plugin development. Use when Claude needs to scaffold or standardize plenary.nvim tests, luacov coverage, headless Neovim test workflows, stylua formatting, luacheck linting, lefthook git hooks, or AI code review for a Lua or Neovim plugin repository.
---

# Nvim Lua Toolchain

Use this skill to scaffold a test-focused, quality-gated development environment for Neovim Lua plugins. The default stack is `plenary.nvim` + `luacov` + `stylua` + `luacheck` + `lefthook`.

## Installing this skill

```bash
bash path/to/nvim-lua-toolchain/install.sh
```

This copies the skill into `~/.claude/skills/nvim-lua-toolchain/`. The install location can be overridden with `CLAUDE_SKILLS_DIR`.

## Setting up a plugin repo

Run the following from the root of the target plugin repository:

```bash
bash ~/.claude/skills/nvim-lua-toolchain/scripts/install-tools.sh
```

This will:
- Copy `tests/minimal_init.lua`, `.luacov`, `.luacheckrc`, `justfile`, `stylua.toml`, `lefthook.yml`, `scripts/code-review.sh` into the repo (skips existing files)
- Install `stylua` (via cargo or GitHub binary)
- Check for `luacheck` and print install instructions if missing
- Install `luacov` into `tests/.rocks/`
- Run `lefthook install` if lefthook is available and the directory is a git repo

## Workflow

1. Identify the repository type.
   - Neovim Lua plugin → `plenary.nvim` headless tests + `luacov` (default)
   - Pure Lua library → `busted` + `luacov`
   - Mixed plugin needing fuller Busted features → `vusted` or `busted` via `nvim -l`

2. Read `references/nvim-lua-tooling.md` before selecting tools or writing config.

3. Prefer the repository's existing conventions if tools are already wired into CI.

4. Add toolchain in order: test runner → coverage → formatter/linter → git hooks.

## Available just recipes

| Recipe | Description |
|---|---|
| `just` | Run all pre-commit checks via lefthook (default) |
| `just test` | Run all specs with plenary (multi-process) |
| `just test <file...>` | Run specific spec files |
| `just coverage` | Run all specs (single-process) + generate luacov report |
| `just check-coverage` | Coverage + fail if below threshold (default 80%) |
| `just fmt` | Format Lua files with stylua |
| `just fmt-check` | Check formatting without modifying |
| `just lint` | Lint with luacheck |

Change the coverage threshold: edit `min_coverage` at the top of `justfile`.

## Git hooks (lefthook)

| Hook | Commands |
|---|---|
| `pre-commit` | `fmt` (stylua) → `lint` (luacheck) → `coverage` (check-coverage) |
| `pre-push` | `code-review` (AI review via `claude --print`) |

Skip hooks: `LEFTHOOK=0 git commit` / `LEFTHOOK_EXCLUDE=coverage git commit`

## Key implementation details

- `tests/minimal_init.lua` is loaded via `-u` in every headless nvim invocation. It finds plenary in 13+ common locations (lazy/packer/vim-plug/dein/rocks/mason/system).
- Coverage uses `plenary.busted.run()` (single-process) instead of `test_harness` (multi-process) so luacov's debug hook sees all executed lines.
- `jit.off()` must be called **before** `require("luacov")` — LuaJIT's JIT compilation bypasses `debug.sethook` line hooks.
- luacov `exclude_files` patterns are Lua patterns (not globs); `.rocks` paths require `.*%.rocks/.*`.

## Default recommendations

- Test runner: `plenary.nvim`
- Coverage: `luacov`
- Formatter: `stylua`
- Linter: `luacheck` with `globals = {"vim"}` to suppress false positives on vim API
- Git hooks: `lefthook`
- AI review: `claude --print` on pre-push
- Editor: `lua_ls` + `lazydev.nvim`

## Resources

- `references/nvim-lua-tooling.md` — tooling research and decision guide
- `template_plugin/` — complete runnable example (tools.lua + spec + justfile)
- `scripts/install-tools.sh` — sets up a target repo from the template
- `install.sh` — installs this skill into `~/.claude/skills/`

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

nvim-lua-toolchain

Directory Structure

SKILL.md

Report

Notice