Minuet-ai.nvim 项目教程

Minuet-ai.nvim 项目教程

minuet-ai.nvim 💃 Dance with Intelligence in Your Code. Minuet offers code completion as-you-type from popular LLMs including OpenAI, Gemini, Claude, Ollama, Codestral, and more. 项目地址: https://gitcode.com/gh_mirrors/mi/minuet-ai.nvim

1. 项目目录结构及介绍

Minuet-ai.nvim 是一个 Neovim 插件，提供了基于人工智能的代码补全功能。项目的目录结构如下：

• .github/: 存放 GitHub 工作流文件，用于自动化测试、构建等流程。
• lua/minuet/: 包含 Minuet 插件的核心代码。
• assets/: 存放与插件相关的静态资源。
• .editorconfig: 用于定义代码风格配置，确保不同编辑器之间的风格一致性。
• .gitignore: 用于指定 Git 忽略的文件和目录。
• CHANGELOG.md: 记录了插件的更新历史和版本变更。
• LICENSE: 插件的许可证信息，本项目采用 GPL-3.0 许可。
• README.md: 插件的说明文档，包含了项目的介绍、安装和使用方法。
• prompt.md: 提供了代码补全提示的示例和说明。
• recipes.md: 包含了一些使用 Minuet 插件的示例配方。

2. 项目的启动文件介绍

项目的启动主要是通过 Neovim 插件管理器（如 Lazy.nvim 或 Rocks.nvim）来完成的。以下是一个简单的启动文件示例，使用 Lazy.nvim 作为插件管理器：

-- 初始化 Lazy.nvim
local lazy = require 'lazy'

-- 安装 Minuet-ai.nvim
lazy.spec = {
  {
    'milanglacier/minuet-ai.nvim',
    config = function()
      require('minuet').setup({
        -- 这里可以添加你的配置选项
      })
    end,
  },
  'nvim-lua/plenary.nvim', -- Minuet 的依赖
  -- 根据需要选择以下依赖
  {
    'hrsh7th/nvim-cmp',
    config = function()
      require('cmp').setup({
        sources = {
          { name = 'minuet' },
          -- 其他数据源配置
        }
      })
    end,
  },
  {
    'Saghen/blink.cmp',
    config = function()
      require('blink-cmp').setup({
        -- 配置选项
      })
    end,
  },
}

-- 执行安装
lazy.setup()

3. 项目的配置文件介绍

Minuet-ai.nvim 的配置主要是通过 require('minuet').setup() 函数来完成的。以下是一个配置文件的示例：

require('minuet').setup({
  virtualtext = {
    auto_trigger_ft = {},
    keymap = {
      accept = '<A-A>',
      accept_line = '<A-a>',
      accept_n_lines = '<A-z>',
      prev = '<A-[>',
      next = '<A-]>',
      dismiss = '<A-e>',
    },
  },
  lsp = {
    enabled_ft = {
      'toml',
      'lua',
      'cpp',
    },
    enabled_auto_trigger_ft = {
      'cpp',
      'lua',
    },
  },
  -- 其他配置项
})

在这个配置文件中，你可以自定义各种快捷键、启用或禁用某些功能，以及配置 LSP 相关的设置。具体的配置选项和详细说明可以在项目的 README.md 文件中找到。

minuet-ai.nvim 💃 Dance with Intelligence in Your Code. Minuet offers code completion as-you-type from popular LLMs including OpenAI, Gemini, Claude, Ollama, Codestral, and more. 项目地址: https://gitcode.com/gh_mirrors/mi/minuet-ai.nvim