Satellite.nvim 项目教程
satellite.nvimDecorate scrollbar for Neovim项目地址:https://gitcode.com/gh_mirrors/sa/satellite.nvim
1. 项目的目录结构及介绍
satellite.nvim/
├── lua/
│ ├── satellite/
│ │ ├── init.lua
│ │ ├── config.lua
│ │ ├── handlers/
│ │ │ ├── cursor.lua
│ │ │ ├── search.lua
│ │ │ ├── diagnostic.lua
│ │ │ ├── gitsigns.lua
│ │ │ ├── marks.lua
│ │ │ └── quickfix.lua
│ │ └── utils.lua
├── README.md
├── LICENSE
lua/satellite/init.lua
: 项目的入口文件,负责初始化和加载配置。lua/satellite/config.lua
: 配置文件,包含默认配置和用户自定义配置的加载。lua/satellite/handlers/
: 处理各种滚动条事件的模块,如光标、搜索、诊断等。lua/satellite/utils.lua
: 工具函数,提供一些通用的辅助功能。README.md
: 项目说明文档。LICENSE
: 项目许可证。
2. 项目的启动文件介绍
lua/satellite/init.lua
是项目的启动文件,负责初始化和加载配置。以下是该文件的主要内容:
require('satellite').setup({
current_only = false,
winblend = 50,
zindex = 40,
excluded_filetypes = {},
width = 2,
handlers = {
cursor = {
enable = true,
symbols = { '⎺', '⎻', '⎼', '⎽' }
},
search = {
enable = true
},
diagnostic = {
enable = true,
signs = { '-', '=', '≡' },
min_severity = vim.diagnostic.severity.HINT
},
gitsigns = {
enable = true,
signs = { add = "│", change = "│", delete = "-" }
},
marks = {
enable = true,
show_builtins = false,
key = 'm'
},
quickfix = {
signs = { '-', '=', '≡' }
}
}
})
3. 项目的配置文件介绍
lua/satellite/config.lua
是项目的配置文件,包含默认配置和用户自定义配置的加载。以下是该文件的主要内容:
local default_config = {
current_only = false,
winblend = 50,
zindex = 40,
excluded_filetypes = {},
width = 2,
handlers = {
cursor = {
enable = true,
symbols = { '⎺', '⎻', '⎼', '⎽' }
},
search = {
enable = true
},
diagnostic = {
enable = true,
signs = { '-', '=', '≡' },
min_severity = vim.diagnostic.severity.HINT
},
gitsigns = {
enable = true,
signs = { add = "│", change = "│", delete = "-" }
},
marks = {
enable = true,
show_builtins = false,
key = 'm'
},
quickfix = {
signs = { '-', '=', '≡' }
}
}
}
local function load_config()
local user_config = require('satellite').setup
return vim.tbl_deep_extend('force', default_config, user_config)
end
return {
load_config = load_config
}
用户可以通过 require('satellite').setup
函数来覆盖默认配置,实现自定义配置。
satellite.nvimDecorate scrollbar for Neovim项目地址:https://gitcode.com/gh_mirrors/sa/satellite.nvim