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

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

Goose.nvim 是一个 Neovim 编辑器插件，它提供了与 Goose AI 代理的无缝集成，允许用户在不离开编辑器的情况下与强大的 AI 助手进行交互。项目的目录结构如下：

goose.nvim/
├── lua/               # Lua 脚本目录
│   ├── goose/          # Goose 插件的主要 Lua 模块
│   ├── plugin/        # Neovim 插件定义文件
│   ├── template/      # 模板文件目录
│   ├── tests/         # 测试文件目录
│   └── .gitignore     # Git 忽略文件
├── .gitignore         # Git 忽略文件
├── .luarc.json        # Lua 配置文件
├── LICENSE            # 项目许可证文件
├── README.md          # 项目说明文件
├── run_tests.sh       # 运行测试的脚本
└── ...

目录详细介绍：

• lua/: 包含所有 Lua 脚本和模块。
• lua/goose/: Goose 插件的核心逻辑所在。
• lua/plugin/: 定义了 Neovim 插件的接口和功能。
• lua/template/: 存放一些模板文件，可能用于生成特定的代码结构。
• lua/tests/: 包含了对插件功能的单元测试。
• .gitignore: 指定 Git 应该忽略的文件和目录。
• .luarc.json: Lua 配置文件，可能用于存储用户自定义的设置。
• LICENSE: 项目的开源许可证，本项目采用 Apache-2.0 许可证。
• README.md: 提供了项目的详细说明和安装指南。
• run_tests.sh: 脚本用于执行项目测试。

2. 项目的启动文件介绍

Goose.nvim 的启动主要是通过 Neovim 插件管理器来完成的。以下是一个使用 lazy.nvim 插件管理器安装 Goose.nvim 的示例：

{
  "azorng/goose.nvim",
  config = function()
    require("goose").setup({})
  end,
  dependencies = {
    "nvim-lua/plenary.nvim",
    {
      "MeanderingProgrammer/render-markdown.nvim",
      opts = {
        anti_conceal = { enabled = false },
      },
    },
  },
}

在这个配置中，require("goose").setup({}) 是启动 Goose.nvim 的关键代码。它会加载并配置 Goose 插件。

3. 项目的配置文件介绍

Goose.nvim 的配置主要通过 goose.setup() 函数来完成。你可以在你的 Neovim 配置文件（通常是 init.lua 或 init.vim）中调用这个函数来设置插件的行为。以下是一个配置文件的示例：

require("goose").setup({
  default_global_keymaps = true,
  keymap = {
    global = {
      toggle = '<leader>gg',
      open_input = '<leader>gi',
      open_input_new_session = '<leader>gI',
      open_output = '<leader>go',
      toggle_focus = '<leader>gt',
      close = '<leader>gq',
      toggle_fullscreen = '<leader>gf',
      select_session = '<leader>gs',
      configure_provider = '<leader>gp',
      diff_open = '<leader>gd',
      diff_next = '<leader>g]',
      diff_prev = '<leader>g[',
      diff_close = '<leader>gc',
      diff_revert_all = '<leader>gra',
      diff_revert_this = '<leader>grt',
    },
  },
  ui = {
    window_width = 0.35,
    input_height = 0.15,
    fullscreen = false,
    layout = "right",
    floating_height = 0.8,
    display_model = true,
    display_goose_mode = true,
  },
  providers = {
    -- 这里可以定义不同的提供商和模型
  },
})

在这个配置文件中，你可以设置默认的全局快捷键、自定义快捷键映射、UI 界面布局和提供商模型等。这些设置将影响 Goose.nvim 的行为和外观。