https://github.com/oxy2dev/foldtext.nvim
Dynamic & stylized foldtext for Neovim
https://github.com/oxy2dev/foldtext.nvim
Last synced: about 1 year ago
JSON representation
Dynamic & stylized foldtext for Neovim
- Host: GitHub
- URL: https://github.com/oxy2dev/foldtext.nvim
- Owner: OXY2DEV
- License: apache-2.0
- Created: 2024-07-13T11:07:07.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T16:34:16.000Z (about 1 year ago)
- Last Synced: 2025-05-09T00:06:37.353Z (about 1 year ago)
- Language: Lua
- Homepage:
- Size: 743 KB
- Stars: 86
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 📂 Foldtext.nvim
>[!NOTE]
> If you are coming from `v1`, you should see the [migration](#-migration) section.
>
> Also, You can always tag the plugin's version to `v1.0.0` from your package manager until you are ready to migrate.
*Fancy* foldtext for `Neovim`.
## ✨ Features
- Fast, ~1ms load time.
- Ability to use separate foldtext **per window**.
- Foldtext parts to make things easier with ability to toggle them on-demand.
- Automatically updates the used foldtext on `OptionSet`(only for `filetype`, `buftype`, `foldmethod` & `foldexpr`).
## 📦 Installation
`Foldtext.nvim` can be installed via your favourite package managers.
### 💤 Lazy.nvim
For `lazy.lua`/`plugins.lua` users.
```lua
{
"OXY2DEV/foldtext.nvim",
lazy = false
}
```
For `plugins/foldtext.lua` users.
```lua
return {
"OXY2DEV/foldtext.nvim",
lazy = false
}
```
### 🦠 Mini.deps
```lua
local MiniDeps = require("mini.deps");
MiniDeps.add({
source = "OXY2DEV/foldtext.nvim"
});
```
### 🌒 Rocks.nvim
You can install the plugin via `rocks.nvim` with the following command.
```vim
:Rocks install foldtext.nvim
```
## 🔩 Configuration
The plugin can be configured via the `setup()` command. The configuration table has the following structure,
>[!TIP]
> You can check out the [example styles](https://github.com/OXY2DEV/foldtext.nvim/blob/main/lua/foldtext/examples.lua) file to see how different parts are used.
```lua
require("foldtext").setup({
-- Ignore buffers with these buftypes.
ignore_buftypes = {},
-- Ignore buffers with these filetypes.
ignore_filetypes = {},
-- Ignore buffers/windows if the result
-- is false.
condition = function ()
return true;
end,
styles = {
default = {
{ kind = "bufline" }
},
-- Custom foldtext.
custom_a = {
-- Only on these filetypes.
filetypes = {},
-- Only on these buftypes.
buftypes = {},
-- Only if this condition is
-- true.
condition = function (win)
return vim.wo[win].foldmethod == "manual";
end,
-- Parts to create the foldtext.
parts = {
{ kind = "fold_size" }
}
}
}
});
```
You can find the default configuration table [here](https://github.com/OXY2DEV/foldtext.nvim/blob/main/lua/foldtext.lua#L8). A few custom foldtext are provided as examples. These are,
- `default`, Used for **conventional-commit** style messages(falls back to showing range if no description is found) in foldtext. See [here](https://github.com/OXY2DEV/foldtext.nvim/blob/dev/lua/foldtext.lua#L13).
- `ts_expr`, Used when tree-sitter expressions are used for folding. See [here](https://github.com/OXY2DEV/foldtext.nvim/blob/dev/lua/foldtext.lua#L44).
------
Description about each option is given below,
### ignore_buftypes
- Type: `string[]`
- Default: `{ "nofile" }`
Buffer types to ignore.
>[!NOTE]
> `nofile` buffers may use folds for various things, so we ignore them.
### ignore_filetypes
- Type: `string[]`
File types to ignore.
### condition
- Type: `fun(buffer: integer, window: integer): boolean`
Function to determine if a window should be attached to. Used for defining additional conditions.
### styles
- Type: `foldtext.styles`
Styles for different foldtexts.
#### default
- Type: `foldtext_part[]`
Parts for the default foldtext. See [parts](#-parts) for more info.
#### custom_a
- Type: `foldtext.custom_style`
Custom style for the foldtext. Here it's named `custom_a`.
##### filetypes
- Type: `string[]`
File types where this style should be enabled.
##### buftypes
- Type: `string[]`
Buffer types where this style should be enabled.
##### condition
- Type: `fun(buffer: integer, window: integer): boolean`
Addition conditions for this style.
##### parts
- Type: `foldtext_part[]`
Parts for this foldtext. See [parts](#-parts) for more info.
### 🔄 Migration
These are the option name changes for `v2.0.0`.
```diff
example.lua
{
- ft_ignore = {},
+ ignore_filetypes = {},
- bt_ignore = {},
+ ignore_buftypes = {},
- default = {},
- custom = {},
+ styles = {
+ default = {},
+ a = {}
+ }
}
```
Parts have also been changed. These are,
#### Deprecated: raw
Has been deprecated in favor of `section`.
```diff
raw.lua
{
- type = "raw",
+ kind = "section",
condition = function ()
return true;
end
- text = "abcd",
- hl = "Comment"
+ output = {
+ { "abcd", "Comment" },
+ }
}
```
#### Deprecated: fold_size
Has new options & option name changes,
```diff
fold_size.lua
{
+ condition = function ()
+ return true;
+ end
- type = "fold_size",
+ kind = "fold_size",
hl = "Special",
+ padding_left = nil,
+ padding_left_hl = nil,
+ padding_right = nil,
+ padding_right_hl = nil,
+ icon = nil,
+ icon_hl = nil,
}
```
#### Deprecated: indent
Has new option & option name change,
```diff
indent.lua
{
+ condition = function ()
+ return true;
+ end
- type = "indent",
+ kind = "indent",
hl = "Comment"
}
```
#### Deprecated: custom
Has been removed in favor of `section`,
```diff
custom.lua
{
+ condition = function ()
+ return true;
+ end
- type = "custom",
+ kind = "section",
- handler = function (window, buffer)
- return {
- { "text" }
- };
- end
+ output = function (buffer, window)
+ return {
+ { "text" }
+ };
+ end
}
```
## 🧩 Parts
Some built-in parts are provided in the plugin. These are,
### bufline
Shows the buffer line with tree-sitter syntax highlighting. Has the following options,
```lua
{
kind = "bufline",
-- Optional condition for this
-- part.
condition = function ()
return true;
end
-- Delimiter between the start/end line.
delimiter = "...",
-- Highlight group for `delimiter`.
hl = "@comment"
}
```
### description
Conventional commit styled fold description. Has the following options,
```lua
{
kind = "description",
-- Optional condition for this
-- part.
condition = function ()
return true;
end
-- Pattern to detect the foldtext from the start line.
-- Here I am using, "feat: Keymaps" & "fix, Something's not right here"
pattern = '[\'"](.+)[\'"]',
styles = {
default = {
hl = "@comment",
icon = "💭 ",
icon_hl = nil
},
-- Style for `doc`(case-insensitive).
-- Options are merged with `default`
-- before being used.
doc = {
-- hl, icon_hl are inherited from
-- `default`.
icon = "📚 ",
}
}
}
```
### section
A section of the foldtext. Has the following options,
```lua
{
kind = "section",
-- Optional condition for this
-- part.
condition = function ()
return true;
end
-- Text to show for this section. Has
-- the same structure as virtual text.
-- [ text, highlight_group ][]
output = {
{ "Hello, Neovim!", "Comment" }
},
-- Can also be a function!
output = function (buffer, window)
return {
{ "Buf: " .. buffer },
{ "Win: " .. window },
};
end
}
```
### fold_size
Shows the fold size. Has the following option,
```lua
{
kind = "fold_size",
-- Optional condition for this
-- part.
condition = function ()
return true;
end
-- Highlight group for the entire
-- part.
hl = "@comment",
icon = "←→ ",
icon_hl = nil,
padding_left = " ",
padding_left_hl = nil,
padding_right = " ",
padding_right_hl = nil,
}
```
### indent
Adds the fold's starting line's indentation. Has the following options,
```lua
{
kind = "indent",
-- Optional condition for this
-- part.
condition = function ()
return true;
end
hl = nil
}
```