mirror of
https://github.com/folke/snacks.nvim
synced 2025-08-04 18:58:12 +00:00
108 lines
3.6 KiB
Text
108 lines
3.6 KiB
Text
*snacks-lazygit.txt* For Neovim Last change: 2024 November 05
|
|
|
|
==============================================================================
|
|
Table of Contents *snacks-lazygit-table-of-contents*
|
|
|
|
1. Config |snacks-lazygit-config|
|
|
2. Types |snacks-lazygit-types|
|
|
3. Module |snacks-lazygit-module|
|
|
- Snacks.lazygit() |snacks-lazygit-module-snacks.lazygit()|
|
|
- Snacks.lazygit.log() |snacks-lazygit-module-snacks.lazygit.log()|
|
|
- Snacks.lazygit.log_file()|snacks-lazygit-module-snacks.lazygit.log_file()|
|
|
- Snacks.lazygit.open() |snacks-lazygit-module-snacks.lazygit.open()|
|
|
|
|
==============================================================================
|
|
1. Config *snacks-lazygit-config*
|
|
|
|
>lua
|
|
---@class snacks.lazygit.Config: snacks.terminal.Config
|
|
---@field args? string[]
|
|
---@field theme? snacks.lazygit.Theme
|
|
{
|
|
configure = true,
|
|
theme_path = vim.fs.normalize(vim.fn.stdpath("cache") .. "/lazygit-theme.yml"),
|
|
theme = {
|
|
[241] = { fg = "Special" },
|
|
activeBorderColor = { fg = "MatchParen", bold = true },
|
|
cherryPickedCommitBgColor = { fg = "Identifier" },
|
|
cherryPickedCommitFgColor = { fg = "Function" },
|
|
defaultFgColor = { fg = "Normal" },
|
|
inactiveBorderColor = { fg = "FloatBorder" },
|
|
optionsTextColor = { fg = "Function" },
|
|
searchingActiveBorderColor = { fg = "MatchParen", bold = true },
|
|
selectedLineBgColor = { bg = "Visual" }, -- set to `default` to have no background colour
|
|
unstagedChangesColor = { fg = "DiagnosticError" },
|
|
},
|
|
win = {
|
|
view = "lazygit",
|
|
},
|
|
}
|
|
<
|
|
|
|
|
|
==============================================================================
|
|
2. Types *snacks-lazygit-types*
|
|
|
|
>lua
|
|
---@alias snacks.lazygit.Color {fg?:string, bg?:string, bold?:boolean}
|
|
<
|
|
|
|
>lua
|
|
---@class snacks.lazygit.Theme: table<number, snacks.lazygit.Color>
|
|
---@field activeBorderColor snacks.lazygit.Color
|
|
---@field cherryPickedCommitBgColor snacks.lazygit.Color
|
|
---@field cherryPickedCommitFgColor snacks.lazygit.Color
|
|
---@field defaultFgColor snacks.lazygit.Color
|
|
---@field inactiveBorderColor snacks.lazygit.Color
|
|
---@field optionsTextColor snacks.lazygit.Color
|
|
---@field searchingActiveBorderColor snacks.lazygit.Color
|
|
---@field selectedLineBgColor snacks.lazygit.Color
|
|
---@field unstagedChangesColor snacks.lazygit.Color
|
|
<
|
|
|
|
|
|
==============================================================================
|
|
3. Module *snacks-lazygit-module*
|
|
|
|
>lua
|
|
---@class snacks.lazygit
|
|
Snacks.lazygit = {}
|
|
<
|
|
|
|
|
|
SNACKS.LAZYGIT() *snacks-lazygit-module-snacks.lazygit()*
|
|
|
|
>lua
|
|
---@type fun(opts?: snacks.lazygit.Config): snacks.win
|
|
Snacks.lazygit()
|
|
<
|
|
|
|
|
|
SNACKS.LAZYGIT.LOG() *snacks-lazygit-module-snacks.lazygit.log()*
|
|
|
|
>lua
|
|
---@param opts? snacks.lazygit.Config
|
|
Snacks.lazygit.log(opts)
|
|
<
|
|
|
|
|
|
SNACKS.LAZYGIT.LOG_FILE() *snacks-lazygit-module-snacks.lazygit.log_file()*
|
|
|
|
>lua
|
|
---@param opts? snacks.lazygit.Config
|
|
Snacks.lazygit.log_file(opts)
|
|
<
|
|
|
|
|
|
SNACKS.LAZYGIT.OPEN() *snacks-lazygit-module-snacks.lazygit.open()*
|
|
|
|
Opens lazygit
|
|
|
|
>lua
|
|
---@param opts? snacks.lazygit.Config
|
|
Snacks.lazygit.open(opts)
|
|
<
|
|
|
|
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
|
|
|
|
vim:tw=78:ts=8:noet:ft=help:norl:
|