Pretty Fold.nvim 插件使用教程-优快云博客

Pretty Fold.nvim 插件使用教程

pretty-fold.nvim Foldtext customization in Neovim 项目地址: https://gitcode.com/gh_mirrors/pr/pretty-fold.nvim

1. 项目目录结构及介绍

pretty-fold.nvim/
├── lua/
│   └── pretty-fold/
│       ├── init.lua
│       ├── config.lua
│       ├── utils.lua
│       └── ...
├── LICENSE
├── README.md
└── ...

lua/: 包含插件的核心代码。
- pretty-fold/: 插件的主要功能实现。
  - init.lua: 插件的入口文件，负责初始化插件。
  - config.lua: 配置文件，定义了插件的默认配置和用户自定义配置。
  - utils.lua: 包含一些工具函数，用于辅助插件的功能实现。
LICENSE: 插件的许可证文件，通常为 Apache-2.0 许可证。
README.md: 项目的说明文档，包含插件的基本介绍、安装方法和使用说明。

2. 项目的启动文件介绍

`init.lua`

init.lua 是插件的入口文件，负责初始化插件并加载配置。以下是该文件的主要功能：

加载配置: 从 config.lua 中加载默认配置，并允许用户通过 setup 函数进行自定义配置。
注册事件: 注册 Neovim 事件，以便在特定事件发生时执行插件的功能。
初始化插件: 初始化插件的各个模块，确保插件在 Neovim 启动时正常工作。

3. 项目的配置文件介绍

`config.lua`

config.lua 文件定义了插件的默认配置，并提供了用户自定义配置的接口。以下是该文件的主要内容：

默认配置: 定义了插件的默认行为，包括折叠文本的显示方式、折叠标记的处理方式等。
用户自定义配置: 通过 setup 函数，用户可以覆盖默认配置，实现个性化设置。

示例配置

require('pretty-fold').setup({
  sections = {
    left = { 'content' },
    right = { 'number_of_folded_lines', ': ', 'percentage', ' ', function(config) return config.fill_char:rep(3) end }
  },
  fill_char = '•',
  remove_fold_markers = true,
  keep_indentation = true,
  process_comment_signs = 'spaces',
  comment_signs = {},
  stop_words = { '@brief%s*' },
  add_close_pattern = true,
  matchup_patterns = {
    { '[' , ']' },
    { '%(' , ')' },
    { '%[' , ']' }
  },
  ft_ignore = { 'neorg' }
})

sections: 定义折叠文本的显示内容，分为左右两部分。
fill_char: 用于填充折叠文本的字符。
remove_fold_markers: 是否移除折叠标记。
keep_indentation: 是否保持折叠内容的缩进。
process_comment_signs: 处理注释标记的方式。
comment_signs: 额外的注释标记。
stop_words: 需要从折叠内容中移除的关键词。
add_close_pattern: 是否添加关闭模式。
matchup_patterns: 匹配模式的列表。
ft_ignore: 忽略的文件类型。