Sunglasses.nvim 项目教程

Sunglasses.nvim 项目教程

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

Sunglasses.nvim 项目的目录结构如下：

sunglasses.nvim/
├── doc/
│   └── sunglasses.txt
├── lua/
│   └── sunglasses/
│       ├── init.lua
│       └── config.lua
├── LICENSE
├── README.md
└── .gitignore

• doc/: 包含项目的文档文件，如 sunglasses.txt。
• lua/: 包含项目的 Lua 脚本文件，其中 init.lua 是项目的入口文件，config.lua 是配置文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• .gitignore: Git 忽略文件配置。

2. 项目的启动文件介绍

项目的启动文件是 lua/sunglasses/init.lua。该文件负责初始化插件并加载必要的配置。以下是启动文件的主要内容：

-- 初始化 Sunglasses.nvim 插件
require('sunglasses').setup()

3. 项目的配置文件介绍

项目的配置文件是 lua/sunglasses/config.lua。该文件包含了插件的默认配置和用户自定义配置的接口。以下是配置文件的主要内容：

-- 默认配置
local default_config = {
    filter_type = "NOSYNTAX",
    filter_percent = 65,
}

-- 用户自定义配置接口
local function setup(user_config)
    local config = vim.tbl_extend("force", default_config, user_config or {})
    -- 应用配置
    -- ...
end

return {
    setup = setup,
}

用户可以通过调用 setup 函数来覆盖默认配置：

require('sunglasses').setup({
    filter_type = "SHADE",
    filter_percent = 50,
})

以上是 Sunglasses.nvim 项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用该插件。