Neovim Tasks 插件使用教程

Neovim Tasks 插件使用教程

neovim-tasks A statefull task manager focused on integration with build systems. 项目地址: https://gitcode.com/gh_mirrors/ne/neovim-tasks

1. 项目目录结构及介绍

Neovim Tasks 插件的目录结构如下：

neovim-tasks/
├── COPYING
├── README.md
├── lua/
│   └── tasks/
│       ├── init.lua
│       └── modules/
│           ├── cargo.lua
│           ├── cmake.lua
│           └── make.lua
├── plugin/
│   └── tasks.lua
└── stylua.toml

目录结构介绍

• COPYING: 包含项目的许可证信息，本项目使用 GPL-3.0 许可证。
• README.md: 项目的介绍文档，包含基本的使用说明和安装方法。
• lua/tasks/: 包含插件的核心逻辑和模块。
  • init.lua: 插件的入口文件，负责初始化和加载其他模块。
  • modules/: 包含不同构建系统的任务模块，如 cargo.lua, cmake.lua, make.lua 等。
• plugin/: 包含插件的加载文件 tasks.lua，负责在 Neovim 启动时加载插件。
• stylua.toml: 代码格式化工具 StyLua 的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 lua/tasks/init.lua。该文件负责初始化插件并加载其他模块。以下是 init.lua 的主要功能：

• 初始化插件: 加载插件的默认配置，并注册插件的命令。
• 加载模块: 根据配置加载不同的任务模块，如 cargo, cmake, make 等。
• 注册命令: 注册插件提供的命令，如 :Task start, :Task set_module_param 等。

3. 项目的配置文件介绍

Neovim Tasks 插件的配置文件通常在 lua/tasks/init.lua 中定义，并通过 require('tasks').setup(values) 进行配置。以下是默认配置的示例：

local Path = require('plenary.path')
require('tasks').setup({
  default_params = {
    cmake = {
      cmd = 'cmake',
      build_dir = tostring(Path:new('[cwd]', 'build', '[os]-[build_type]')),
      build_type = 'Debug',
      dap_name = 'lldb',
      args = {
        configure = { '-D', 'CMAKE_EXPORT_COMPILE_COMMANDS=1', '-G', 'Ninja' }
      }
    }
  },
  save_before_run = true,
  params_file = 'neovim.json',
  quickfix = {
    pos = 'botright',
    height = 12
  },
  dap_open_command = function() return require('dap').repl.open() end
})

配置项介绍

• default_params: 定义默认的模块参数，如 cmake 模块的 cmd, build_dir, build_type 等。
• save_before_run: 在执行任务前是否保存所有文件。
• params_file: 存储模块和任务参数的 JSON 文件路径。
• quickfix: 定义 Quickfix 窗口的位置和高度。
• dap_open_command: 在启动 DAP 调试会话后执行的命令。

通过这些配置项，用户可以根据自己的需求自定义插件的行为。

neovim-tasks A statefull task manager focused on integration with build systems. 项目地址: https://gitcode.com/gh_mirrors/ne/neovim-tasks