nvim-magic 项目教程

nvim-magic 项目教程

nvim-magic:genie: Pluggable framework for using AI code assistance in Neovim项目地址:https://gitcode.com/gh_mirrors/nv/nvim-magic

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

nvim-magic/
├── devcontainer/
├── docs/
├── lua/
│   ├── nvim-magic/
│   │   ├── prompts/
│   │   └── ...
│   └── ...
├── .editorconfig
├── .gitignore
├── .luacheckrc
├── .styluaignore
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE.txt
├── README.md
├── stylua.toml
└── ...

• devcontainer/: 包含开发容器的配置文件。
• docs/: 包含项目的文档文件。
• lua/: 包含项目的 Lua 脚本文件。
  • nvim-magic/: 核心插件目录。
    • prompts/: 包含用于生成提示的文件。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件。
• .luacheckrc: Lua 代码检查配置文件。
• .styluaignore: StyLua 忽略文件。
• CHANGELOG.md: 项目变更日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE.txt: 项目许可证。
• README.md: 项目介绍和使用说明。
• stylua.toml: StyLua 配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 lua/nvim-magic/init.lua，该文件负责初始化插件并加载必要的模块。

-- lua/nvim-magic/init.lua
require('nvim-magic').setup()

3. 项目的配置文件介绍

项目的配置文件主要是 stylua.toml 和 lua/nvim-magic/config.lua。

• stylua.toml: 用于配置 StyLua 代码格式化工具。
• lua/nvim-magic/config.lua: 包含插件的默认配置和用户自定义配置。

-- lua/nvim-magic/config.lua
local config = {
  -- 默认配置
  default = {
    -- 配置项
  },
  -- 用户自定义配置
  user = {
    -- 用户配置项
  }
}

return config

通过修改 lua/nvim-magic/config.lua 文件中的 user 部分，可以自定义插件的行为。

nvim-magic:genie: Pluggable framework for using AI code assistance in Neovim项目地址:https://gitcode.com/gh_mirrors/nv/nvim-magic