Kirby.nvim 项目启动与配置教程

1. 项目的目录结构及介绍

Kirby.nvim 是一个基于 Neovim 的模糊选择器插件，它使用 kitty 图形协议。项目的目录结构如下：

• assets/：包含项目的一些资源文件。
• lua/：存放 Lua 脚本文件，这些脚本负责插件的核心逻辑。
• plugin/：包含 Neovim 插件定义文件。
• src/：源代码目录，包含 TypeScript 文件。
• types/：类型定义文件，用于 TypeScript 的类型检查。
• LICENSE：项目许可证文件，采用 JSON 许可证（MIT 许可证 + 非恶意条款）。
• README.md：项目说明文件，介绍了项目的安装和使用方法。
• package.json：Node.js 项目配置文件。
• package.lua：Lua 语言的项目配置文件。
• pnpm-lock.yaml：pnpm 包管理器的锁文件。
• tsconfig.json：TypeScript 配置文件。

2. 项目的启动文件介绍

Kirby.nvim 的启动主要通过 Neovim 插件系统进行。用户需要确保已经安装了 Neovim，并且正确配置了插件管理器（例如 lazy.nvim）。在插件管理器的配置文件中，添加以下内容来启动 Kirby.nvim：

{
  'romgrk/kirby.nvim',
  dependencies = {
    'romgrk/fzy-lua-native',
    'romgrk/kui.nvim',
    'nvim-tree/nvim-web-devicons',
    'nvim-lua/plenary.nvim',
  },
}

启动后，可以通过 <C-p> 快捷键打开文件选择器，或者使用 :Kirby [picker-id] 命令来打开不同的选择器。

3. 项目的配置文件介绍

Kirby.nvim 的配置主要通过修改 lua/ 目录下的 Lua 文件进行。以下是一些基本的配置示例：

注册新的选择器

在 lua/ 目录下的某个配置文件中，你可以注册新的选择器：

local kirby = require('kirby')

kirby.register({
  id = 'git-branch',
  name = 'Git checkout',
  values = function()
    return vim.fn['fugitive#CompleteObject']('', '', '')
  end,
  onAccept = 'Git checkout',
})

修改快捷键

如果你需要修改默认的 <C-p> 快捷键，你可以在 Neovim 的配置文件中进行映射修改：

vim.keymap.set('n', '<C-p>', '<cmd>Kirby files<CR>', { noremap = true, silent = true })

这样就可以根据自己的习惯来调整快捷键。

以上就是 Kirby.nvim 的项目目录结构、启动文件和配置文件的介绍。正确理解和运用这些内容，可以帮助你更好地使用这个模糊选择器插件。