https://github.com/beixiyo/vv-task-panel.nvim
Extensible task panel (npm scripts in monorepos, etc). 可扩展任务面板（支持 monorepo npm scripts 等）
https://github.com/beixiyo/vv-task-panel.nvim
lua neovim neovim-plugin npm nvim nvim-plugin task-runner tasks
Last synced: 17 days ago
JSON representation
Extensible task panel (npm scripts in monorepos, etc). 可扩展任务面板（支持 monorepo npm scripts 等）
- Host: GitHub
- URL: https://github.com/beixiyo/vv-task-panel.nvim
- Owner: beixiyo
- License: mit
- Created: 2026-04-25T07:06:20.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-31T15:27:00.000Z (27 days ago)
- Last Synced: 2026-05-31T17:16:08.949Z (26 days ago)
- Topics: lua, neovim, neovim-plugin, npm, nvim, nvim-plugin, task-runner, tasks
- Language: Lua
- Size: 39.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
vv-task-panel.nvim
可扩展的任务面板 — 自动发现项目脚本、终端运行、monorepo 支持
---
## 安装
```lua
{
'beixiyo/vv-task-panel.nvim',
dependencies = {
'beixiyo/vv-utils.nvim',
{ 'beixiyo/vv-statuscol.nvim', optional = true }, -- 鼠标点击 sign 运行任务需要此插件
},
cmd = { 'VVTaskPanel', 'VVTaskPanelOpen' },
---@type VVTaskPanelConfig
opts = {
width = 44, -- 面板宽度
position = 'right', -- 'left' | 'right'
exclude_dirs = { -- 扫描时跳过的目录
'node_modules', '.git', 'dist', 'build', '.next',
'.turbo', '.cache', 'coverage', '.nuxt', 'out',
},
scan_strategy = 'workspace', -- 'workspace'（读 workspace 定义）| 'walk'（递归遍历）
max_depth = 8, -- walk 策略的最大递归深度
term_position = 'bottom', -- 任务终端位置：'bottom' | 'right' | 'float'
term_height = 15, -- bottom 模式下终端高度
term_width = 80, -- right 模式下终端宽度
providers = nil, -- Provider 白名单（nil = 启用所有已注册的）
icons = {
pkg_open = '',
pkg_closed = '',
package = '',
running = '●',
success = '',
failed = '',
stopped = '●',
pending = '',
header = '',
arrow = '→',
run = '', -- statuscolumn idle 状态图标
},
sign = { -- statuscolumn 脚本行标记（按状态配置）
idle = { hl = 'VVTaskSignIdle' },
running = { hl = 'VVTaskSignRunning' },
success = { hl = 'VVTaskSignSuccess' },
failed = { hl = 'VVTaskSignFailed' },
stopped = { hl = 'VVTaskSignStopped' },
},
},
}
```
## 配置
| 选项 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `width` | `integer` | `44` | 面板宽度 |
| `position` | `'left' \| 'right'` | `'right'` | 面板位置 |
| `exclude_dirs` | `string[]` | `{ 'node_modules', '.git', ... }` | 扫描时跳过的目录 |
| `scan_strategy` | `'workspace' \| 'walk'` | `'workspace'` | `workspace`：读 `pnpm-workspace.yaml` / `package.json` workspaces；`walk`：递归遍历 |
| `max_depth` | `integer` | `8` | `walk` 策略最大递归深度 |
| `term_position` | `'bottom' \| 'right' \| 'float'` | `'bottom'` | 任务终端窗口位置 |
| `term_height` | `integer` | `15` | `bottom` 模式下终端高度 |
| `term_width` | `integer` | `80` | `right` 模式下终端宽度 |
| `providers` | `string[]?` | `nil` | Provider 白名单；`nil` 启用所有已注册 |
| `icons` | `table` | *见上方* | 图标配置，可逐项覆盖 |
| `sign` | `table` | *见上方* | Statuscolumn 标记按状态配置 icon / hl |
## Statuscolumn Signs
打开 `package.json` / `deno.json` 时，脚本行的 statuscolumn 自动显示可运行标记，标记随任务状态实时变化：
| 状态 | 图标 | 颜色 | 说明 |
|------|------|------|------|
| idle | `icons.run` | 蓝 (`DiagnosticInfo`) | 未运行，可点击执行 |
| running | `icons.running` | 绿 (`DiagnosticOk`) | 运行中，点击聚焦终端 |
| success | `icons.success` | 绿 (`DiagnosticOk`) | 运行成功 |
| failed | `icons.failed` | 红 (`DiagnosticError`) | 运行失败 |
| stopped | `icons.stopped` | 红 (`DiagnosticError`) | 手动终止 |
**运行方式**：
- 鼠标点击 gutter 区域的标记图标（需安装 [vv-statuscol.nvim](https://github.com/beixiyo/vv-statuscol.nvim)，未安装时点击无效）
- 光标移到脚本行，按 `gx` 或执行 `:VVTaskPanelRunLine`
**覆盖单个状态的图标 / 高亮**：
```lua
opts = {
sign = {
running = { icon = '⟳', hl = 'MyCustomRunning' },
},
}
```
未设置 `icon` 的状态自动复用 `icons` 表同名项。
### 自定义 Sign Parser
为新文件类型注册脚本行解析器，即可在 statuscolumn 显示运行标记：
```lua
require('vv-task-panel').register_sign_parser('Cargo.toml', function(buf)
local lines = vim.api.nvim_buf_get_lines(buf, 0, -1, false)
local dir = vim.fn.fnamemodify(vim.api.nvim_buf_get_name(buf), ':h')
local result = {}
for i, line in ipairs(lines) do
local name = line:match('^name%s*=%s*"([^"]+)"')
if name then
result[#result + 1] = {
lnum = i,
name = name,
argv = { 'cargo', 'run', '--bin', name },
cwd = dir,
badge = 'cargo',
}
end
end
return result
end)
```
---
### 内置 npm Provider
自动扫描 `package.json`，按 lockfile 选择包管理器（pnpm / bun / yarn / npm）。`workspace` 策略读取 `pnpm-workspace.yaml` 或 `package.json` 的 `workspaces` 字段展开子包。
### 自定义 Provider
```lua
require('vv-task-panel').register_provider({
name = 'deno',
detect = function(root, cfg)
return vim.fs.find('deno.json', { path = root, type = 'file', limit = math.huge })
end,
parse = function(path, cfg)
local ok, data = pcall(vim.json.decode, table.concat(vim.fn.readfile(path), '\n'))
if not ok or type(data.tasks) ~= 'table' then return nil end
local dir = vim.fn.fnamemodify(path, ':h')
local tasks = {}
for name, cmd in pairs(data.tasks) do
tasks[#tasks + 1] = { name = name, argv = { 'deno', 'task', name }, cmd = cmd }
end
return {
id = path, name = data.name or vim.fn.fnamemodify(dir, ':.'),
dir = dir, rel_dir = vim.fn.fnamemodify(dir, ':.'),
badge = 'deno', tasks = tasks,
}
end,
})
```